Events

// src/EventListener/BackendMenuBuildListener.php
namespace App\EventListener;

use Contao\CoreBundle\Event\ContaoCoreEvents;
use Contao\CoreBundle\Event\MenuEvent;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;

#[AsEventListener(ContaoCoreEvents::BACKEND_MENU_BUILD)]
class BackendMenuBuildListener
{
    public function __invoke(MenuEvent $event): void
    {
        $factory = $event->getFactory();
        $tree = $event->getTree();

        if ('mainMenu' !== $tree->getName()) {
            return;
        }

        $contentNode = $tree->getChild('content');

        $node = $factory
            ->createItem('my-module')
                ->setUri(/* … */)
                ->setLabel('My Modules')
                ->setLinkAttribute('title', 'Title')
                ->setLinkAttribute('class', 'my-module')
                ->setCurrent(/* … */)
        ;

        $contentNode->addChild($node);
    }
}

// src/EventListener/GenerateSymlinksListener.php
namespace App\EventListener;

use Contao\CoreBundle\Event\ContaoCoreEvents;
use Contao\CoreBundle\Event\GenerateSymlinksEvent;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;

#[AsEventListener(ContaoCoreEvents::GENERATE_SYMLINKS)]
class GenerateSymlinksListener
{
    public function __invoke(GenerateSymlinksEvent $event): void
    {
        $event->addSymlink('_foo/file.txt', 'web/_foo/file.txt');
    }
}

// src/EventListener/ImageSizesAllListener.php
namespace App\EventListener;

use Contao\CoreBundle\Event\ContaoCoreEvents;
use Contao\CoreBundle\Event\ImageSizesEvent;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;

#[AsEventListener(ContaoCoreEvents::IMAGE_SIZES_ALL)]
class ImageSizesAllListener
{
    public function __invoke(ImageSizesEvent $event): void
    {
        // …
    }
}

// src/EventListener/ImageSizesUserListener.php
namespace App\EventListener;

use Contao\CoreBundle\Event\ContaoCoreEvents;
use Contao\CoreBundle\Event\ImageSizesEvent;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;

#[AsEventListener(ContaoCoreEvents::IMAGE_SIZES_USER)]
class ImageSizesUserListener
{
    public function __invoke(ImageSizesEvent $event): void
    {
        // …
    }
}

// src/EventListener/PreviewUrlCreateListener.php
namespace App\EventListener;

use Contao\CoreBundle\Event\ContaoCoreEvents;
use Contao\CoreBundle\Event\PreviewUrlCreateEvent;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;

#[AsEventListener(ContaoCoreEvents::PREVIEW_URL_CREATE)]
class PreviewUrlCreateListener
{
    public function __invoke(PreviewUrlCreateEvent $event): void
    {
        // …
    }
}

// src/EventListener/PreviewUrlConvertListener.php
namespace App\EventListener;

use Contao\CoreBundle\Event\ContaoCoreEvents;
use Contao\CoreBundle\Event\PreviewUrlConvertEvent;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;

#[AsEventListener(ContaoCoreEvents::PREVIEW_URL_CONVERT)]
class PreviewUrlConvertListener
{
    public function __invoke(PreviewUrlConvertEvent $event): void
    {
        // …
    }
}

// src/EventListener/RobotsTxtListener.php
namespace App\EventListener;

use Contao\CoreBundle\Event\ContaoCoreEvents;
use Contao\CoreBundle\Event\RobotsTxtEvent;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;

use webignition\RobotsTxt\Directive\Directive;
use webignition\RobotsTxt\Directive\UserAgentDirective;
use webignition\RobotsTxt\Inspector\Inspector;
use webignition\RobotsTxt\Record\Record;

#[AsEventListener(ContaoCoreEvents::ROBOTS_TXT)]
class RobotsTxtListener
{
    public function __invoke(RobotsTxtEvent $event): void
    {
        $file = $event->getFile();
        $inspector = new Inspector($file);

        // Check if a "User-Agent: *" directive is not already present
        if (0 === $inspector->getDirectives()->getLength()) {
            $record = new Record();

            $userAgentDirectiveList = $record->getUserAgentDirectiveList();
            $userAgentDirectiveList->add(new UserAgentDirective('*'));

            $file->addRecord($record);
        }

        foreach ($file->getRecords() as $record) {
            $directiveList = $record->getDirectiveList();
            $directiveList->add(new Directive('Disallow', '/foo/'));
        }
    }
}

// src/EventListener/SlugValidCharactersListener.php
namespace App\EventListener;

use Contao\CoreBundle\Event\ContaoCoreEvents;
use Contao\CoreBundle\Event\SlugValidCharactersEvent;
use Terminal42\ServiceAnnotationBundle\Annotation\ServiceTag;

#[AsEventListener(ContaoCoreEvents::SLUG_VALID_CHARACTERS)]
class SlugValidCharactersListener
{
    public function __invoke(SlugValidCharactersEvent $event): void
    {
        // …
    }
}

// src/EventListener/FilterPageTypeListener.php
namespace App\EventListener;

use Contao\CoreBundle\Event\FilterPageTypeEvent;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;

#[AsEventListener]
class FilterPageTypeListener
{
    public function __invoke(FilterPageTypeEvent $event): void
    {
        // Removes the "redirect" page type from the available page types
        $event->removeOption('redirect');
    }
}

// src/EventListener/SitemapListener.php
namespace App\EventListener;

use Contao\CoreBundle\Event\ContaoCoreEvents;
use Contao\CoreBundle\Event\SitemapEvent;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;

#[AsEventListener(ContaoCoreEvents::SITEMAP)]
class SitemapListener
{
    public function __invoke(SitemapEvent $event): void
    {
        $sitemap = $event->getDocument();
        $urlSet = $sitemap->childNodes[0];

        $loc = $sitemap->createElement('loc');
        $loc->appendChild($sitemap->createTextNode('https://example.com/foobar'));

        $urlEl = $sitemap->createElement('url');
        $urlEl->appendChild($loc);
        $urlSet->appendChild($urlEl);
    }
}

// src/EventListener/SitemapListener.php
namespace App\EventListener;

use Contao\CoreBundle\Event\ContaoCoreEvents;
use Contao\CoreBundle\Event\SitemapEvent;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;

#[AsEventListener(ContaoCoreEvents::SITEMAP)]
class SitemapListener
{
    public function __invoke(SitemapEvent $event): void
    {
        $event->addUrlToDefaultUrlSet('https://example.com/foobar');
    }
}

// src/EventListener/SendNewsletterListener.php
namespace App\EventListener;

use Contao\NewsletterBundle\Event\SendNewsletterEvent;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;

#[AsEventListener]
class SendNewsletterListener
{
    public function __invoke(SendNewsletterEvent $event): void
    {
        // Skip sending under certain conditions
        if (!preg_match('/@contao\.org/i', $event->getRecipientAddress())) {
            $event->setSkipSending(true);
        }

        if ($event->isHtmlAllowed()) {
            // Get the parsed HTML content of the newsletter
            $html = $event->getHtml();

            // Use the original, unparsed HTML content of the newsletter
            $html = $event->getNewsletterValue('content') ;

            // Get any data from the newsletter
            $id = $event->getNewsletterValue('id');

            // Get any data from the recipient
            $greeting = $event->getRecipientValue('greeting');

            // Overwrite the HTML with custom content
            $event->setHtml($html);
        }
    }
}

// src/EventListener/FetchArticlesForFeedEventListener.php
namespace App\EventListener;

use Contao\NewsBundle\Event\FetchArticlesForFeedEvent;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;

#[AsEventListener]
class FetchArticlesForFeedEventListener
{
    public function __invoke(FetchArticlesForFeedEvent $event): void
    {
        // Add additional news articles to the feed
        $articles = NewsModel::findBy(…);
        $event->addArticles($articles->getModels());

        // Set a logo for the feed
        $event->getFeed()->setLogo(…);
    }
}

// src/EventListener/TransformArticleForFeedEventListener.php
namespace App\EventListener;

use Contao\NewsBundle\Event\TransformArticleForFeedEvent;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;

#[AsEventListener(priority: -100)]
class TransformArticleForFeedEventListener
{
    public function __invoke(TransformArticleForFeedEvent $event): void
    {
        if (!($item = $event->getItem())) {
            return;
        }

        // Set a summary
        $item->setSummary(…);
    }
}