Spec-Zone.ru › Yii 1.1

CBehavior

Пакет system.base
Наследование класс CBehavior » CComponent
Реализует IBehavior
Подклассы CConsoleCommandBehavior, CModelBehavior
Исходный код framework/base/CBehavior.php
CBehavior — удобный базовый класс для классов поведения.

Общедоступные свойства

Свойство Тип Описание Определено в
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() Объявляет события и соответствующие методы обработчиков событий. CBehavior
getEnabled() Возвращает, включено ли данное поведение CBehavior
getEventHandlers() Возвращает список присоединенных обработчиков событий для события. CComponent
getOwner() Возвращает компонент-владелец, к которому прикреплено данное поведение. CBehavior
hasEvent() Определяет, определено ли событие. CComponent
hasEventHandler() Проверяет, имеет ли указанное событие присоединенные обработчики. CComponent
hasProperty() Определяет, определено ли свойство. CComponent
raiseEvent() Вызывает событие. CComponent
setEnabled() Устанавливает, включено ли данное поведение CBehavior

Подробное описание свойств

enabled свойство

public boolean getEnabled()
public void setEnabled(boolean $value)

включено ли данное поведение

owner свойство только для чтения

public CComponent getOwner()

компонент-владелец, к которому прикреплено данное поведение.

Подробное описание методов

attach() метод

public void attach(CComponent $owner)
$owner CComponent компонент, к которому должно быть присоединено данное поведение.
Исходный код: framework/base/CBehavior.php#47 (показать)
public function attach($owner)
{
    
$this->_enabled=true;
    
$this->_owner=$owner;
    
$this->_attachEventHandlers();
}

Присоединяет объект поведения к компоненту. Стандартная реализация установит свойство owner и присоединит обработчики событий, как объявлено в events. Данный метод также установит enabled в true. Убедитесь, что вы объявили обработчик как public и вызвали родительскую реализацию, если переопределяете этот метод.

detach() метод

public void detach(CComponent $owner)
$owner CComponent компонент, от которого должно быть отсоединено данное поведение.
Исходный код: framework/base/CBehavior.php#62 (показать)
public function detach($owner)
{
    foreach(
$this->events() as $event=>$handler)
        
$owner->detachEventHandler($event,array($this,$handler));
    
$this->_owner=null;
    
$this->_enabled=false;
}

Отсоединяет объект поведения от компонента. Стандартная реализация сбросит свойство owner и отсоединит обработчики событий, объявленные в events. Данный метод также установит enabled в false. Убедитесь, что вы вызвали родительскую реализацию, если переопределяете этот метод.

events() метод

public array events()
{return} array события (ключи массива) и соответствующие методы обработчиков событий (значения массива).
Исходный код: framework/base/CBehavior.php#34 (показать)
public function events()
{
    return array();
}

Объявляет события и соответствующие методы обработчиков событий. События определяются компонентом owner, а методы обработчиков — классом поведения. Обработчики будут присоединены к соответствующим событиям при присоединении поведения к компоненту owner; и они будут отсоединены от событий при отсоединении поведения от компонента. Убедитесь, что вы объявили метод обработчика как public.

getEnabled() метод

public boolean getEnabled()
{return} boolean включено ли данное поведение
Исходный код: framework/base/CBehavior.php#81 (показать)
public function getEnabled()
{
    return 
$this->_enabled;
}

getOwner() метод

public CComponent getOwner()
{return} CComponent компонент-владелец, к которому прикреплён этот бэхевиор.
Исходный код: framework/base/CBehavior.php#73 (показать)
public function getOwner()
{
    return 
$this->_owner;
}

setEnabled() метод

public void setEnabled(boolean $value)
$value boolean включён ли этот бэхевиор
Исходный код: framework/base/CBehavior.php#89 (показать)
public function setEnabled($value)
{
    
$value=(bool)$value;
    if(
$this->_enabled!=$value && $this->_owner)
    {
        if(
$value)
            
$this->_attachEventHandlers();
        else
        {
            foreach(
$this->events() as $event=>$handler)
                
$this->_owner->detachEventHandler($event,array($this,$handler));
        }
    }
    
$this->_enabled=$value;
}

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CBehavior

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API