RightsModule Class Reference

Public Member Functions
	init ()
	registerScripts ()
	getAssetsUrl ()
	getAuthorizer ()
	getInstaller ()
	getGenerator ()
	getVersion ()

Public Attributes
	$superuserName = 'Admin'
	$authenticatedName = 'Authenticated'
	$userClass = 'User'
	$userIdColumn = 'id'
	$userNameColumn = 'username'
	$enableBizRule = true
	$enableBizRuleData = false
	$displayDescription = true
	$flashSuccessKey = 'RightsSuccess'
	$flashErrorKey = 'RightsError'
	$install = false
	$baseUrl = '/rights'
	$layout = 'rights.views.layouts.main'
	$appLayout = 'application.views.layouts.main'
	$cssFile
	$debug = false

Private Attributes
	$_assetsUrl

Detailed Description

Rights module class file.

Author

Christoffer Niska cnisk.nosp@m.a@li.nosp@m.ve.co.nosp@m.m

Copyright

Copyright © 2010 Christoffer Niska

Version

1.3.0

DO NOT CHANGE THE DEFAULT CONFIGURATION VALUES!

You may overload the module configuration values in your rights-module configuration like so:

'modules'=>array( 'rights'=>array( 'userNameColumn'=>'name', 'flashSuccessKey'=>'success', 'flashErrorKey'=>'error', ), ),

Definition at line 23 of file RightsModule.php.

Member Function Documentation

RightsModule::getAssetsUrl

(

)

Publishes the module assets path.

Returns

string the base URL that contains all published asset files of Rights.

Definition at line 172 of file RightsModule.php.

Here is the caller graph for this function:

RightsModule::getAuthorizer

(

)

Returns

RightsAuthorizer the authorizer component.

Definition at line 191 of file RightsModule.php.

RightsModule::getGenerator

(

)

Returns

RightsGenerator the generator component.

Definition at line 207 of file RightsModule.php.

RightsModule::getInstaller

(

)

Returns

RightsInstaller the installer component.

Definition at line 199 of file RightsModule.php.

RightsModule::getVersion

(

)

Returns

the current version.

Definition at line 215 of file RightsModule.php.

RightsModule::init

(

)

Initializes the "rights" module.

Definition at line 96 of file RightsModule.php.

RightsModule::registerScripts

(

)

Registers the necessary scripts.

Definition at line 141 of file RightsModule.php.

Here is the call graph for this function:

Member Data Documentation

RightsModule::$_assetsUrl

private

Definition at line 91 of file RightsModule.php.

RightsModule::$appLayout = 'application.views.layouts.main'

Definition at line 81 of file RightsModule.php.

RightsModule::$authenticatedName = 'Authenticated'

Definition at line 32 of file RightsModule.php.

RightsModule::$baseUrl = '/rights'

Definition at line 73 of file RightsModule.php.

RightsModule::$cssFile

Definition at line 85 of file RightsModule.php.

RightsModule::$debug = false

Definition at line 89 of file RightsModule.php.

RightsModule::$displayDescription = true

Definition at line 57 of file RightsModule.php.

RightsModule::$enableBizRule = true

Definition at line 48 of file RightsModule.php.

RightsModule::$enableBizRuleData = false

Definition at line 52 of file RightsModule.php.

RightsModule::$flashErrorKey = 'RightsError'

Definition at line 65 of file RightsModule.php.

RightsModule::$flashSuccessKey = 'RightsSuccess'

Definition at line 61 of file RightsModule.php.

RightsModule::$install = false

Definition at line 69 of file RightsModule.php.

RightsModule::$layout = 'rights.views.layouts.main'

Definition at line 77 of file RightsModule.php.

RightsModule::$superuserName = 'Admin'

Definition at line 28 of file RightsModule.php.

RightsModule::$userClass = 'User'

Definition at line 36 of file RightsModule.php.

RightsModule::$userIdColumn = 'id'

Definition at line 40 of file RightsModule.php.

RightsModule::$userNameColumn = 'username'

Definition at line 44 of file RightsModule.php.

---

The documentation for this class was generated from the following file:

• app/protected/modules/rights/RightsModule.php