Cervo\Libraries\Events

Complexity

Total Complexity

17

Size/Duplication

Total Lines	150
Duplicated Lines	6 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	8
Bugs	2	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	prioritySort()	0	8	3
A	__construct()	9	14	3
A	register()	0	10	2
A	isRegistered()	0	4	1
A	unregister()	0	4	1
A	hook()	0	13	2
A	fire()	0	18	4
A	isInProgress()	0	4	1

<?php


/**
 *
 * Copyright (c) 2010-2016 Nevraxe inc. & Marc André Audet <maudet@nevraxe.com>. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright notice, this list of
 *       conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright notice, this list
 *       of conditions and the following disclaimer in the documentation and/or other materials
 *       provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL MARC ANDRÉ "MANHIM" AUDET BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */


namespace Cervo\Libraries;


use Cervo\Core as _;


/**
 * Events manager for Cervo.
 *
 * @author Marc André Audet <maudet@nevraxe.com>
 */
class Events
{
    /**
     * Holds all the events and their callbacks.
     * @var array
     */
    protected $events = [];

    /**
     * True while an event is fired.
     * @var string|bool
     */
    protected $inProgress = false;

    /**
     * Custom sort for priority.
     *
     * @param array $a
     * @param array $b
     *
     * @return int
     */
    public static function prioritySort($a, $b)
    {
        if ($a['priority'] == $b['priority']) {
            return 0;
        }

        return $a['priority'] < $b['priority'] ? -1 : 1;
    }

    /**
     * Include all the events files that may register and/or hook to events.
     */
    public function __construct()
    {
        $config = _::getLibrary('Cervo/Config');

        foreach (glob($config->get('Cervo/Application/Directory') . '*' . \DS . $config->get('Cervo/Application/EventsPath') . '*.php', \GLOB_NOSORT | \GLOB_NOESCAPE) as $file) {

This code seems to be duplicated across your project.

            $function = require $file;

            if (is_callable($function)) {
                $function($this);
            }

        }
    }

    /**
     * Register a new event.
     *
     * @param string $name
     *
     * @return bool
     */
    public function register($name)
    {
        if ($this->isRegistered($name)) {
            return false;
        }

        $this->events[$name] = [];

        return true;
    }

    /**
     * Check if the event exists by it's name.
     *
     * @param string $name
     *
     * @return bool
     */
    public function isRegistered($name)
    {
        return isset($this->events[$name]);
    }

    /**
     * Remove an event and un-hook everything related to it.
     *
     * @param string $name
     */
    public function unregister($name)
    {
        unset($this->events[$name]);
    }

    /**
     * Hook a callable to an event.
     * If the event is not registered, register it.
     *
     * @param string $name
     * @param callable $call
     * @param int $priority
     *
     * @return bool
     */
    public function hook($name, $call, $priority = 0)
    {
        if (!$this->isRegistered($name)) {
            $this->register($name);
        }

        $this->events[$name][] = [
            'call' => $call,
            'priority' => $priority
        ];

        return true;
    }

    /**
     * Fire an event and call all the hooked callables.
     *
     * @param string $name
     * @param array $params
     *
     * @return bool
     */
    public function fire($name, $params = [])
    {
        if (!is_array($params) || !$this->isRegistered($name)) {
            return false;
        }

        $this->inProgress = $name;

        usort($this->events[$name], '\\' . __CLASS__ . '::prioritySort');

        foreach ($this->events[$name] as $call) {
            call_user_func($call['call'], $name, $params);
        }

        $this->inProgress = false;

        return true;
    }

    /**
     * Returns the name of the event being fired, false otherwise.
     *
     * @return string|bool
     */
    public function isInProgress()
    {
        return $this->inProgress;
    }
}