PHP Class AuthModule

Author: Fred ([email protected])
Inheritance: extends CWebModule
Mostra file Open project: yinhe/yincart Class Usage Examples

Public Properties

Property Type Description
$appLayout the application layout. Change this if you wish to use a different layout with the module.
$defaultController string the id of the default controller for this module.
$flashKeys map of flash message keys to use for the module.
$forceCopyAssets whether to force copying of assets. Useful during development and when upgrading the module.
$strictMode whether to enable the RBAC strict mode. When enabled items cannot be assigned children of the same type.
$userClass name of the user model class. Change this if your user model name is different than the default value.
$userIdColumn name of the user id column. Change this if the id column in your user table is different than the default value.
$userNameColumn name of the user name column. Change this if the name column in your user table is different than the default value.
$viewDir path to view files for this module. Specify this to use your own views instead of those shipped with the module.

Public Methods

Method Description
beforeControllerAction ( CController $controller, CAction $action ) : boolean The pre-filter for controller actions.
getVersion ( ) : string Returns the module version number.
init ( ) Initializes the module.
registerCss ( ) Registers the module CSS.

Protected Methods

Method Description
getAssetsUrl ( ) : string Returns the URL to the published assets folder.

Method Details

beforeControllerAction() public method

The pre-filter for controller actions.
public beforeControllerAction ( CController $controller, CAction $action ) : boolean
$controller CController the controller.
$action CAction the action.
return boolean whether the action should be executed.

getAssetsUrl() protected method

Returns the URL to the published assets folder.
protected getAssetsUrl ( ) : string
return string the URL.

getVersion() public method

Returns the module version number.
public getVersion ( ) : string
return string the version.

init() public method

Initializes the module.
public init ( )

registerCss() public method

Registers the module CSS.
public registerCss ( )

Property Details

$appLayout public_oe property

the application layout. Change this if you wish to use a different layout with the module.
public $appLayout

$defaultController public_oe property

string the id of the default controller for this module.
public $defaultController

$flashKeys public_oe property

map of flash message keys to use for the module.
public $flashKeys

$forceCopyAssets public_oe property

whether to force copying of assets. Useful during development and when upgrading the module.
public $forceCopyAssets

$strictMode public_oe property

whether to enable the RBAC strict mode. When enabled items cannot be assigned children of the same type.
public $strictMode

$userClass public_oe property

name of the user model class. Change this if your user model name is different than the default value.
public $userClass

$userIdColumn public_oe property

name of the user id column. Change this if the id column in your user table is different than the default value.
public $userIdColumn

$userNameColumn public_oe property

name of the user name column. Change this if the name column in your user table is different than the default value.
public $userNameColumn

$viewDir public_oe property

path to view files for this module. Specify this to use your own views instead of those shipped with the module.
public $viewDir