Event::on() - Code Metrics - Inspection of "Updated CHANGELOG" - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — bash-completion ( 164352...1454d3 )

by Carsten

created 2016-12-02 23:43 UTC

Event::on() A

↳ Parent: Event

Complexity

Conditions	3
Paths	2

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3.0261

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0
ccs	6
cts	7
cp	0.8571
cc	3
eloc	6
nc	2
nop	5
crap	3.0261

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\base;

/**
 * Event is the base class for all event classes.
 *
 * It encapsulates the parameters associated with an event.
 * The [[sender]] property describes who raises the event.
 * And the [[handled]] property indicates if the event is handled.
 * If an event handler sets [[handled]] to be `true`, the rest of the
 * uninvoked handlers will no longer be called to handle the event.
 *
 * Additionally, when attaching an event handler, extra data may be passed
 * and be available via the [[data]] property when the event handler is invoked.
 *
 * For more details and usage information on Event, see the [guide article on events](guide:concept-events).
 *
 * @author Qiang Xue <[email protected]>
 * @since 2.0
 */
class Event extends Object
{
    /**
     * @var string the event name. This property is set by [[Component::trigger()]] and [[trigger()]].
     * Event handlers may use this property to check what event it is handling.
     */
    public $name;
    /**
     * @var object the sender of this event. If not set, this property will be
     * set as the object whose `trigger()` method is called.
     * This property may also be a `null` when this event is a
     * class-level event which is triggered in a static context.
     */
    public $sender;
    /**
     * @var bool whether the event is handled. Defaults to `false`.
     * When a handler sets this to be `true`, the event processing will stop and
     * ignore the rest of the uninvoked event handlers.
     */
    public $handled = false;
    /**
     * @var mixed the data that is passed to [[Component::on()]] when attaching an event handler.
     * Note that this varies according to which event handler is currently executing.
     */
    public $data;

    /**
     * @var array contains all globally registered event handlers.
     */
    private static $_events = [];


    /**
     * Attaches an event handler to a class-level event.
     *
     * When a class-level event is triggered, event handlers attached
     * to that class and all parent classes will be invoked.
     *
     * For example, the following code attaches an event handler to `ActiveRecord`'s
     * `afterInsert` event:
     *
     * ```php
     * Event::on(ActiveRecord::className(), ActiveRecord::EVENT_AFTER_INSERT, function ($event) {
     *     Yii::trace(get_class($event->sender) . ' is inserted.');
     * });
     * ```
     *
     * The handler will be invoked for EVERY successful ActiveRecord insertion.
     *
     * For more details about how to declare an event handler, please refer to [[Component::on()]].
     *
     * @param string $class the fully qualified class name to which the event handler needs to attach.
     * @param string $name the event name.
     * @param callable $handler the event handler.
     * @param mixed $data the data to be passed to the event handler when the event is triggered.
     * When the event handler is invoked, this data can be accessed via [[Event::data]].
     * @param bool $append whether to append new event handler to the end of the existing
     * handler list. If `false`, the new handler will be inserted at the beginning of the existing
     * handler list.
     * @see off()
     */
    public static function on($class, $name, $handler, $data = null, $append = true)
    {
        $class = ltrim($class, '\\');
        if ($append || empty(self::$_events[$name][$class])) {
            self::$_events[$name][$class][] = [$handler, $data];
        } else {
            array_unshift(self::$_events[$name][$class], [$handler, $data]);
        }
    }

    /**
     * Detaches an event handler from a class-level event.
     *
     * This method is the opposite of [[on()]].
     *
     * @param string $class the fully qualified class name from which the event handler needs to be detached.
     * @param string $name the event name.
     * @param callable $handler the event handler to be removed.
     * If it is `null`, all handlers attached to the named event will be removed.
     * @return bool whether a handler is found and detached.
     * @see on()
     */
    public static function off($class, $name, $handler = null)
    {
        $class = ltrim($class, '\\');
        if (empty(self::$_events[$name][$class])) {
            return false;
        }
        if ($handler === null) {
            unset(self::$_events[$name][$class]);
            return true;
        }

        $removed = false;
        foreach (self::$_events[$name][$class] as $i => $event) {
            if ($event[0] === $handler) {
                unset(self::$_events[$name][$class][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            self::$_events[$name][$class] = array_values(self::$_events[$name][$class]);
        }
        return $removed;
    }

    /**
     * Detaches all registered class-level event handlers.
     * @see on()
     * @see off()
     * @since 2.0.10
     */
    public static function offAll()
    {
        self::$_events = [];
    }

    /**
     * Returns a value indicating whether there is any handler attached to the specified class-level event.
     * Note that this method will also check all parent classes to see if there is any handler attached
     * to the named event.
     * @param string|object $class the object or the fully qualified class name specifying the class-level event.
     * @param string $name the event name.
     * @return bool whether there is any handler attached to the event.
     */
    public static function hasHandlers($class, $name)
    {
        if (empty(self::$_events[$name])) {
            return false;
        }
        if (is_object($class)) {
            $class = get_class($class);
        } else {
            $class = ltrim($class, '\\');
        }

        $classes = array_merge(
            [$class],
            class_parents($class, true),
            class_implements($class, true)
        );

        foreach ($classes as $class) {
            if (!empty(self::$_events[$name][$class])) {
                return true;
            }
        }

        return false;
    }

    /**
     * Triggers a class-level event.
     * This method will cause invocation of event handlers that are attached to the named event
     * for the specified class and all its parent classes.
     * @param string|object $class the object or the fully qualified class name specifying the class-level event.
     * @param string $name the event name.
     * @param Event $event the event parameter. If not set, a default [[Event]] object will be created.
     */
    public static function trigger($class, $name, $event = null)
    {
        if (empty(self::$_events[$name])) {
            return;
        }
        if ($event === null) {
            $event = new static;
        }
        $event->handled = false;
        $event->name = $name;

        if (is_object($class)) {
            if ($event->sender === null) {
                $event->sender = $class;
            }
            $class = get_class($class);
        } else {
            $class = ltrim($class, '\\');
        }

        $classes = array_merge(
            [$class],
            class_parents($class, true),
            class_implements($class, true)
        );

        foreach ($classes as $class) {
            if (!empty(self::$_events[$name][$class])) {
                foreach (self::$_events[$name][$class] as $handler) {
                    $event->data = $handler[1];
                    call_user_func($handler[0], $event);
                    if ($event->handled) {
                        return;
                    }
                }
            }
        }
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\base;
9
10		/**
11		* Event is the base class for all event classes.
12		*
13		* It encapsulates the parameters associated with an event.
14		* The [[sender]] property describes who raises the event.
15		* And the [[handled]] property indicates if the event is handled.
16		* If an event handler sets [[handled]] to be `true`, the rest of the
17		* uninvoked handlers will no longer be called to handle the event.
18		*
19		* Additionally, when attaching an event handler, extra data may be passed
20		* and be available via the [[data]] property when the event handler is invoked.
21		*
22		* For more details and usage information on Event, see the [guide article on events](guide:concept-events).
23		*
24		* @author Qiang Xue <[email protected]>
25		* @since 2.0
26		*/
27		class Event extends Object
28		{
29		/**
30		* @var string the event name. This property is set by [[Component::trigger()]] and [[trigger()]].
31		* Event handlers may use this property to check what event it is handling.
32		*/
33		public $name;
34		/**
35		* @var object the sender of this event. If not set, this property will be
36		* set as the object whose `trigger()` method is called.
37		* This property may also be a `null` when this event is a
38		* class-level event which is triggered in a static context.
39		*/
40		public $sender;
41		/**
42		* @var bool whether the event is handled. Defaults to `false`.
43		* When a handler sets this to be `true`, the event processing will stop and
44		* ignore the rest of the uninvoked event handlers.
45		*/
46		public $handled = false;
47		/**
48		* @var mixed the data that is passed to [[Component::on()]] when attaching an event handler.
49		* Note that this varies according to which event handler is currently executing.
50		*/
51		public $data;
52
53		/**
54		* @var array contains all globally registered event handlers.
55		*/
56		private static $_events = [];
57
58
59		/**
60		* Attaches an event handler to a class-level event.
61		*
62		* When a class-level event is triggered, event handlers attached
63		* to that class and all parent classes will be invoked.
64		*
65		* For example, the following code attaches an event handler to `ActiveRecord`'s
66		* `afterInsert` event:
67		*
68		* ```php
69		* Event::on(ActiveRecord::className(), ActiveRecord::EVENT_AFTER_INSERT, function ($event) {
70		* Yii::trace(get_class($event->sender) . ' is inserted.');
71		* });
72		* ```
73		*
74		* The handler will be invoked for EVERY successful ActiveRecord insertion.
75		*
76		* For more details about how to declare an event handler, please refer to [[Component::on()]].
77		*
78		* @param string $class the fully qualified class name to which the event handler needs to attach.
79		* @param string $name the event name.
80		* @param callable $handler the event handler.
81		* @param mixed $data the data to be passed to the event handler when the event is triggered.
82		* When the event handler is invoked, this data can be accessed via [[Event::data]].
83		* @param bool $append whether to append new event handler to the end of the existing
84		* handler list. If `false`, the new handler will be inserted at the beginning of the existing
85		* handler list.
86		* @see off()
87		*/
88	14	public static function on($class, $name, $handler, $data = null, $append = true)
89		{
90	14	$class = ltrim($class, '\\');
91	14	if ($append \|\| empty(self::$_events[$name][$class])) {
92	14	self::$_events[$name][$class][] = [$handler, $data];
93	14	} else {
94		array_unshift(self::$_events[$name][$class], [$handler, $data]);
95		}
96	14	}
97
98		/**
99		* Detaches an event handler from a class-level event.
100		*
101		* This method is the opposite of [[on()]].
102		*
103		* @param string $class the fully qualified class name from which the event handler needs to be detached.
104		* @param string $name the event name.
105		* @param callable $handler the event handler to be removed.
106		* If it is `null`, all handlers attached to the named event will be removed.
107		* @return bool whether a handler is found and detached.
108		* @see on()
109		*/
110	12	public static function off($class, $name, $handler = null)
111		{
112	12	$class = ltrim($class, '\\');
113	12	if (empty(self::$_events[$name][$class])) {
114		return false;
115		}
116	12	if ($handler === null) {
117	8	unset(self::$_events[$name][$class]);
118	8	return true;
119		}
120
121	4	$removed = false;
122	4	foreach (self::$_events[$name][$class] as $i => $event) {
123	4	if ($event[0] === $handler) {
124	4	unset(self::$_events[$name][$class][$i]);
125	4	$removed = true;
126	4	}
127	4	}
128	4	if ($removed) {
129	4	self::$_events[$name][$class] = array_values(self::$_events[$name][$class]);
130	4	}
131	4	return $removed;
132		}
133
134		/**
135		* Detaches all registered class-level event handlers.
136		* @see on()
137		* @see off()
138		* @since 2.0.10
139		*/
140	3	public static function offAll()
141		{
142	3	self::$_events = [];
143	3	}
144
145		/**
146		* Returns a value indicating whether there is any handler attached to the specified class-level event.
147		* Note that this method will also check all parent classes to see if there is any handler attached
148		* to the named event.
149		* @param string\|object $class the object or the fully qualified class name specifying the class-level event.
150		* @param string $name the event name.
151		* @return bool whether there is any handler attached to the event.
152		*/
153	72	public static function hasHandlers($class, $name)
154		{
155	72	if (empty(self::$_events[$name])) {
156	72	return false;
157		}
158	4	if (is_object($class)) {
159	2	$class = get_class($class);
160	2	} else {
161	2	$class = ltrim($class, '\\');
162		}
163
164	4	$classes = array_merge(
165	4	[$class],
166	4	class_parents($class, true),
167	4	class_implements($class, true)
168	4	);
169
170	4	foreach ($classes as $class) {
171	4	if (!empty(self::$_events[$name][$class])) {
172	4	return true;
173		}
174	2	}
175
176	2	return false;
177		}
178
179		/**
180		* Triggers a class-level event.
181		* This method will cause invocation of event handlers that are attached to the named event
182		* for the specified class and all its parent classes.
183		* @param string\|object $class the object or the fully qualified class name specifying the class-level event.
184		* @param string $name the event name.
185		* @param Event $event the event parameter. If not set, a default [[Event]] object will be created.
186		*/
187	789	public static function trigger($class, $name, $event = null)
188		{
189	789	if (empty(self::$_events[$name])) {
190	782	return;
191		}
192	361	if ($event === null) {
193	359	$event = new static;
194	359	}
195	361	$event->handled = false;
196	361	$event->name = $name;
197
198	361	if (is_object($class)) {
199	361	if ($event->sender === null) {
200	361	$event->sender = $class;
201	361	}
202	361	$class = get_class($class);
203	361	} else {
204		$class = ltrim($class, '\\');
205		}
206
207	361	$classes = array_merge(
208	361	[$class],
209	361	class_parents($class, true),
210	361	class_implements($class, true)
211	361	);
212
213	361	foreach ($classes as $class) {
214	361	if (!empty(self::$_events[$name][$class])) {
215	12	foreach (self::$_events[$name][$class] as $handler) {
216	12	$event->data = $handler[1];
217	12	call_user_func($handler[0], $event);
218	12	if ($event->handled) {
219		return;
220		}
221	12	}
222	12	}
223	361	}
224	361	}
225		}
226

yiisoft / yii2

Push — bash-completion ( 164352...1454d3 )

Event::on() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like