CWebModule

所有包 | 属性 | 方法

包	system.web
继承	class CWebModule » CModule » CComponent
可用自	1.0.3
版本	$Id$

CWebModule represents an application module.

An application module may be considered as a self-contained sub-application that has its own controllers, models and views and can be reused in a different project as a whole. Controllers inside a module must be accessed with routes that are prefixed with the module ID.

公共属性

隐藏继承的属性

属性	类型	描述	被定义在
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

公共方法

隐藏继承的方法

方法	描述	被定义在
__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()	The pre-filter for controller actions.	CWebModule
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
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

受保护的方法

隐藏继承的方法

方法	描述	被定义在
init()	Initializes the module.	CModule
preinit()	Preinitializes the module.	CModule
preloadComponents()	Loads static application components.	CModule

属性详情

controllerMap 属性

public array $controllerMap;

mapping from controller ID to controller configurations. Pleaser refer to CWebApplication::controllerMap for more details.

controllerPath 属性

public string getControllerPath()
public void setControllerPath(string $value)

the directory that contains the controller classes. Defaults to 'protected/controllers'.

defaultController 属性

public string $defaultController;

the ID of the default controller for this module. Defaults to 'default'.

description 属性只读

public string getDescription()

Returns the description of this module. The default implementation returns an empty string. You may override this method to customize the description of this module.

layout 属性

public mixed $layout;

the layout that is shared by the controllers inside this module. If a controller has explicitly declared its own layout, this property will be ignored. If this is null (default), the application's layout or the parent module's layout (if available) will be used. If this is false, then no layout will be used.

layoutPath 属性

public string getLayoutPath()
public void setLayoutPath(string $path)

the root directory of layout files. Defaults to 'protected/views/layouts'.

name 属性只读

public string getName()

Returns the name of this module. The default implementation simply returns id. You may override this method to customize the name of this module.

version 属性只读

public string getVersion()

Returns the version of this module. The default implementation returns '1.0'. You may override this method to customize the version of this module.

viewPath 属性

public string getViewPath()
public void setViewPath(string $path)

the root directory of view files. Defaults to 'protected/views'.

方法详情

afterControllerAction() 方法（自版本 v1.0.4 可用）

public void afterControllerAction(CController $controller, CAction $action)
$controller	CController	the controller
$action	CAction	the action

The post-filter for controller actions. This method is invoked after the currently requested controller action and all its filters are executed. If you override this method, make sure you call the parent implementation at the end.

beforeControllerAction() 方法（自版本 v1.0.4 可用）

public boolean beforeControllerAction(CController $controller, CAction $action)
$controller	CController	the controller
$action	CAction	the action
{return}	boolean	whether the action should be executed.

The pre-filter for controller actions. This method is invoked before the currently requested controller action and all its filters are executed. You may override this method in the following way:

if(parent::beforeControllerAction($controller,$action))
{
    // your code
    return true;
}
else
    return false;

getControllerPath() 方法

public string getControllerPath()
{return}	string	the directory that contains the controller classes. Defaults to 'protected/controllers'.

getDescription() 方法

public string getDescription()
{return}	string	the description of this module.

Returns the description of this module. The default implementation returns an empty string. You may override this method to customize the description of this module.

getLayoutPath() 方法

public string getLayoutPath()
{return}	string	the root directory of layout files. Defaults to 'protected/views/layouts'.

getName() 方法

public string getName()
{return}	string	the name of this module.

Returns the name of this module. The default implementation simply returns id. You may override this method to customize the name of this module.

getVersion() 方法

public string getVersion()
{return}	string	the version of this module.

Returns the version of this module. The default implementation returns '1.0'. You may override this method to customize the version of this module.

getViewPath() 方法

public string getViewPath()
{return}	string	the root directory of view files. Defaults to 'protected/views'.

setControllerPath() 方法

public void setControllerPath(string $value)
$value	string	the directory that contains the controller classes.

setLayoutPath() 方法

public void setLayoutPath(string $path)
$path	string	the root directory of layout files.

setViewPath() 方法

public void setViewPath(string $path)
$path	string	the root directory of view files.