Events::getInProgress() - Code Metrics - Inspection of "Php7ize" - Nevraxe/Cervo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 4.0 ( d72a1a...2b4391 )

by Marc André

created 2017-06-01 18:07 UTC

Events::getInProgress() A

↳ Parent: Events

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php


/**
 *
 * Copyright (c) 2010-2017 Nevraxe inc. & Marc André Audet <[email protected]>. 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 <[email protected]>
 */
final class Events
{
    /**
     * Holds all the events and their callbacks.
     * @var array
     */
    private $events = [];

    /**
     * Name of the event in progress, null if there are no active events.
     * @var string|null
     */
    private $inProgress = null;

    /**
     * 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) {

            $function = require $file;

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

        }
    }

    /**
     * Register a new event.
     *
     * @param string $name
     *
     * @return bool
     */
    public function register(string $name) : bool
    {
        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(string $name) : bool
    {
        return isset($this->events[$name]);
    }

    /**
     * Remove an event and un-hook everything related to it.
     *
     * @param string $name
     */
    public function unregister(string $name) : void
    {
        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(string $name, callable $call, int $priority = 0) : bool
    {
        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(string $name, array $params = []) : bool
    {
        if (!is_array($params) || !$this->isRegistered($name)) {
            return false;
        }

        $this->inProgress = $name;

        usort($this->events[$name], function ($a, $b) {
            return $a['priority'] <=> $b['priority'];
        });

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

        $this->inProgress = null;

        return true;
    }

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

    /**
     * Returns true if an event is being fired.
     *
     * @return bool
     */
    public function isInProgress() : bool
    {
        return $this->inProgress !== null;
    }
}


1			<?php
2
3
4			/**
5			*
6			* Copyright (c) 2010-2017 Nevraxe inc. & Marc André Audet <[email protected]>. All rights reserved.
7			*
8			* Redistribution and use in source and binary forms, with or without modification, are
9			* permitted provided that the following conditions are met:
10			*
11			* 1. Redistributions of source code must retain the above copyright notice, this list of
12			* conditions and the following disclaimer.
13			*
14			* 2. Redistributions in binary form must reproduce the above copyright notice, this list
15			* of conditions and the following disclaimer in the documentation and/or other materials
16			* provided with the distribution.
17			*
18			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19			* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20			* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21			* DISCLAIMED. IN NO EVENT SHALL MARC ANDRÉ "MANHIM" AUDET BE LIABLE FOR ANY
22			* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23			* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24			* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25			* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27			* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28			*
29			*/
30
31
32			namespace Cervo\Libraries;
33
34
35			use Cervo\Core as _;
36
37
38			/**
39			* Events manager for Cervo.
40			*
41			* @author Marc André Audet <[email protected]>
42			*/
43			final class Events
44			{
45			/**
46			* Holds all the events and their callbacks.
47			* @var array
48			*/
49			private $events = [];
50
51			/**
52			* Name of the event in progress, null if there are no active events.
53			* @var string\|null
54			*/
55			private $inProgress = null;
56
57			/**
58			* Include all the events files that may register and/or hook to events.
59			*/
60			public function __construct()
61			{
62			$config = _::getLibrary('Cervo/Config');
63
64			foreach (glob($config->get('Cervo/Application/Directory') . '' . \DS . $config->get('Cervo/Application/EventsPath') . '.php', \GLOB_NOSORT \| \GLOB_NOESCAPE) as $file) {
65
66			$function = require $file;
67
68			if (is_callable($function)) {
69			$function($this);
70			}
71
72			}
73			}
74
75			/**
76			* Register a new event.
77			*
78			* @param string $name
79			*
80			* @return bool
81			*/
82			public function register(string $name) : bool
83			{
84			if ($this->isRegistered($name)) {
85			return false;
86			}
87
88			$this->events[$name] = [];
89
90			return true;
91			}
92
93			/**
94			* Check if the event exists by it's name.
95			*
96			* @param string $name
97			*
98			* @return bool
99			*/
100			public function isRegistered(string $name) : bool
101			{
102			return isset($this->events[$name]);
103			}
104
105			/**
106			* Remove an event and un-hook everything related to it.
107			*
108			* @param string $name
109			*/
110			public function unregister(string $name) : void
111			{
112			unset($this->events[$name]);
113			}
114
115			/**
116			* Hook a callable to an event.
117			* If the event is not registered, register it.
118			*
119			* @param string $name
120			* @param callable $call
121			* @param int $priority
122			*
123			* @return bool
124			*/
125			public function hook(string $name, callable $call, int $priority = 0) : bool
126			{
127			if (!$this->isRegistered($name)) {
128			$this->register($name);
129			}
130
131			$this->events[$name][] = [
132			'call' => $call,
133			'priority' => $priority
134			];
135
136			return true;
137			}
138
139			/**
140			* Fire an event and call all the hooked callables.
141			*
142			* @param string $name
143			* @param array $params
144			*
145			* @return bool
146			*/
147			public function fire(string $name, array $params = []) : bool
148			{
149			if (!is_array($params) \|\| !$this->isRegistered($name)) {
150			return false;
151			}
152
153			$this->inProgress = $name;
154
155			usort($this->events[$name], function ($a, $b) {
156			return $a['priority'] <=> $b['priority'];
157			});
158
159			foreach ($this->events[$name] as $call) {
160			call_user_func($call['call'], $name, $params);
161			}
162
163			$this->inProgress = null;
164
165			return true;
166			}
167
168			/**
169			* Returns the name of the event being fired, null otherwise.
170			*
171			* @return string\|null
172			*/
173			public function getInProgress() : ?string
174			{
175			return $this->inProgress;
176			}
177
178			/**
179			* Returns true if an event is being fired.
180			*
181			* @return bool
182			*/
183			public function isInProgress() : bool
184			{
185			return $this->inProgress !== null;
186			}
187			}
188

Nevraxe / Cervo

Push — 4.0 ( d72a1a...2b4391 )

Events::getInProgress() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like