Свойство | Тип | Описание | |
---|---|---|---|
$data | 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. | ||
$handled | 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. | ||
$name | the event name. This property is set by [[Component::trigger()]] and Event::trigger. Event handlers may use this property to check what event it is handling. | ||
$sender | 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. |
Метод | Описание | |
---|---|---|
hasHandlers ( string | object $class, string $name ) : boolean | Returns a value indicating whether there is any handler attached to the specified class-level event. | |
off ( string $class, string $name, callable $handler = null ) : boolean | Detaches an event handler from a class-level event. | |
offAll ( ) | Detaches all registered class-level event handlers. | |
on ( string $class, string $name, callable $handler, mixed $data = null, boolean $append = true ) | Attaches an event handler to a class-level event. | |
trigger ( string | object $class, string $name, |
Triggers a class-level event. |
public static off ( string $class, string $name, callable $handler = null ) : boolean | ||
$class | string | the fully qualified class name from which the event handler needs to be detached. |
$name | string | the event name. |
$handler | callable | the event handler to be removed. If it is `null`, all handlers attached to the named event will be removed. |
Результат | boolean | whether a handler is found and detached. |
public static offAll ( ) |
public static on ( string $class, string $name, callable $handler, mixed $data = null, boolean $append = true ) | ||
$class | string | the fully qualified class name to which the event handler needs to attach. |
$name | string | the event name. |
$handler | callable | the event handler. |
$data | mixed | 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]]. |
$append | boolean | 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. |
public static trigger ( string | object $class, string $name, |
||
$class | string | object | the object or the fully qualified class name specifying the class-level event. |
$name | string | the event name. |
$event | the event parameter. If not set, a default [[Event]] object will be created. |
public $data |
public $handled |
public $name |