Class CMS_profile_usersGroup

Login data and functions of user group

• author: Andre Haynes <andre.haynes@ws-interactive.fr> &
• author: Sébastien Pauchet <sebastien.pauchet@ws-interactive.fr>

Located in /automne/classes/user/profileusersgroup.php (line 29)

CMS_grandFather
   |
   --CMS_profile
      |
      --CMS_profile_usersGroup

addToUserAndWriteToPersistence (line 326)

Add group to user and write to persistence immediately The method has to update user's profile and group relationship

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

true addToUserAndWriteToPersistence ( &$user, [ $writeUser = true])

• &$user
• $writeUser

addUser (line 257)

Add User

• access: public

void addUser ( &$user)

• &$user

applyToUsers (line 418)

Apply group profile to all users belonging in this group This method must be as fast as possible

• access: public

void applyToUsers ()

destroy (line 603)

destroys the cmsprofile from persistence (MySQL for now).

• access: public

void destroy ()

---

Redefinition of:

CMS_profile::destroy()

destroys the cmsprofile from persistence (MySQL for now).

getDescription (line 186)

Get Description

• access: public

string getDescription ()

getGroupId (line 148)

Get Id

• access: public

integer getGroupId ()

getJSonDescription (line 703)

void getJSonDescription ( $user,  $cms_language)

• $user
• $cms_language

getLabel (line 159)

Get Label

• access: public

string getLabel ()

getUsers (line 210)

Get Users

• access: public

array(CMS_profileuser) getUsers ([ $returnIDs = false])

• $returnIDs

getUsersRef (line 246)

Get User References

• access: public

array(integer) getUsersRef ()

Constructor __construct (line 87)

Constructor.

Loads all Id variables if

• access: public

void __construct ([integer $id = false])

• integer $id: of profile in DB

---

Redefinition of:

CMS_profile::__construct()

Constructor.

removeToUserAndWriteToPersistence (line 385)

Remove group to user and write to persistence immediately The method has to update user's profile and group relationship

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

true removeToUserAndWriteToPersistence ( &$user)

• &$user

removeUser (line 278)

Remove User

• var: or CMS_profile_user
• access: public

void removeUser ( &$user)

• &$user

setDescription (line 198)

Set Label

• access: public

void setDescription ( $description, string $label)

• string $label
• $description

setLabel (line 171)

Set Label

• access: public

void setLabel (string $label)

• string $label

setUsers (line 233)

Set Users

• access: public

void setUsers (array(int|CMS_profile_user) $users)

• array(int|CMS_profile_user) $users

writeToPersistence (line 642)

Writes the group data into persistence (MySQL for now).

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

boolean writeToPersistence ()

---

Redefinition of:

CMS_profile::writeToPersistence()

Writes the cmsprofile into persistence (MySQL for now).

Inherited Methods

Inherited From CMS_profile

CMS_profile::__construct()
CMS_profile::addAdminClearance()
CMS_profile::addGroup()
CMS_profile::addModuleCategoriesClearancesStack()
CMS_profile::addModuleClearance()
CMS_profile::addModuleClearances()
CMS_profile::addPageClearance()
CMS_profile::addPageClearances()
CMS_profile::addRowGroupsDenied()
CMS_profile::addTemplateGroupsDenied()
CMS_profile::addValidationClearance()
CMS_profile::addValidationClearances()
CMS_profile::deleteCategoriesClearances()
CMS_profile::delModuleClearance()
CMS_profile::delModuleClearances()
CMS_profile::delPageClearance()
CMS_profile::delPageClearances()
CMS_profile::delValidationClearance()
CMS_profile::delValidationClearances()
CMS_profile::destroy()
CMS_profile::filterModuleCategoriesClearance()
CMS_profile::getAdminClearance()
CMS_profile::getAllAdminClearances()
CMS_profile::getAllModuleCategoriesClearances()
CMS_profile::getAllModuleClearances()
CMS_profile::getAllPageClearances()
CMS_profile::getEditablePageClearanceRoots()
CMS_profile::getId()
CMS_profile::getModuleCategoriesClearances()
CMS_profile::getModuleCategoriesClearancesStack()
CMS_profile::getModuleClearances()
CMS_profile::getPageClearanceRoot()
CMS_profile::getPageClearances()
CMS_profile::getRootCategories()
CMS_profile::getRootModuleCategories()
CMS_profile::getRootModuleCategoriesDenied()
CMS_profile::getRootModuleCategoriesManagable()
CMS_profile::getRootModuleCategoriesReadable()
CMS_profile::getRootModuleCategoriesWritable()
CMS_profile::getRowGroupsDenied()
CMS_profile::getTemplateGroupsDenied()
CMS_profile::getValidationClearances()
CMS_profile::getViewablePageClearanceRoots()
CMS_profile::hasAdminAccess()
CMS_profile::hasAdminClearance()
CMS_profile::hasEditableModules()
CMS_profile::hasEditablePages()
CMS_profile::hasModuleCategoryClearance()
CMS_profile::hasModuleClearance()
CMS_profile::hasPageClearance()
CMS_profile::hasRowGroupsDenied()
CMS_profile::hasTemplateGroupsDenied()
CMS_profile::hasValidationClearance()
CMS_profile::hasViewvablePages()
CMS_profile::resetClearances()
CMS_profile::setAdminClearance()
CMS_profile::setModuleCategoriesClearances()
CMS_profile::setModuleCategoriesClearancesStack()
CMS_profile::setModuleClearances()
CMS_profile::setPageClearances()
CMS_profile::setRowGroupsDenied()
CMS_profile::setTemplateGroupsDenied()
CMS_profile::setValidationClearances()
CMS_profile::writeToPersistence()
CMS_profile::_addStackClearances()
CMS_profile::_filterModuleCategoriesClearanceRecursion()
CMS_profile::_hasClearance()

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()

MESSAGE_PAGE_CLICK_TO_VIEW_USER = 1622 (line 33)

MESSAGE_PAGE_NONE = 10 (line 35)

MESSAGE_PAGE_USERS = 926 (line 32)

MESSAGE_PAGE_USERS_GROUP = 1621 (line 31)

MESSAGE_PAGE_USERS_NUMBER = 1623 (line 34)

Inherited Constants

Inherited from CMS_profile

CMS_profile::MESSAGE_ALERT_LEVEL_PAGE_ALERTS
CMS_profile::MESSAGE_ALERT_LEVEL_PAGE_ALERTS_DESCRIPTION
CMS_profile::MESSAGE_ALERT_LEVEL_PROFILE
CMS_profile::MESSAGE_ALERT_LEVEL_PROFILE_DESCRIPTION
CMS_profile::MESSAGE_ALERT_LEVEL_VALIDATION
CMS_profile::MESSAGE_ALERT_LEVEL_VALIDATION_DESCRIPTION
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_DUPLICATE_BRANCH
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_DUPLICATE_BRANCH_DESCRIPTION
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_EDITUSERS
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_EDITUSERS_DESCRIPTION
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_EDITVALIDATEALL
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_EDITVALIDATEALL_DESCRIPTION
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_EDIT_TEMPLATES
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_EDIT_TEMPLATES_DESCRIPTION
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_PAGE_CODENAMES
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_PAGE_CODENAMES_DESCRIPTION
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_REGENERATEPAGES
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_REGENERATEPAGES_DESCRIPTION
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_TEMPLATES
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_TEMPLATES_DESCRIPTION
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_VIEWLOG
CMS_profile::MESSAGE_CLEARANCE_ADMINISTRATION_VIEWLOG_DESCRIPTION
CMS_profile::MESSAGE_CLEARANCE_MODULE_CATEGORIES_EDIT
CMS_profile::MESSAGE_CLEARANCE_MODULE_CATEGORIES_MANAGE
CMS_profile::MESSAGE_CLEARANCE_MODULE_CATEGORIES_NONE
CMS_profile::MESSAGE_CLEARANCE_MODULE_CATEGORIES_VIEW
CMS_profile::MESSAGE_CLEARANCE_MODULE_EDIT
CMS_profile::MESSAGE_CLEARANCE_MODULE_EDIT_DESCRIPTION
CMS_profile::MESSAGE_CLEARANCE_MODULE_NONE
CMS_profile::MESSAGE_CLEARANCE_MODULE_NONE_DESCRIPTION
CMS_profile::MESSAGE_CLEARANCE_MODULE_VIEW
CMS_profile::MESSAGE_CLEARANCE_MODULE_VIEW_DESCRIPTION
CMS_profile::MESSAGE_CLEARANCE_PAGE_EDIT
CMS_profile::MESSAGE_CLEARANCE_PAGE_NONE
CMS_profile::MESSAGE_CLEARANCE_PAGE_VIEW

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL