CConsoleCommandBehavior
| Пакет | system.console |
|---|---|
| Наследование | класс CConsoleCommandBehavior » CBehavior » CComponent |
| Реализует | IBehavior |
| С | 1.1.11 |
| Исходный код | framework/console/CConsoleCommandBehavior.php |
CConsoleCommandBehavior — базовый класс для поведений, прикрепленных к компоненту консольной команды.
Общественные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| enabled | boolean | включено ли данное поведение | CBehavior |
| owner | CComponent | компонент-владелец, к которому прикреплено данное поведение. | CBehavior |
Общественные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод, который не является методом класса. | CComponent |
| __get() | Возвращает значение свойства, список обработчиков событий или поведение по его имени. | CComponent |
| __isset() | Проверяет, является ли значение свойства null. | CComponent |
| __set() | Устанавливает значение свойства компонента. | CComponent |
| __unset() | Устанавливает свойство компонента в null. | CComponent |
| asa() | Возвращает объект поведения с указанным именем. | CComponent |
| attach() | Прикрепляет объект поведения к компоненту. | CBehavior |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | CComponent |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | CComponent |
| attachEventHandler() | Прикрепляет обработчик события к событию. | CComponent |
| canGetProperty() | Определяет, можно ли считать свойство. | CComponent |
| canSetProperty() | Определяет, можно ли установить свойство. | CComponent |
| detach() | Открепляет объект поведения от компонента. | CBehavior |
| detachBehavior() | Открепляет поведение от компонента. | CComponent |
| detachBehaviors() | Открепляет все поведения от компонента. | CComponent |
| detachEventHandler() | Открепляет существующий обработчик события. | CComponent |
| disableBehavior() | Отключает присоединённое поведение. | CComponent |
| disableBehaviors() | Отключает все присоединённые к этому компоненту поведения. | CComponent |
| enableBehavior() | Включает присоединённое поведение. | CComponent |
| enableBehaviors() | Включает все присоединённые к этому компоненту поведения. | CComponent |
| evaluateExpression() | Вычисляет PHP-выражение или обратный вызов в контексте этого компонента. | CComponent |
| events() | Объявляет события и соответствующие методы обработчиков событий. | CConsoleCommandBehavior |
| getEnabled() | Возвращает, включено ли это поведение. | CBehavior |
| getEventHandlers() | Возвращает список присоединенных обработчиков событий для события. | CComponent |
| getOwner() | Возвращает компонент-владелец, к которому прикреплено данное поведение. | CBehavior |
| hasEvent() | Определяет, определено ли событие. | CComponent |
| hasEventHandler() | Проверяет, есть ли прикрепленные обработчики для указанного события. | CComponent |
| hasProperty() | Определяет, определено ли свойство. | CComponent |
| raiseEvent() | Вызывает событие. | CComponent |
| setEnabled() | Устанавливает, включено ли это поведение. | CBehavior |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| afterAction() | Реагирует на событие CConsoleCommand::onAfterAction. | CConsoleCommandBehavior |
| beforeAction() | Реагирует на событие CConsoleCommand::onBeforeAction. | CConsoleCommandBehavior |
Подробное описание метода
afterAction() метод
protected void afterAction(CConsoleCommandEvent $event) | ||
| $event | CConsoleCommandEvent | параметр события |
Исходный код: framework/console/CConsoleCommandBehavior.php#50 (показать)
protected function afterAction($event)
{
}
Реагирует на событие CConsoleCommand::onAfterAction. Переопределите этот метод и сделайте его общедоступным, если вы хотите обработать соответствующее событие владельца.
beforeAction() метод
protected void beforeAction(CConsoleCommandEvent $event) | ||
| $event | CConsoleCommandEvent | параметр события |
Исходный код: framework/console/CConsoleCommandBehavior.php#41 (показать)
protected function beforeAction($event)
{
}
Реагирует на событие CConsoleCommand::onBeforeAction. Переопределите этот метод и сделайте его общедоступным, если вы хотите обработать соответствующее событие владельца.
events() метод
public array events() | ||
| {return} | массив | события (ключи массива) и соответствующие методы обработчиков событий (значения массива). |
Исходный код: framework/console/CConsoleCommandBehavior.php#29 (показать)
public function events()
{
return array(
'onBeforeAction' => 'beforeAction',
'onAfterAction' => 'afterAction'
);
}
Объявляет события и соответствующие методы обработчиков событий. По умолчанию возвращает события 'onAfterConstruct', 'onBeforeValidate' и 'onAfterValidate' и соответствующие обработчики. Если вы переопределяете этот метод, убедитесь, что вы объединяете родительский результат со значением возврата.
См. также
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CConsoleCommandBehavior
