CComponent

$a=$component->text;     // equivalent to $a=$component->getText();
$component->text='abc';  // equivalent to $component->setText('abc');

// getter, defines a readable property 'text'
public function getText() { ... }
// setter, defines a writable property 'text' with $value to be set to the property
public function setText($value) { ... }

function eventHandler($event) { ... }

$component->onClick=$callback;    // or $component->onClick->add($callback);

'handleOnClick'                   // handleOnClick() is a global function
array($object,'handleOnClick')    // using $object->handleOnClick()
array('Page','handleOnClick')     // using Page::handleOnClick()

public function onClick($event)
{
    $this->raiseEvent('onClick',$event);
}

Method Details

Calls the named method which is not a class method. Do not call this method. This is a PHP magic method that we override to implement the behavior feature.

Returns a property value, an event handler list or a behavior based on its name. Do not call this method. This is a PHP magic method that we override to allow using the following syntax to read a property or obtain event handlers:

$value=$component->propertyName;
$handlers=$component->eventName;

Checks if a property value is null. Do not call this method. This is a PHP magic method that we override to allow using isset() to detect if a component property is set or not.

Sets value of a component property. Do not call this method. This is a PHP magic method that we override to allow using the following syntax to set a property or attach an event handler

$this->propertyName=$value;
$this->eventName=$callback;

Sets a component property to be null. Do not call this method. This is a PHP magic method that we override to allow using unset() to set a component property to be null.

Returns the named behavior object. The name 'asa' stands for 'as a'.

Attaches a behavior to this component. This method will create the behavior object based on the given configuration. After that, the behavior object will be initialized by calling its IBehavior::attach method.

Attaches a list of behaviors to the component. Each behavior is indexed by its name and should be an instance of IBehavior, a string specifying the behavior class, or an array of the following structure:

array(
    'class'=>'path.to.BehaviorClass',
    'property1'=>'value1',
    'property2'=>'value2',
)

Attaches an event handler to an event.

An event handler must be a valid PHP callback, i.e., a string referring to a global function name, or an array containing two elements with the first element being an object and the second element a method name of the object.

An event handler must be defined with the following signature,

function handlerName($event) {}

$component->getEventHandlers($eventName)->add($eventHandler);

$component->getEventHandlers($eventName)->insertAt(0,$eventHandler);

Determines whether a property can be read. A property can be read if the class has a getter method for the property name. Note, property name is case-insensitive.

Determines whether a property can be set. A property can be written if the class has a setter method for the property name. Note, property name is case-insensitive.

Detaches a behavior from the component. The behavior's IBehavior::detach method will be invoked.

Detaches all behaviors from the component.

Detaches an existing event handler. This method is the opposite of attachEventHandler.

Disables an attached behavior. A behavior is only effective when it is enabled.

Disables all behaviors attached to this component.

Enables an attached behavior. A behavior is only effective when it is enabled. A behavior is enabled when first attached.

Enables all behaviors attached to this component.

Returns the list of attached event handlers for an event.

Determines whether an event is defined. An event is defined if the class has a method named like 'onXXX'. Note, event name is case-insensitive.

Checks whether the named event has attached handlers.

Determines whether a property is defined. A property is defined if there is a getter or setter method defined in the class. Note, property names are case-insensitive.

Raises an event. This method represents the happening of an event. It invokes all attached handlers for the event.