Перейти к содержимому

Поддерживаемые события

Здесь перечислены все события, генерируемые Optimus, которые можно перехватить аддонами:

  • AddonInterface::HOOK_EVENT: универсальное событие для работы с хуками SMF
  • AddonInterface::ROBOTS_RULES: событие для работы с генератором правил robots.txt
  • AddonInterface::SITEMAP_LINKS: событие для добавления своих ссылок в xml-карту
  • AddonInterface::SITEMAP_CONTENT: специальное событие для обработки контента xml-карты сразу после формирования её структуры
  • AddonInterface::SITEMAP_URL_REWRITER: событие для регистрации переписчика URL, применяемого к каждой ссылке xml-карты
  • AddonInterface::CREATE_SEF_URLS: устаревшее событие для обработки ссылок в xml-карте до формирования её структуры

Для реализации связи с выбранным событием в классе аддона нужно заполнить поле $events и создать метод __invoke. На примере аддона LightPortal это выглядит так:

public static array $events = [
self::ROBOTS_RULES,
self::SITEMAP_LINKS,
];
public function __invoke(AddonEvent $event): void
{
match ($event->eventName()) {
self::ROBOTS_RULES => $this->changeRobots($event->getTarget()),
self::SITEMAP_LINKS => $this->changeSitemap($event->getTarget()),
};
}

Затем мы создаем соответствующие методы changeRobots и changeSitemap (названия вы регулируете сами):

public function changeRobots(RobotsGenerator $generator): void
{
var_dump($generator);
}
public function changeSitemap(SitemapGenerator $generator): void
{
var_dump($generator);
}

Как видите, в качестве объекта события self::ROBOTS_RULES передается класс RobotsGenerator для работы с генератором robots.txt.

Соответственно, в качестве объекта события self::SITEMAP_LINKS передается класс SitemapGenerator для работы с генератором xml-карты.

А событие self::SITEMAP_URL_REWRITER позволяет зарегистрировать переписчик для каждой ссылки карты (так работает аддон SimpleSEF):

public function registerUrlRewriter(SitemapGenerator $generator): void
{
$generator->addUrlRewriter(fn(string $url): string => myRewriteFunction($url));
}

А дальше уже всё зависит от полёта вашей фантазии и конкретных целей. Примеры реализаций встроенных аддонов можно увидеть на GitHub.

Если событий вам мало или они вас пугают, в качестве альтернативы можно использовать встроенные хуки Optimus.