ListenerProvider.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\EventDispatcher;
 
use Psr\Container\ContainerInterface;
use Psr\EventDispatcher\ListenerProviderInterface;
 
class ‪ListenerProvider implements ListenerProviderInterface
{
    protected ‪$container;
 
    protected ‪$listeners = [];
 
    public function ‪__construct(ContainerInterface ‪$container)
    {
        $this->container = ‪$container;
    }
 
    public function ‪addListener(string $event, string $service, string $method = null, string ‪$identifier = null): void
    {
        $this->listeners[$event][‪$identifier ?? $service] = [
            'service' => $service,
            'method' => $method,
        ];
    }
 
    public function ‪getAllListenerDefinitions(): array
    {
        return ‪$this->listeners;
    }
 
    public function ‪getListenersForEvent(object $event): iterable
    {
        $eventClasses = [get_class($event)];
        $classParents = class_parents($event);
        $classInterfaces = class_implements($event);
        if (is_array($classParents) && !empty($classParents)) {
            array_push($eventClasses, ...array_values($classParents));
        }
        if (is_array($classInterfaces) && !empty($classInterfaces)) {
            array_push($eventClasses, ...array_values($classInterfaces));
        }
        foreach ($eventClasses as $className) {
            if (isset($this->listeners[$className])) {
                foreach ($this->listeners[$className] as $listener) {
                    yield $this->‪getCallable($listener['service'], $listener['method']);
                }
            }
        }
    }
 
    protected function ‪getCallable(string $service, string $method = null): callable
    {
        $target = $this->container->get($service);
        if ($method !== null) {
            // Dispatch to configured method name instead of __invoke()
            $target = [ $target, $method ];
        }
 
        if (!is_callable($target)) {
            throw new \InvalidArgumentException(
                sprintf('Event listener "%s%s%s" is not callable"', $service, ($method !== null ? '::' : ''), $method),
                1549988537
            );
        }
 
        return $target;
    }
}