CApplicationComponent
| Package | system.base |
|---|---|
| Inheritance | abstract class CApplicationComponent » CComponent |
| Implements | IApplicationComponent |
| Subclasses | CAssetManager, CAuthManager, CCache, CClientScript, CDbConnection, CDbFixtureManager, CDbStatePersister, CDummyCache, CErrorHandler, CFormatter, CHttpRequest, CHttpSession, CLogRouter, CMessageSource, CSecurityManager, CStatePersister, CThemeManager, CUrlManager, CViewRenderer, CWebUser, CWidgetFactory |
| Since | 1.0 |
| 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.
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
| Property | Type | Description | Defined By |
|---|---|---|---|
| behaviors | array | the behaviors that should be attached to this component. | CApplicationComponent |
| isInitialized | boolean | Checks if this application component has been initialized. | CApplicationComponent |
Public Methods
| Method | Description | Defined 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 |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getIsInitialized() | Checks if this application component has been initialized. | 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
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()
Checks if this application component has been initialized.
Method Details
getIsInitialized() method
public boolean getIsInitialized() | ||
| {return} | boolean | whether this application component has been initialized (ie, init() is invoked). |
Source Code: framework/base/CApplicationComponent.php#53 (show)
public function getIsInitialized()
{
return $this->_initialized;
}
Checks if this application component has been 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.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CApplicationComponent