Browse Source

Merge pull request #1769 from crtlib/patch-3

Redundant event's instanceof check and some docs punctuation
tags/2.0.0-beta
Carsten Brandt 11 years ago
parent
commit
8d2ce64787
  1. 22
      framework/yii/base/Event.php

22
framework/yii/base/Event.php

@ -67,9 +67,9 @@ class Event extends Object
* *
* For more details about how to declare an event handler, please refer to [[Component::on()]]. * 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 $class the fully qualified class name to which the event handler needs to attach.
* @param string $name the event name * @param string $name the event name.
* @param callback $handler the event handler * @param callback $handler the event handler.
* @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]].
* @see off() * @see off()
@ -84,11 +84,11 @@ class Event extends Object
* *
* This method is the opposite of [[on()]]. * 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 $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 callback $handler the event handler to be removed. * @param callback $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 if a handler is found and detached * @return boolean if a handler is found and detached.
* @see on() * @see on()
*/ */
public static function off($class, $name, $handler = null) public static function off($class, $name, $handler = null)
@ -119,8 +119,8 @@ class Event extends Object
* Returns a value indicating whether there is any handler attached to the specified class-level event. * 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 * Note that this method will also check all parent classes to see if there is any handler attached
* to the named event. * to the named event.
* @param string|object $class the object or the fully qualified class name specifying the class-level event * @param string|object $class the object or the fully qualified class name specifying the class-level event.
* @param string $name the event name * @param string $name the event name.
* @return boolean whether there is any handler attached to the event. * @return boolean whether there is any handler attached to the event.
*/ */
public static function hasHandlers($class, $name) public static function hasHandlers($class, $name)
@ -145,8 +145,8 @@ class Event extends Object
* Triggers a class-level event. * Triggers a class-level event.
* This method will cause invocation of event handlers that are attached to the named 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. * 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|object $class the object or the fully qualified class name specifying the class-level event.
* @param string $name the event name * @param string $name the event name.
* @param Event $event the event parameter. If not set, a default [[Event]] object will be created. * @param Event $event the event parameter. If not set, a default [[Event]] object will be created.
*/ */
public static function trigger($class, $name, $event = null) public static function trigger($class, $name, $event = null)
@ -173,7 +173,7 @@ class Event extends Object
foreach (self::$_events[$name][$class] as $handler) { foreach (self::$_events[$name][$class] as $handler) {
$event->data = $handler[1]; $event->data = $handler[1];
call_user_func($handler[0], $event); call_user_func($handler[0], $event);
if ($event instanceof Event && $event->handled) { if ($event->handled) {
return; return;
} }
} }

Loading…
Cancel
Save