CConsoleCommandEvent
| Пакет | system.console |
|---|---|
| Наследование | class CConsoleCommandEvent » CEvent » CComponent |
| С момента | 1.1.11 |
| Исходный код | framework/console/CConsoleCommandEvent.php |
Класс CConsoleCommandEvent.
CConsoleCommandEvent представляет параметры события, необходимые для событий, вызываемых консольной командой.
CConsoleCommandEvent представляет параметры события, необходимые для событий, вызываемых консольной командой.
Общественные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| action | string | имя действия | CConsoleCommandEvent |
| exitCode | integer | код завершения приложения. | CConsoleCommandEvent |
| handled | boolean | обработан ли событие. | CEvent |
| params | mixed | дополнительные параметры события. | CEvent |
| sender | object | отправитель этого события | CEvent |
| stopCommand | boolean | должно ли выполняться действие. | CConsoleCommandEvent |
Общественные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | CComponent |
| __construct() | Конструктор. | CConsoleCommandEvent |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение на основе его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства нулевым. | 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 |
Подробности свойств
action свойство
public string $action;
имя действия
exitCode свойство
public integer $exitCode;
код завершения приложения. Это свойство доступно в событии CConsoleCommand::onAfterAction и будет установлено в код завершения, возвращенный действием консольной команды. Вы можете установить его, чтобы изменить код завершения приложения.
stopCommand свойство
public boolean $stopCommand;
должно ли выполняться действие. Если это свойство установлено в true обработчиком события, действие консольной команды завершится после обработки этого события. Если false, что является значением по умолчанию, циклы нормального выполнения продолжатся, включая выполнение действия и вызов CConsoleCommand::afterAction.
Подробности методов
__construct() метод
public void __construct(mixed $sender=NULL, string $params=NULL, string $action=NULL, integer $exitCode=0) | ||
| $sender | mixed | отправитель события |
| $params | string | параметры, которые должны быть переданы методу действия. |
| $action | string | имя действия |
| $exitCode | integer | код завершения приложения |
Исходный код: framework/console/CConsoleCommandEvent.php#47 (показать)
public function __construct($sender=null,$params=null,$action=null,$exitCode=0){
parent::__construct($sender,$params);
$this->action=$action;
$this->exitCode=$exitCode;
}
Конструктор.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CConsoleCommandEvent
