Phossa2\Event\EventableExtensionAbstract

Complexity

Total Complexity

3

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
	extensionHandles()	0	1	?
A	__construct()	0	4	1
A	bootExtension()	0	6	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;

use Phossa2\Shared\Extension\ExtensionAbstract;
use Phossa2\Event\Interfaces\ListenerInterface;

/**
 * EventableExtensionAbstract
 *
 * Extension with support for handling server's events.
 *
 * @property ListenerInterface $server
 *
 * @package Phossa2\Event
 * @author  Hong Zhang <phossa@126.com>
 * @see     ExtensionAbstract
 * @version 2.1.5
 * @since   2.1.5 added
 */
abstract class EventableExtensionAbstract extends ExtensionAbstract
{
    /**
     * Constructor
     *
     * @param  array $properties
     * @access public
     */
    public function __construct(array $properties = [])
    {
        $this->setProperties($properties);
    }

    /**
     * register handlers in the extension with $this->server's evt manager
     *
     * {@inheritDoc}
     */
    protected function bootExtension()
    {
        foreach ($this->extensionHandles() as $evt) {
            $this->server->registerEvent($evt['event'], $evt['handler']);
        }
    }

    /**
     * Return event handlers of this extension handling
     *
     * ```php
     * protected function extensionHandles()
     * {
     *     return [
     *         ['event' => 'cache.*', 'handler' => ['byPassCache', 100]],
     *     ];
     * }
     * ```
     *
     * @return array
     * @access protected
     */
    abstract protected function extensionHandles()/*# : array */;
}