CBehavior

Property Details

enabled property

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

whether this behavior is enabled

owner property read-only

public CComponent getOwner()

the owner component that this behavior is attached to.

Method Details

attach() method

public void attach(CComponent $owner)

public function attach($owner)
{
    $this->_enabled=true;
    $this->_owner=$owner;
    $this->_attachEventHandlers();
}

Attaches the behavior object to the component. The default implementation will set the owner property and attach event handlers as declared in events. This method will also set enabled to true. Make sure you've declared handler as public and call the parent implementation if you override this method.

detach() method

public void detach(CComponent $owner)

public function detach($owner)
{
    foreach($this->events() as $event=>$handler)
        $owner->detachEventHandler($event,array($this,$handler));
    $this->_owner=null;
    $this->_enabled=false;
}

Detaches the behavior object from the component. The default implementation will unset the owner property and detach event handlers declared in events. This method will also set enabled to false. Make sure you call the parent implementation if you override this method.

events() method

public array events()

public function events()
{
    return array();
}

Declares events and the corresponding event handler methods. The events are defined by the owner component, while the handler methods by the behavior class. The handlers will be attached to the corresponding events when the behavior is attached to the owner component; and they will be detached from the events when the behavior is detached from the component. Make sure you've declared handler method as public.

getEnabled() method

public boolean getEnabled()

public function getEnabled()
{
    return $this->_enabled;
}

getOwner() method

public CComponent getOwner()

public function getOwner()
{
    return $this->_owner;
}

setEnabled() method

public void setEnabled(boolean $value)

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;
}