EventsTree::addListener() - Code Metrics - Inspection of "add hhvm as target; allow failures" - Ariadne-CMS/arc-events - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( beec8b...68ede3 )

by Robbert

created 2016-01-28 13:02 UTC

EventsTree::addListener() A

↳ Parent: EventsTree

Complexity

Conditions	4
Paths	6

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	4.0092

Importance

Changes	5
Bugs	1	Features	1

Metric	Value
cc	4
eloc	10
c	5
b	1
f	1
nc	6
nop	3
dl	0
loc	16
ccs	11
cts	12
cp	0.9167
crap	4.0092
rs	9.2

<?php

/*
 * This file is part of the Ariadne Component Library.
 *
 * (c) Muze <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace arc\events;

/**
 *	This class implements an event stack on which listeners can be added and removed and events can be fired.
 */
class EventsTree implements EventsTreeInterface
{
    use \arc\traits\Proxy {
        \arc\traits\Proxy::__construct as private ProxyConstruct;
    }

    private $tree = null;

    /**
     *	@param \arc\tree\NamedNode $tree The tree storage for event listeners.
     */
    public function __construct($tree)
    {
        $this->ProxyConstruct( $tree );
        $this->tree = $tree;
    }

    /**
     *	Adds an event listener for the given event and returns it.
     *	@param string $eventName The event to listen for
     *   @param callable $callback The function to call when the event occurs.
     *   @return Listener
     */
    public function listen($eventName, $callback)
    {
        return $this->addListener( $eventName, $callback, false );
    }

    /**
     *	Adds an event listener for the given event and returns it. The listener
     *	will trigger in the capture phase - before any listeners in the listen phase.
     *	@param string $eventName The name of the event to listen for.
     *   @param callable $callback The function to call when the event occurs.
     *	@return Listener
     */
    public function capture($eventName, $callback)
    {
        return $this->addListener( $eventName, $callback, true );
    }

    /**
     *	Fires an event. If the event objects preventDefault() method has been called it
     *	will return false, otherwise the - potentially changed - eventData will be returned.
     *	@param string $eventName The name of the event to fire.
     *	@param array $eventData Optional. Data passed to each handler through the event object.
     *	@return false or $eventData - which may have been modified
     */
    public function fire( $eventName, $eventData = array() )
    {
        // FIXME: because this now uses the tree, we can't quickly check if any event listeners have been added for this eventName

        // so there should probably be a common list of all handled eventNames in the entire tree as a performance improvement
        $eventData['arc.path'] = $this->tree->getPath();
        $event = new Event( $eventName, $eventData );
$a = "a";
$ab = "ab";
$abc = "abc";
        $this->walkListeners( $event );
        if ($event->preventDefault) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $result = false;
        } else {
            $result = $event->data;
        }

        return $result;
    }

    /**
     *	Returns a new EventStack with the given path.
     *	@param string $path The path to listen or fire an event.
     *	@return EventStack a new EventStack for the given path.
     */
    public function cd($path)
    {
        return new EventsTree( $this->tree->cd( $path ) );
    }

    /**
     *	Non-fluent api method to add a listener.
     *	@param string $eventName The name of the event to listen for.
     *	@param Callable $callback The callback method to call.
     *	@param bool $capture Optional. If true listen in the capture phase. Default is false - listen phase.
     *	@return Listener
     */
    private function addListener($eventName, $callback, $capture = false)
    {
        $listenerSection = ( $capture ? 'capture' : 'listen' ) . '.' . $eventName;
        if (!is_callable($callback)) {
            throw new \arc\ExceptionIlligalRequest('Method is not callable.', \arc\exceptions::ILLEGAL_ARGUMENT);
        }
        if (!isset( $this->tree->nodeValue[ $listenerSection ])) {
            $this->tree->nodeValue[ $listenerSection ] = array();
        }
        $this->tree->nodeValue[ $listenerSection ][] = array(
            'method' => $callback
        );
        $id = max( array_keys( $this->tree->nodeValue[ $listenerSection ] ) );
$a = "a";
$ab = "ab";
$abc = "abc";

        return new Listener( $eventName, $id, $capture, $this );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     *	Non-fluent api method to remove a listener.
     *	@param string $eventName The name of the event the listener is registered for.
     *	@param int $id The id of the listener.
     *	@param string $path Optional. The path the listener is registered on. Default is '/'.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *	@param bool $capture Optional. If true the listener is triggered in the capture phase.
     *		Default is false.
     */
    public function removeListener($eventName, $id, $capture = false)
    {
        $listenerSection = ( $capture ? 'capture' : 'listen' ) . '.' . $eventName;
        unset( $this->tree->nodeValue[ $listenerSection ][ $id ] );
    }

    /**
     *	Calls each listener with the given event untill a listener returns false.
     */
    private function walkListeners($event)
    {
        $callListeners = function ($listeners) use ($event) {
            foreach ((array) $listeners as $listener) {
                $result = call_user_func( $listener['method'], $event );
                if ($result === false) {
                    return false; // this will stop \arc\path::walk, so other event handlers won't be called
                }
            }
        };
        $result = \arc\tree::parents(
            $this->tree,
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            function ($node, $result) use ($callListeners, $event) {

                if ($result !== false && isset( $node->nodeValue['capture.'.$event->name] )) {
                    return call_user_func($callListeners, $node->nodeValue['capture.'.$event->name] );
                }
            }
        );
        if (!isset( $result )) {
            $result = \arc\tree::dive(
                $this->tree,
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                function ($node) use ($callListeners, $event) {

                    if (isset( $node->nodeValue['listen.'.$event->name] )) {
                        return call_user_func($callListeners, $node->nodeValue['listen.'.$event->name ] );
                    }
                }
            );
        }

        return !isset( $result ) ? true : false;
    }
}


1			<?php
2
3			/*
4			* This file is part of the Ariadne Component Library.
5			*
6			* (c) Muze <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace arc\events;
13
14			/**
15			* This class implements an event stack on which listeners can be added and removed and events can be fired.
16			*/
17			class EventsTree implements EventsTreeInterface
18			{
19			use \arc\traits\Proxy {
20			\arc\traits\Proxy::__construct as private ProxyConstruct;
21			}
22
23			private $tree = null;
24
25			/**
26			* @param \arc\tree\NamedNode $tree The tree storage for event listeners.
27			*/
28	5		public function __construct($tree)
29			{
30	5		$this->ProxyConstruct( $tree );
31	5		$this->tree = $tree;
32	5		}
33
34			/**
35			* Adds an event listener for the given event and returns it.
36			* @param string $eventName The event to listen for
37			* @param callable $callback The function to call when the event occurs.
38			* @return Listener
39			*/
40	6		public function listen($eventName, $callback)
41			{
42	6		return $this->addListener( $eventName, $callback, false );
43			}
44
45			/**
46			* Adds an event listener for the given event and returns it. The listener
47			* will trigger in the capture phase - before any listeners in the listen phase.
48			* @param string $eventName The name of the event to listen for.
49			* @param callable $callback The function to call when the event occurs.
50			* @return Listener
51			*/
52	2		public function capture($eventName, $callback)
53			{
54	2		return $this->addListener( $eventName, $callback, true );
55			}
56
57			/**
58			* Fires an event. If the event objects preventDefault() method has been called it
59			* will return false, otherwise the - potentially changed - eventData will be returned.
60			* @param string $eventName The name of the event to fire.
61			* @param array $eventData Optional. Data passed to each handler through the event object.
62			* @return false or $eventData - which may have been modified
63			*/
64	6		public function fire( $eventName, $eventData = array() )
65			{
66			// FIXME: because this now uses the tree, we can't quickly check if any event listeners have been added for this eventName
			0 ignored issues – show Coding Style introduced 2015-12-24 15:07 UTC by Report Bug Copy Issue Report Comment refers to a FIXME task "because this now uses the tree, we can't quickly check if any event listeners have been added for this eventName" Loading history...
67			// so there should probably be a common list of all handled eventNames in the entire tree as a performance improvement
68	6		$eventData['arc.path'] = $this->tree->getPath();
69	6		$event = new Event( $eventName, $eventData );
			0 ignored issues – show Coding Style introduced 2016-01-27 23:18 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 17 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
70	6		$this->walkListeners( $event );
71	6		if ($event->preventDefault) {
			0 ignored issues – show Documentation introduced 2015-12-24 15:07 UTC by Report Bug Copy Issue Report The property `$preventDefault` is declared private in `arc\events\Event`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
72	1		$result = false;
73	1		} else {
74	5		$result = $event->data;
75			}
76
77	6		return $result;
78			}
79
80			/**
81			* Returns a new EventStack with the given path.
82			* @param string $path The path to listen or fire an event.
83			* @return EventStack a new EventStack for the given path.
84			*/
85	4		public function cd($path)
86			{
87	4		return new EventsTree( $this->tree->cd( $path ) );
88			}
89
90			/**
91			* Non-fluent api method to add a listener.
92			* @param string $eventName The name of the event to listen for.
93			* @param Callable $callback The callback method to call.
94			* @param bool $capture Optional. If true listen in the capture phase. Default is false - listen phase.
95			* @return Listener
96			*/
97	6		private function addListener($eventName, $callback, $capture = false)
98	4		{
99	6		$listenerSection = ( $capture ? 'capture' : 'listen' ) . '.' . $eventName;
100	6		if (!is_callable($callback)) {
101			throw new \arc\ExceptionIlligalRequest('Method is not callable.', \arc\exceptions::ILLEGAL_ARGUMENT);
102			}
103	6		if (!isset( $this->tree->nodeValue[ $listenerSection ])) {
104	4		$this->tree->nodeValue[ $listenerSection ] = array();
105	4		}
106	6		$this->tree->nodeValue[ $listenerSection ][] = array(
107			'method' => $callback
108	6		);
109	6		$id = max( array_keys( $this->tree->nodeValue[ $listenerSection ] ) );
			0 ignored issues – show Coding Style introduced 2016-01-27 23:18 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 42 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
110
111	6		return new Listener( $eventName, $id, $capture, $this );
			0 ignored issues – show Documentation introduced 2015-12-24 15:07 UTC by Report Bug Copy Issue Report `$this` is of type `this<arc\events\EventsTree>`, but the function expects a `object<arc\events\Stack>\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
112			}
113
114			/**
115			* Non-fluent api method to remove a listener.
116			* @param string $eventName The name of the event the listener is registered for.
117			* @param int $id The id of the listener.
118			* @param string $path Optional. The path the listener is registered on. Default is '/'.
			0 ignored issues – show Bug introduced 2015-12-24 15:07 UTC by Report Bug Copy Issue Report There is no parameter named `$path`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
119			* @param bool $capture Optional. If true the listener is triggered in the capture phase.
120			* Default is false.
121			*/
122	6		public function removeListener($eventName, $id, $capture = false)
123			{
124	6		$listenerSection = ( $capture ? 'capture' : 'listen' ) . '.' . $eventName;
125	6		unset( $this->tree->nodeValue[ $listenerSection ][ $id ] );
126	6		}
127
128			/**
129			* Calls each listener with the given event untill a listener returns false.
130			*/
131	6		private function walkListeners($event)
132			{
133			$callListeners = function ($listeners) use ($event) {
134	6		foreach ((array) $listeners as $listener) {
135	6		$result = call_user_func( $listener['method'], $event );
136	6		if ($result === false) {
137	1		return false; // this will stop \arc\path::walk, so other event handlers won't be called
138			}
139	6		}
140	6		};
141	6		$result = \arc\tree::parents(
142	6		$this->tree,
			0 ignored issues – show Documentation introduced 2015-12-24 15:07 UTC by Report Bug Copy Issue Report `$this->tree` is of type `object<arc\tree\NamedNode>`, but the function expects a `object<arc\tree\Node>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
143		View Code Duplication	function ($node, $result) use ($callListeners, $event) {
			0 ignored issues – show Duplication introduced 2015-12-24 15:07 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
144	6		if ($result !== false && isset( $node->nodeValue['capture.'.$event->name] )) {
145	5		return call_user_func($callListeners, $node->nodeValue['capture.'.$event->name] );
146			}
147	2		}
148	6		);
149	6		if (!isset( $result )) {
150	6		$result = \arc\tree::dive(
151	6		$this->tree,
			0 ignored issues – show Documentation introduced 2015-12-24 15:07 UTC by Report Bug Copy Issue Report `$this->tree` is of type `object<arc\tree\NamedNode>`, but the function expects a `object<arc\tree\Node>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
152	6	View Code Duplication	function ($node) use ($callListeners, $event) {
			0 ignored issues – show Duplication introduced 2015-12-24 15:07 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
153	6		if (isset( $node->nodeValue['listen.'.$event->name] )) {
154	6		return call_user_func($callListeners, $node->nodeValue['listen.'.$event->name ] );
155			}
156	2		}
157	6		);
158	6		}
159
160	6		return !isset( $result ) ? true : false;
161			}
162			}
163

Ariadne-CMS / arc-events

Push — master ( beec8b...68ede3 )

EventsTree::addListener() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like