0 follower

CApplicationComponent

Package system.base
Inheritance abstract class CApplicationComponent » CComponent
Implements IApplicationComponent
Subclasses CAssetManager, CAuthManager, CCache, CClientScript, CDbConnection, CDummyCache, CErrorHandler, CHttpRequest, CHttpSession, CLogRouter, CMessageSource, CSecurityManager, CStatePersister, CThemeManager, CUrlManager, CViewRenderer, CWebUser
Since 1.0
Version $Id$
Source Code framework/base/CApplicationComponent.php
CApplicationComponent is the base class for application component classes.

CApplicationComponent implements the basic methods required by IApplicationComponent.

When developing an application component, try to put application component initialization code in the init() method instead of the constructor. This has the advantage that the application component can be customized through application configuration.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
behaviors array the behaviors that should be attached to this component. CApplicationComponent
isInitialized boolean whether this application component has been initialized (i.e., init() is invoked. CApplicationComponent

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. CComponent
__get() Returns a property value, an event handler list or a behavior based on its name. CComponent
__isset() Checks if a property value is null. CComponent
__set() Sets value of a component property. CComponent
__unset() Sets a component property to be null. CComponent
asa() Returns the named behavior object. CComponent
attachBehavior() Attaches a behavior to this component. CComponent
attachBehaviors() Attaches a list of behaviors to the component. CComponent
attachEventHandler() Attaches an event handler to an event. CComponent
canGetProperty() Determines whether a property can be read. CComponent
canSetProperty() Determines whether a property can be set. CComponent
detachBehavior() Detaches a behavior from the component. CComponent
detachBehaviors() Detaches all behaviors from the component. CComponent
detachEventHandler() Detaches an existing event handler. CComponent
disableBehavior() Disables an attached behavior. CComponent
disableBehaviors() Disables all behaviors attached to this component. CComponent
enableBehavior() Enables an attached behavior. CComponent
enableBehaviors() Enables all behaviors attached to this component. CComponent
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
getIsInitialized() Checks whether this application component has been initialized (i.e., init() is invoked.) CApplicationComponent
hasEvent() Determines whether an event is defined. CComponent
hasEventHandler() Checks whether the named event has attached handlers. CComponent
hasProperty() Determines whether a property is defined. CComponent
init() Initializes the application component. CApplicationComponent
raiseEvent() Raises an event. CComponent

Property Details

behaviors property (available since v1.0.2)
public array $behaviors;

the behaviors that should be attached to this component. The behaviors will be attached to the component when init is called. Please refer to CModel::behaviors on how to specify the value of this property.

isInitialized property read-only
public boolean getIsInitialized()

whether this application component has been initialized (i.e., init() is invoked.)

Method Details

getIsInitialized() method
public boolean getIsInitialized()
{return} boolean whether this application component has been initialized (i.e., init() is invoked.)
Source Code: framework/base/CApplicationComponent.php#52 (show)
public function getIsInitialized()
{
    return $this->_initialized;
}

init() method
public void init()
Source Code: framework/base/CApplicationComponent.php#43 (show)
public function init()
{
    $this->attachBehaviors($this->behaviors);
    $this->_initialized=true;
}

Initializes the application component. This method is required by IApplicationComponent and is invoked by application. If you override this method, make sure to call the parent implementation so that the application component can be marked as initialized.