Docs For Class CMS_moduleCategoriesClearances

Description

Class CMS_moduleCategoriesClearances

editing/viewing permissions for a user profile on moduleCategories

author: Cédric Soret <cedric.soret@ws-interactive.fr>

Located in /automne/classes/user/profilemodulecategoriesclearances.php (line 27)

CMS_grandFather
   |
   --CMS_moduleCategoriesClearances

Method Summary

void __construct ([ $profileID = false], integer $id)

boolean add ( $clearances, CMS_stack $clearances,)

boolean del ( $categoryID, integer $categoryID,)

boolean deleteCategoriesClearances ()

boolean getAdminLevel ( $isAdmin)

CMS_stack getCategoriesClearances ([ $moduleCodename = false], string $moduleCodename,)

string getModuleCodename ()

integer getProfileID ()

boolean setAdminLevel ( $isAdmin, boolean $isAdmin,)

boolean setCategoriesClearances ( $clearances, CMS_stack $clearances,)

boolean setModuleCodename ( $moduleCodename, integer $profileID,)

boolean setProfileID ( $profileID, integer $profileID,)

string toString ()

boolean writeToPersistence ()

Methods

Constructor __construct (line 68)

Constructor.

access: public

void __construct ([ $profileID = false], integer $id)

integer $id: if of user profile
$profileID

add (line 276)

Add category clearances to current stack

return: true on success
access: public

boolean add ( $clearances, CMS_stack $clearances,)

CMS_stack $clearances,: clearances to add
$clearances

del (line 259)

Delete one category clearance

return: true on success
access: public

boolean del ( $categoryID, integer $categoryID,)

integer $categoryID,: ID of category to delete from stack
$categoryID

deleteCategoriesClearances (line 309)

Delete all category clearances for profile

return: true on success
access: public

boolean deleteCategoriesClearances ()

getAdminLevel (line 157)

Get admin level on clearances

access: public

boolean getAdminLevel ( $isAdmin)

$isAdmin

getCategoriesClearances (line 190)

Set module codename

access: public

CMS_stack getCategoriesClearances ([ $moduleCodename = false], string $moduleCodename,)

string $moduleCodename,: the module to get categories related to
$moduleCodename

getModuleCodename (line 167)

Get module codename

access: public

string getModuleCodename ()

getProfileID (line 103)

Get profile user Id

access: public

integer getProfileID ()

setAdminLevel (line 130)

Set admin level on clearances

return: true on success
access: public

boolean setAdminLevel ( $isAdmin, boolean $isAdmin,)

boolean $isAdmin,: clearances are at admin level ?
$isAdmin

setCategoriesClearances (line 242)

Set all category clearances from a stack

return: true on success
access: public

boolean setCategoriesClearances ( $clearances, CMS_stack $clearances,)

CMS_stack $clearances,: stack containing all categories
$clearances

setModuleCodename (line 178)

Set module codename

return: true on success
access: public

boolean setModuleCodename ( $moduleCodename, integer $profileID,)

integer $profileID,: the profile user ID to set
$moduleCodename

setProfileID (line 114)

Set profile user Id

return: true on success
access: public

boolean setProfileID ( $profileID, integer $profileID,)

integer $profileID,: the profile user ID to set
$profileID

toString (line 298)

Get all info in one string

access: public

string toString ()

writeToPersistence (line 336)

Writes these clearances into persistence (MySQL for now).

return: true on success, false on failure
access: public

boolean writeToPersistence ()

Inherited Methods

Inherited From CMS_grandFather

CMS_grandFather::autoload()
CMS_grandFather::hasError()
CMS_grandFather::log()
CMS_grandFather::PHPErrorHandler()
CMS_grandFather::raiseError()
CMS_grandFather::setDebug()
CMS_grandFather::setLog()
CMS_grandFather::_raiseError()
CMS_grandFather::__call()

Class Constants

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL