php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-13 20:59:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #12260 from w3lifer/patch-21

Browse Source 
Cosmetic changes
This commit is contained in:
Dmitry Naumenko
2016-08-23 10:02:17 +03:00
committed by GitHub
parent fd134809e5 00e4470c42
commit f1951295a3
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
framework/base/Event.php
View File

@@ -13,7 +13,7 @@ namespace yii\base;
* It encapsulates the parameters associated with an event. * It encapsulates the parameters associated with an event.
* The [[sender]] property describes who raises the event. * The [[sender]] property describes who raises the event.
* And the [[handled]] property indicates if the event is handled. * And the [[handled]] property indicates if the event is handled.
* If an event handler sets [[handled]] to be true, the rest of the * If an event handler sets [[handled]] to be `true`, the rest of the
* uninvoked handlers will no longer be called to handle the event. * uninvoked handlers will no longer be called to handle the event.
* *
* Additionally, when attaching an event handler, extra data may be passed * Additionally, when attaching an event handler, extra data may be passed
@@ -31,14 +31,14 @@ class Event extends Object
public $name; public $name;
/** /**
* @var object the sender of this event. If not set, this property will be * @var object the sender of this event. If not set, this property will be
* set as the object whose "trigger()" method is called. * set as the object whose `trigger()` method is called.
* This property may also be a `null` when this event is a * This property may also be a `null` when this event is a
* class-level event which is triggered in a static context. * class-level event which is triggered in a static context.
*/ */
public $sender; public $sender;
/** /**
* @var boolean whether the event is handled. Defaults to false. * @var boolean whether the event is handled. Defaults to `false`.
* When a handler sets this to be true, the event processing will stop and * When a handler sets this to be `true`, the event processing will stop and
* ignore the rest of the uninvoked event handlers. * ignore the rest of the uninvoked event handlers.
*/ */
public $handled = false; public $handled = false;
@@ -79,7 +79,7 @@ class Event extends Object
* @param mixed $data the data to be passed to the event handler when the event is triggered. * @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]]. * When the event handler is invoked, this data can be accessed via [[Event::data]].
* @param boolean $append whether to append new event handler to the end of the existing * @param boolean $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. If `false`, the new handler will be inserted at the beginning of the existing
* handler list. * handler list.
* @see off() * @see off()
*/ */
@@ -101,7 +101,7 @@ class Event extends Object
* @param string $class the fully qualified class name from which the event handler needs to be detached. * @param string $class the fully qualified class name from which the event handler needs to be detached.
* @param string $name the event name. * @param string $name the event name.
* @param callable $handler the event handler to be removed. * @param callable $handler the event handler to be removed.
* If it is null, all handlers attached to the named event will be removed. * If it is `null`, all handlers attached to the named event will be removed.
* @return boolean whether a handler is found and detached. * @return boolean whether a handler is found and detached.
* @see on() * @see on()
*/ */