Phile\Core\Event

Complexity

Total Complexity

10

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Test Coverage

Coverage

89.47%

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getInstance()	0	3	1
A	setInstance()	0	3	1
A	registerEvent()	0	3	1
A	trigger()	0	7	3
A	triggerEvent()	0	3	1
A	register()	0	12	3

<?php
/**
 * The Event class
 */
namespace Phile\Core;

use Phile\Gateway\EventObserverInterface;

/**
 * the Event class for implementing a hook/event system
 *
 * @author  PhileCMS
 * @link    https://philecms.github.io
 * @license http://opensource.org/licenses/MIT
 * @package Phile\Core
 */
class Event
{

    /**
     * @var Event global instance
     * @deprecated static use is deprecated
     */
    protected static $instance;

    /**
     * Registry object provides storage for objects.
     *
     * @var array
     */
    protected $registry = [];

    /**
     * get global event instance
     *
     * @return Event
     * @deprecated static use is deprectated
     */
    public static function getInstance()
    {
        return static::$instance;
    }

    /**
     * Set global event instance
     *
     * @param Event $instance
     * @return void
     * @deprecated static use is deprecated
     */
    public static function setInstance(Event $instance): void
    {
        static::$instance = $instance;
    }

    /**
     * Global register
     *
     * @param string $eventName
     * @param EventObserverInterface|callable $object observer
     * @return void
     * @deprecated static use is deprecated
     */
    public static function registerEvent($eventName, $object): void
    {
        static::$instance->register($eventName, $object);
    }

    /**
     * Global trigger
     *
     * @param string $eventName
     * @param array $data
     * @return void
     * @deprecated static use is deprecated
     */
    public static function triggerEvent($eventName, $data = null): void
    {
        static::$instance->trigger($eventName, $data);
    }

    /**
     * method to register an event
     *
     * @param string $eventName the event to observe
     * @param EventObserverInterface|callable $object observer
     */
    public function register(string $eventName, $object): void
    {
        if ($object instanceof EventObserverInterface) {
            $object = [$object, 'on'];
        }
        if (!is_callable($object)) {
            throw new \InvalidArgumentException(
                "Can't register event. Observer is not callable.",
                1427814905
            );
        }
        $this->registry[$eventName][] = $object;
    }

    /**
     * method to trigger an event
     *
     * @param string $eventName the event name (register for this name)
     * @param array $data array with some additional data
     */
    public function trigger(string $eventName, array $data = null): void
    {
        if (empty($this->registry[$eventName])) {
            return;
        }
        foreach ($this->registry[$eventName] as $observer) {
            call_user_func_array($observer, [$eventName, $data]);
        }
    }
}