Dispatcher.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\Extbase\SignalSlot;
 
use Psr\Log\LoggerInterface;
use ‪TYPO3\CMS\Core\SingletonInterface;
use ‪TYPO3\CMS\Extbase\Object\ObjectManagerInterface;
use ‪TYPO3\CMS\Extbase\SignalSlot\Exception\InvalidSlotException;
use ‪TYPO3\CMS\Extbase\SignalSlot\Exception\InvalidSlotReturnException;
 
class ‪Dispatcher implements ‪SingletonInterface
{
    protected ‪$objectManager;
 
    protected ‪$slots = [];
 
    protected ‪$logger;
 
    public function ‪__construct(‪ObjectManagerInterface ‪$objectManager, LoggerInterface ‪$logger)
    {
        $this->objectManager = ‪$objectManager;
        $this->logger = ‪$logger;
    }
 
    public function ‪connect(string $signalClassName, string $signalName, $slotClassNameOrObject, string $slotMethodName = '', bool $passSignalInformation = true): void
    {
        $class = null;
        $object = null;
        if (is_object($slotClassNameOrObject)) {
            $object = $slotClassNameOrObject;
            $method = $slotClassNameOrObject instanceof \Closure ? '__invoke' : $slotMethodName;
        } else {
            if ($slotMethodName === '') {
                throw new \InvalidArgumentException('The slot method name must not be empty (except for closures).', 1229531659);
            }
            $class = $slotClassNameOrObject;
            $method = $slotMethodName;
        }
        $slot = [
            'class' => $class,
            'method' => $method,
            'object' => $object,
            'passSignalInformation' => $passSignalInformation === true,
        ];
        // The in_array() comparision needs to be strict to avoid potential issues
        // with complex objects being registered as slot.
        if (!is_array($this->slots[$signalClassName][$signalName] ?? false) || !in_array($slot, $this->slots[$signalClassName][$signalName], true)) {
            $this->slots[$signalClassName][$signalName][] = $slot;
        }
    }
 
    public function ‪dispatch(string $signalClassName, string $signalName, array $signalArguments = [])
    {
        $this->logger->debug('Triggered signal {signal_class} {signal_name} ', [
            'signal_class' => $signalClassName,
            'signal_name' => $signalName,
            'signalArguments' => $signalArguments,
        ]);
        if (!isset($this->slots[$signalClassName][$signalName])) {
            return $signalArguments;
        }
        foreach ($this->slots[$signalClassName][$signalName] as $slotInformation) {
            if (isset($slotInformation['object'])) {
                $object = $slotInformation['object'];
            } else {
                if (!class_exists($slotInformation['class'])) {
                    throw new ‪InvalidSlotException('The given class "' . $slotInformation['class'] . '" is not a registered object.', 1245673367);
                }
                $object = $this->objectManager->get($slotInformation['class']);
            }
 
            $method = (string)($slotInformation['method'] ?? '');
            $callable = [$object, $method];
 
            if (!is_object($object) || !is_callable($callable)) {
                throw new ‪InvalidSlotException('The slot method ' . get_class($object) . '->' . $method . '() does not exist.', 1245673368);
            }
 
            $preparedSlotArguments = $signalArguments;
            if ($slotInformation['passSignalInformation'] === true) {
                $preparedSlotArguments[] = $signalClassName . '::' . $signalName;
            }
 
            $slotReturn = $callable(...$preparedSlotArguments);
 
            if ($slotReturn) {
                if (!is_array($slotReturn)) {
                    throw new ‪InvalidSlotReturnException('The slot method ' . get_class($object) . '->' . $method . '()\'s return value is of an not allowed type ('
                        . gettype($slotReturn) . ').', 1376683067);
                }
                if (count($slotReturn) !== count($signalArguments)) {
                    throw new ‪InvalidSlotReturnException('The slot method ' . get_class($object) . '->' . $method . '() returned a different number ('
                        . count($slotReturn) . ') of arguments, than it received (' . count($signalArguments) . ').', 1376683066);
                }
                $signalArguments = $slotReturn;
            }
        }
 
        return $signalArguments;
    }
 
    public function ‪getSlots(string $signalClassName, string $signalName): array
    {
        return $this->slots[$signalClassName][$signalName] ?? [];
    }
}