W3cubDocs

IBehavior

Package	system.base
Inheritance	interface IBehavior
Subclasses	CActiveRecordBehavior, CBehavior, CConsoleCommandBehavior, CModelBehavior, CTimestampBehavior
Source Code	framework/base/interfaces.php

IBehavior interfaces is implemented by all behavior classes.

A behavior is a way to enhance a component with additional methods that are defined in the behavior class and not available in the component class.

Public Methods

Method	Description	Defined By
attach()	Attaches the behavior object to the component.	IBehavior
detach()	Detaches the behavior object from the component.	IBehavior
getEnabled()	Returns whether this behavior is enabled	IBehavior
setEnabled()	Sets whether this behavior is enabled	IBehavior

Method Details

attach() method

abstract public void attach(CComponent $component)
$component	CComponent	the component that this behavior is to be attached to.

Source Code: framework/base/interfaces.php#513 (show)

public function attach($component);

Attaches the behavior object to the component.

detach() method

abstract public void detach(CComponent $component)
$component	CComponent	the component that this behavior is to be detached from.

Source Code: framework/base/interfaces.php#518 (show)

public function detach($component);

Detaches the behavior object from the component.

getEnabled() method

abstract public boolean getEnabled()
{return}	boolean	whether this behavior is enabled

Source Code: framework/base/interfaces.php#522 (show)

public function getEnabled();

setEnabled() method

abstract public void setEnabled(boolean $value)
$value	boolean	whether this behavior is enabled

Source Code: framework/base/interfaces.php#526 (show)

public function setEnabled($value);

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