Class CMS_profile_user

Login data and functions of user

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

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

CMS_grandFather
   |
   --CMS_profile
      |
      --CMS_profile_user

Constructor __construct (line 144)

Constructor.

Loads all Id variables if

• access: public

void __construct ([integer $id = false])

• integer $id: id of profile in DB

---

Redefinition of:

CMS_profile::__construct()

Constructor.

addValidationClearance (line 546)

Add Validation Clearance Overwrite super class function to update validation catalog

• access: public

boolean addValidationClearance ( $moduleName, integer $moduleid)

• integer $moduleid
• $moduleName

---

Redefinition of:

CMS_profile::addValidationClearance()

Add Validation Clearance

checkLogin (line 322)

Check if the login is valid

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

boolean checkLogin (string $login)

• string $login

delValidationClearance (line 569)

Del Validation Clearance Overwrite super class function to update validation catalog

• access: public

void delValidationClearance ( $moduleId)

• $moduleId

---

Redefinition of:

CMS_profile::delValidationClearance()

Del Validation Clearance

delValidationClearances (line 587)

Del Validation Clearances Overwrite super class function to update validation catalog

• access: public

void delValidationClearances ()

---

Redefinition of:

CMS_profile::delValidationClearances()

Del Validation Clearances

getContactData (line 455)

Get Contact Data

• access: public

CMS_contactData getContactData ()

getEmail (line 485)

Get Contact Data part : the email (often used)

• return: The email
• access: public

string getEmail ()

getFavorites (line 300)

Get pages favorites for user

• access: public

array(pageIds) getFavorites ()

getFirstName (line 407)

Get First Name

• access: public

string getFirstName ()

getFullName (line 394)

Get user fullname (firstname then last name)

• access: public

string getFullName ()

getJSonDescription (line 960)

void getJSonDescription ( $user,  $cms_language)

• $user
• $cms_language

getLanguage (line 497)

Get Language

• access: public

CMS_language getLanguage ()

getLanguageCode (line 509)

Get Language

• access: public

CMS_language getLanguageCode ()

getLastName (line 431)

Get Last Name

• access: public

string getLastName ()

getLogin (line 310)

Get Login

• access: public

string getLogin ()

getPassword (line 372)

Get Password

• return: The SHA1 user password
• access: public

string getPassword ()

getUserId (line 203)

Get Id

• access: public

integer getUserId ()

getValue (line 625)

Short hand to get values by property name

• return: See functions for more details
• access: public

mixed getValue (string $property)

• string $property: The name of the property

hasAlertLevel (line 926)

Does user has the queried alert level set

• access: public

void hasAlertLevel (integer $level, string $module)

• integer $level: : the level needed
• string $module: : module codename to check

hasGroup (line 913)

Checks if the user is in a given group

• return: true if the user is in the group. false otherwise

boolean hasGroup ( $groupId, integer $group_id)

• integer $group_id
• $groupId

havePassword (line 383)

have Password

• access: public

void havePassword ()

isActive (line 214)

Is the user active ?

• access: public

string isActive ()

isDeleted (line 225)

Is the user deleted ?

• access: public

string isDeleted ()

isFavorite (line 265)

Is page a favorite for user ?

• access: public

boolean isFavorite ( $pageId, integer $pageId,)

• integer $pageId,: the pageId to check page favorite status
• $pageId

resetAlertLevel (line 954)

Reset Alert Level

• access: public

true resetAlertLevel ()

setActive (line 237)

Set The active flag

• access: public

boolean setActive (boolean $active)

• boolean $active

setAlertLevel (line 942)

Sets Alert Level

• access: public

true setAlertLevel (integer $level, string $module)

• string $module: : module codename to set
• integer $level: : the level to set

setContactData (line 467)

Set Contact Data

• access: public

boolean setContactData (CMS_contactData $contactData)

• CMS_contactData $contactData

setDeleted (line 252)

Set The deleted flag Sets the login to nothing, so this login could be reused in the future

• access: public

boolean setDeleted ( $deleted, boolean $active)

• boolean $active
• $deleted

setFavorite (line 277)

Set page a favorite status for user

• access: public

boolean setFavorite ( $status,  $pageId, boolean $status,, integer $pageId,)

• boolean $status,: the page favorite status
• integer $pageId,: the pageId to set favorite status
• $status
• $pageId

setFirstName (line 419)

Set First Name

• access: public

boolean setFirstName (string $firstName)

• string $firstName

setLanguage (line 521)

Set language

• access: public

boolean setLanguage (CMS_language $language)

• CMS_language $language

setLastName (line 443)

Set Last Name

• access: public

boolean setLastName (string $lastName)

• string $lastName

setLogin (line 333)

Set Login

• access: public

void setLogin (string $login)

• string $login

setPassword (line 356)

Set Password

• access: public

boolean setPassword (string $password, [boolean $encode = true])

• string $password
• boolean $encode: : encode the setted password using sha1 hash function

setSoapValues (line 685)

Set user by xml definition. Return XML

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

boolean setSoapValues ( $domdocument, string $xmlInput)

• string $xmlInput: XML definition to define user properties
• $domdocument

setValidationClearances (line 606)

Sets Validation Clearances Overwrite super class function to update validation catalog

• access: public

boolean setValidationClearances (CMS_stack $validationClearances)

• CMS_stack $validationClearances

---

Redefinition of:

CMS_profile::setValidationClearances()

Sets Validation Clearances

setValue (line 664)

Short hand to set values by property name

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

boolean setValue (string $property, string $value)

• string $property: The name of the property
• string $value: The value to set

writeProfileToPersistence (line 904)

Writes the profile Data into persistence (MySQL for now).

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

boolean writeProfileToPersistence ()

writeToPersistence (line 804)

Writes the user 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 31)

MESSAGE_PAGE_EMAIL = 102 (line 36)

MESSAGE_PAGE_FIRSTNAME = 93 (line 35)

MESSAGE_PAGE_GROUPS = 837 (line 38)

MESSAGE_PAGE_NAME = 94 (line 34)

MESSAGE_PAGE_NONE = 10 (line 32)

MESSAGE_PAGE_USER = 908 (line 33)

MESSAGE_PAGE_WRITE_TO = 1624 (line 37)

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