PiiModule
| Package | pii.core |
|---|---|
| Inheritance | class PiiModule » CWebModule » CModule » CComponent |
Base module
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| basePath | string | the root directory of the module. | CModule |
| behaviors | array | the behaviors that should be attached to the module. | CModule |
| components | array | the currently loaded components (indexed by their IDs) | CModule |
| controllerMap | array | mapping from controller ID to controller configurations. | CWebModule |
| controllerPath | string | the directory that contains the controller classes. | CWebModule |
| defaultController | string | the ID of the default controller for this module. | CWebModule |
| description | string | Returns the description of this module. | CWebModule |
| id | string | the module ID. | CModule |
| layout | mixed | the layout that is shared by the controllers inside this module. | CWebModule |
| layoutPath | string | the root directory of layout files. | CWebModule |
| modulePath | string | the directory that contains the application modules. | CModule |
| modules | array | the configuration of the currently installed modules (module ID => configuration) | CModule |
| name | string | Returns the name of this module. | CWebModule |
| params | CAttributeCollection | the list of user-defined parameters | CModule |
| parentModule | CModule | the parent module. | CModule |
| preload | array | the IDs of the application components that should be preloaded. | CModule |
| version | string | Returns the version of this module. | CWebModule |
| viewPath | string | the root directory of view files. | CWebModule |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __construct() | Constructor. | CModule |
| __get() | Getter magic method. | CModule |
| __isset() | Checks if a property value is null. | CModule |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| afterControllerAction() | The post-filter for controller actions. | CWebModule |
| 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 |
| beforeControllerAction() | PiiModule | |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| configure() | Configures the module with the specified configuration. | CModule |
| 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 |
| getBasePath() | CModule | |
| getComponent() | Retrieves the named application component. | CModule |
| getComponents() | CModule | |
| getControllerPath() | CWebModule | |
| getDescription() | Returns the description of this module. | CWebModule |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| getId() | CModule | |
| getLayoutPath() | CWebModule | |
| getModule() | Retrieves the named application module. | CModule |
| getModulePath() | CModule | |
| getModules() | CModule | |
| getName() | Returns the name of this module. | CWebModule |
| getParams() | CModule | |
| getParentModule() | CModule | |
| getVersion() | Returns the version of this module. | CWebModule |
| getViewPath() | CWebModule | |
| hasComponent() | CModule | |
| 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() | PiiModule | |
| raiseEvent() | Raises an event. | CComponent |
| setAliases() | Defines the root aliases. | CModule |
| setBasePath() | Sets the root directory of the module. | CModule |
| setComponent() | Puts a component under the management of the module. | CModule |
| setComponents() | Sets the application components. | CModule |
| setControllerPath() | CWebModule | |
| setId() | CModule | |
| setImport() | Sets the aliases that are used in the module. | CModule |
| setLayoutPath() | CWebModule | |
| setModulePath() | CModule | |
| setModules() | Configures the sub-modules of this module. | CModule |
| setParams() | CModule | |
| setViewPath() | CWebModule |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| preinit() | Preinitializes the module. | CModule |
| preloadComponents() | Loads static application components. | CModule |
Method Details
beforeControllerAction()
method
|
public void beforeControllerAction($controller, $action)
| ||
| $controller | ||
| $action | ||
init()
method
|
public void init()
|