Phossa2\Event\Traits\EventCapableTrait

Complexity

Total Complexity

10

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setEventManager()	0	14	3
A	getEventManager()	0	7	2
A	setEventPrototype()	0	5	1
A	trigger()	0	10	1
A	triggerEvent()	0	13	1
A	createEvent()	0	15	2

<?php
/**
 * Phossa Project
 *
 * PHP version 5.4
 *
 * @category  Library
 * @package   Phossa2\Event
 * @copyright Copyright (c) 2016 phossa.com
 * @license   http://mit-license.org/ MIT License
 * @link      http://www.phossa.com/
 */
/*# declare(strict_types=1); */

namespace Phossa2\Event\Traits;

use Phossa2\Event\Event;
use Phossa2\Event\EventDispatcher;
use Phossa2\Event\Interfaces\EventInterface;
use Phossa2\Event\Interfaces\ListenerInterface;
use Phossa2\Event\Interfaces\EventManagerInterface;
use Phossa2\Event\Interfaces\ListenerAwareInterface;

/**
 * Implementation of EventCapableInterface
 *
 * @package Phossa2\Event
 * @author  Hong Zhang <phossa@126.com>
 * @see     EventCapableInterface
 * @version 2.0.0
 * @since   2.0.0 added
 */
trait EventCapableTrait
{
    /**
     * event manager or dispatcher
     *
     * @var    EventManagerInterface
     * @access protected
     */
    protected $event_manager;

    /**
     * event prototype
     *
     * @var    EventInterface
     * @access protected
     */
    protected $event_proto;

    /**
     * {@inheritDoc}
     */
    public function setEventManager(
        EventManagerInterface $eventManager
    ) {
        $this->event_manager = $eventManager;

        // attach events from $this
        if ($eventManager instanceof ListenerAwareInterface &&
            $this instanceof ListenerInterface
        ) {
            $eventManager->attachListener($this);
        }

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function getEventManager()/*# : EventManagerInterface */
    {
        if (is_null($this->event_manager)) {
            $this->setEventManager(new EventDispatcher(get_class($this)));
        }
        return $this->event_manager;
    }

    /**
     * {@inheritDoc}
     */
    public function setEventPrototype(EventInterface $eventPrototype)
    {
        $this->event_proto = $eventPrototype;
        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function trigger(
        /*# string */ $eventName,
        array $properties = []
    )/*# : bool */ {
        // trigger the event
        $evt = $this->triggerEvent($eventName, $properties);

        // success or stopped
        return !$evt->isPropagationStopped();
    }

    /**
     * {@inheritDoc}
     */
    public function triggerEvent(
        /*# string */ $eventName,
        array $properties = []
    )/*# : EventInterface */ {
        // create an event with context $this
        $evt = $this->createEvent($eventName, $properties);

        // process it
        $this->getEventManager()->trigger($evt);

        // return the event
        return $evt;
    }

    /**
     * Create an event with $eventName and properties
     *
     * @param  string $eventName
     * @param  array $properties
     * @return EventInterface
     * @access protected
     */
    protected function createEvent(
        /*# string */ $eventName,
        array $properties
    )/*# : EventInterface */ {
        // get event prototype
        if (is_null($this->event_proto)) {
            return new Event($eventName, $this, $properties);
        } else {
            // clone the prototype
            $evt = clone $this->event_proto;

            // init the event and return it
            return $evt($eventName, $this, $properties);
        }
    }
}