Yiisoft\Yii\Event\ListenerConfigurationChecker

Complexity

Total Complexity

13

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	isCallable()	0	9	2
B	check()	0	32	10

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Event;

use Psr\Container\ContainerExceptionInterface;

use function get_class;
use function gettype;
use function is_object;
use function is_string;

final class ListenerConfigurationChecker
{
    private ListenerFactory $listenerFactory;

    public function __construct(ListenerFactory $listenerFactory)
    {
        $this->listenerFactory = $listenerFactory;
    }

    /**
     * Checks the given event configuration and throws an exception in some cases:
     * - incorrect configuration format
     * - incorrect listener format
     * - listener is not a callable
     * - listener is meant to be a method of an object which can't be instantiated
     *
     * @param array $configuration An array in format of [eventClassName => [listeners]]
     */
    public function check(array $configuration): void
    {
        foreach ($configuration as $eventName => $listeners) {
            if (!is_string($eventName) || !class_exists($eventName)) {
                throw new InvalidEventConfigurationFormatException(
                    'Incorrect event listener format. Format with event name must be used.'
                );
            }

            if (!is_iterable($listeners)) {
                $type = is_object($listeners) ? get_class($listeners) : gettype($listeners);

                throw new InvalidEventConfigurationFormatException(
                    "Event listeners for $eventName must be an iterable, $type given."
                );
            }

            /** @var mixed $listener */
            foreach ($listeners as $listener) {
                try {
                    if (!$this->isCallable($listener)) {
                        $type = is_object($listener) ? get_class($listener) : gettype($listener);

                        throw new InvalidListenerConfigurationException(
                            "Listener must be a callable, $type given."
                        );
                    }
                } catch (ContainerExceptionInterface $exception) {
                    throw new InvalidListenerConfigurationException(
                        'Could not instantiate event listener or listener class has invalid configuration.',
                        0,
                        $exception
                    );
                }
            }
        }
    }

    /**
     * @param mixed $definition
     */
    private function isCallable($definition): bool
    {
        try {
            $this->listenerFactory->create($definition);
        } catch (InvalidListenerConfigurationException $e) {
            return false;
        }

        return true;
    }
}