CEvent
| Пакет | system.base |
|---|---|
| Наследование | класс CEvent » CComponent |
| Подклассы | CConsoleCommandEvent, CErrorEvent, CExceptionEvent, CMissingTranslationEvent, CModelEvent, COutputEvent |
| С момента | 1.0 |
| Исходный код | framework/base/CComponent.php |
CEvent — базовый класс для всех классов событий.
Он инкапсулирует параметры, связанные с событием. Свойство sender описывает, кто вызывает событие. А свойство handled указывает, обработано ли событие. Если обработчик событий устанавливает handled в true, другие обработчики, которые ещё не вызваны, больше не будут вызываться.
Он инкапсулирует параметры, связанные с событием. Свойство sender описывает, кто вызывает событие. А свойство handled указывает, обработано ли событие. Если обработчик событий устанавливает handled в true, другие обработчики, которые ещё не вызваны, больше не будут вызываться.
Общественные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| handled | boolean | обработано ли событие. | CEvent |
| params | mixed | дополнительные параметры события. | CEvent |
| sender | object | отправитель этого события | CEvent |
Общественные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | CComponent |
| __construct() | Конструктор. | CEvent |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства null. | CComponent |
| __set() | Устанавливает значение свойства компонента. | CComponent |
| __unset() | Устанавливает свойство компонента в null. | CComponent |
| asa() | Возвращает объект поведения с заданным именем. | CComponent |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | CComponent |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | CComponent |
| attachEventHandler() | Прикрепляет обработчик событий к событию. | CComponent |
| canGetProperty() | Определяет, можно ли прочитать свойство. | CComponent |
| canSetProperty() | Определяет, можно ли установить свойство. | CComponent |
| detachBehavior() | Отсоединяет поведение от компонента. | CComponent |
| detachBehaviors() | Отсоединяет все поведения от компонента. | CComponent |
| detachEventHandler() | Отсоединяет существующий обработчик событий. | CComponent |
| disableBehavior() | Отключает присоединённое поведение. | CComponent |
| disableBehaviors() | Отключает все присоединённые к этому компоненту поведения. | CComponent |
| enableBehavior() | Включает присоединённое поведение. | CComponent |
| enableBehaviors() | Включает все присоединённые к этому компоненту поведения. | CComponent |
| evaluateExpression() | Вычисляет PHP-выражение или обратный вызов в контексте этого компонента. | CComponent |
| getEventHandlers() | Возвращает список прикреплённых обработчиков событий для события. | CComponent |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, есть ли прикреплённые обработчики для данного события. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| raiseEvent() | Вызывает событие. | CComponent |
Подробное описание свойств
handled свойство
public boolean $handled;
обработано ли событие. По умолчанию false. Когда обработчик устанавливает это значение в true, остальные невызванные обработчики событий больше не будут вызываться.
params свойство (доступно с версии 1.1.7)
public mixed $params;
дополнительные параметры события.
sender свойство
public object $sender;
отправитель этого события
Подробное описание методов
__construct() метод
public void __construct(mixed $sender=NULL, mixed $params=NULL) | ||
| $sender | mixed | отправитель события |
| $params | mixed | дополнительные параметры события |
Исходный код: framework/base/CComponent.php#665 (показать)
public function __construct($sender=null,$params=null)
{
$this->sender=$sender;
$this->params=$params;
}
Конструктор.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CEvent
