CModule

Property Details

the root directory of the module. Defaults to the directory containing the module class.

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

the currently loaded components (indexed by their IDs)

the module ID.

the directory that contains the application modules. Defaults to the 'modules' subdirectory of basePath.

the configuration of the currently installed modules (module ID => configuration)

the list of user-defined parameters

the parent module. Null if this module does not have a parent.

the IDs of the application components that should be preloaded.

Method Details

Constructor.

Getter magic method. This method is overridden to support accessing application components like reading module properties.

Checks if a property value is null. This method overrides the parent implementation by checking if the named application component is loaded.

Configures the module with the specified configuration.

Retrieves the named application component.

Retrieves the named application module. The module has to be declared in modules. A new instance will be created when calling this method with the given ID for the first time.

Initializes the module. This method is called at the end of the module constructor. Note that at this moment, the module has been configured, the behaviors have been attached and the application components have been registered.

Preinitializes the module. This method is called at the beginning of the module constructor. You may override this method to do some customized preinitialization work. Note that at this moment, the module is not configured yet.

Loads static application components.

array(
   'models'=>'application.models',              // an existing alias
   'extensions'=>'application.extensions',      // an existing alias
   'backend'=>dirname(__FILE__).'/../backend',  // a directory
)

Defines the root aliases.

Sets the root directory of the module. This method can only be invoked at the beginning of the constructor.

Puts a component under the management of the module. The component will be initialized (by calling its init() method if it has not done so.

Sets the application components.

When a configuration is used to specify a component, it should consist of the component's initial property values (name-value pairs). Additionally, a component can be enabled (default) or disabled by specifying the 'enabled' value in the configuration.

If a configuration is specified with an ID that is the same as an existing component or configuration, the existing one will be replaced silently.

The following is the configuration for two components:

array(
    'db'=>array(
        'class'=>'CDbConnection',
        'connectionString'=>'sqlite:path/to/file.db',
    ),
    'cache'=>array(
        'class'=>'CDbCache',
        'connectionID'=>'db',
        'enabled'=>!YII_DEBUG,  // enable caching in non-debug mode
    ),
)

Sets the aliases that are used in the module.

Configures the sub-modules of this module.

Call this method to declare sub-modules and configure them with their initial property values. The parameter should be an array of module configurations. Each array element represents a single module, which can be either a string representing the module ID or an ID-configuration pair representing a module with the specified ID and the initial property values.

For example, the following array declares two modules:

array(
    'admin',                // a single module ID
    'payment'=>array(       // ID-configuration pair
        'server'=>'paymentserver.com',
    ),
)