Graze\ParallelProcess\Event\EventDispatcherTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	59
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getEventDispatcher()	0	6	2
A	dispatch()	0	5	1
A	addListener()	0	5	1
A	assertEventName()	0	7	2

<?php
/**
 * This file is part of graze/parallel-process.
 *
 * Copyright © 2018 Nature Delivered Ltd. <https://www.graze.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license https://github.com/graze/parallel-process/blob/master/LICENSE.md
 * @link    https://github.com/graze/parallel-process
 */

namespace Graze\ParallelProcess\Event;

use Symfony\Component\EventDispatcher\Event;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;

trait EventDispatcherTrait
{
    /** @var EventDispatcherInterface */
    protected $eventDispatcher;

    /**
     * @return EventDispatcherInterface
     */
    protected function getEventDispatcher()
    {
        if (is_null($this->eventDispatcher)) {
            $this->eventDispatcher = new EventDispatcher();
        }
        return $this->eventDispatcher;
    }

    /**
     * @return string[]
     */
    protected abstract function getEventNames();

    /**
     * @param string   $eventName
     * @param callable $handler
     *
     * @return $this
     */
    public function addListener($eventName, callable $handler)
    {
        $this->assertEventName($eventName);
        $this->getEventDispatcher()->addListener($eventName, $handler);
        return $this;
    }

    /**
     * @param string $eventName
     * @param Event  $event
     *
     * @return $this
     */
    protected function dispatch($eventName, Event $event)
    {
        $this->assertEventName($eventName);
        $this->getEventDispatcher()->dispatch($eventName, $event);
        return $this;
    }

    /**
     * @param string $name
     *
     * @throws \InvalidArgumentException
     */
    private function assertEventName($name)
    {
        if (!in_array($name, $this->getEventNames())) {
            throw new \InvalidArgumentException(sprintf(
                'The supplied event name: %s is not one of the expected: %s',
                $name,
                implode(', ', $this->getEventNames())
            ));
        }
    }
}