Class CMS_profile_usersCatalog

Description
Description | Methods (details) Constants

Class CMS_profile_usersCatalog

Manages the collection of users profiles.

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

CMS_grandFather
   |
   --CMS_profile_usersCatalog
Method Summary
Description | Constants Methods (details)
static Boolean denyRowGroupsToUsers (array $groups)
static Boolean denyTemplateGroupsToUsers (array $groups)
static array(CMS_profile_user) getAll ([boolean $activeOnly = false], [boolean $withDeleted = false], [boolean $returnObjects = true], [array $attrs = array()])
static CMS_profile_user getByID (integer $id, [boolean $reset = false])
static CMS_profile_user getByLogin (string $login, [boolean $reset = false])
static array(string) getLettersForLastName ()
static array(id getUsersLabels ([ $activeOnly = false], [ $lastNameFirst = false])
static CMS_profile_user getUserValue (mixed $id, string $type, [integer $currentUserId = null])
static array(CMS_profile_user) getValidators (string $moduleCodename)
static CMS_profile_user hasPageViewClearance ( &$cms_user, integer $pageID, CMS_profile_user $user)
static boolean loginExists (string $login, [CMS_profile_user $user = false], [boolean $returnProfileUserId = false])
static array(CMS_profile_user) search ([string $search = ''], [string $letter = ''], [integer $group = ''], [string $order = ''], [integer $direction = 'asc'], [integer $start = 0], [boolean $limit = 0], [boolean $activeOnly = false], [ $returnObjects = true], [ &$score = array()])
static string soapGetUser ([integer $userId = 0])
static string soapSearch ([string $searchConditions = ''])
Methods
Description | Constants Methods (details)
static denyRowGroupsToUsers (line 633)

Deny all given rows groups to all users

  • access: public
static Boolean denyRowGroupsToUsers (array $groups)
  • array $groups: : the groups name to deny
static denyTemplateGroupsToUsers (line 666)

Deny all given templates groups to all users

  • access: public
static Boolean denyTemplateGroupsToUsers (array $groups)
  • array $groups: : the groups name to deny
static getAll (line 147)

Returns all the profile users, sorted by last name + first name.

Static function.

  • access: public
static array(CMS_profile_user) getAll ([boolean $activeOnly = false], [boolean $withDeleted = false], [boolean $returnObjects = true], [array $attrs = array()])
  • boolean $activeOnly: activeOnly : return only active users (default : false)
  • boolean $withDeleted: withDeleted : return deleted users also (default false)
  • boolean $returnObjects: returnObjects : return CMS_profile_user objects (default) or array of userId
  • array $attrs: attrs : filter for search : array($attrName => $attrValue)
static getByID (line 41)

Returns a CMS_profile_user when given an ID Static function.

  • return: or false on failure to find it
  • access: public
static CMS_profile_user getByID (integer $id, [boolean $reset = false])
  • integer $id: The DB ID of the wanted CMS_profile_user
  • boolean $reset: : Reset the local cache (force to reload user from DB)
static getByLogin (line 62)

Returns an active CMS_profile_user with a given user login Static function.

  • return: or false on failure to find it
  • access: public
static CMS_profile_user getByLogin (string $login, [boolean $reset = false])
  • string $login: The user login of the wanted CMS_profile_user
  • boolean $reset: : Reset the local cache (force to reload user from DB)
static getLettersForLastName (line 601)

Get all the letters that have a least one user with a lastname beginning with Static function.

  • access: public
static array(string) getLettersForLastName ()
static getUsersLabels (line 469)

Get all users labels

  • return: => firstname lastname) users label
  • access: public
static array(id getUsersLabels ([ $activeOnly = false], [ $lastNameFirst = false])
  • $activeOnly
  • $lastNameFirst
static getUserValue (line 99)

Returns a queried CMS_profile_user value Static function.

  • return: value or false on failure to find it
  • access: public
static CMS_profile_user getUserValue (mixed $id, string $type, [integer $currentUserId = null])
  • mixed $id: The DB ID of the wanted CMS_profile_user or "self" to get info from the user passed in third parameter
  • string $type: The value type to get
  • integer $currentUserId: The user Id to get the value if first parameter is "self"
static getValidators (line 509)

Returns all the validators.

Static function.

  • access: public
static array(CMS_profile_user) getValidators (string $moduleCodename)
  • string $moduleCodename: The codename of the module to validate
static hasPageViewClearance (line 127)

Has a user the right to view a page biven by its ID ? Static function.

  • return: or false on failure to find it
  • access: public
static CMS_profile_user hasPageViewClearance ( &$cms_user, integer $pageID, CMS_profile_user $user)
  • CMS_profile_user $user: The user viewing the page
  • integer $pageID: The DB ID of the page
  • &$cms_user
static loginExists (line 573)

Checks all the profile users, except $user to see if login doesnt exist.

Static function.

  • access: public
static boolean loginExists (string $login, [CMS_profile_user $user = false], [boolean $returnProfileUserId = false])
  • CMS_profile_user $user
  • string $login
  • boolean $returnProfileUserId: : if true, return the user ID
static search (line 333)

Search users Static function.

  • access: public
static array(CMS_profile_user) search ([string $search = ''], [string $letter = ''], [integer $group = ''], [string $order = ''], [integer $direction = 'asc'], [integer $start = 0], [boolean $limit = 0], [boolean $activeOnly = false], [ $returnObjects = true], [ &$score = array()])
  • string $search: search : search user by lastname, firstname or login
  • string $letter: letter : search user by first lastname letter
  • integer $group: group : search user by group ID
  • string $order: order : order by fieldname (without suffix). default : lastname, firstname
  • integer $direction: start : search start offset
  • integer $start: limit : search limit (default : 0 : unlimited)
  • boolean $limit: activeOnly : return only active users (default : false)
  • boolean $activeOnly: returnObjects : return CMS_profile_user objects (default) or array of userId
  • $returnObjects
  • &$score
static soapGetUser (line 220)

Get user by ID

  • return: XML definition object
  • access: public
static string soapGetUser ([integer $userId = 0])
  • integer $userId: The user ID
static soapSearch (line 281)

Search users by xml definition. Return XML

  • return: XML definition of users IDs
  • access: public
static string soapSearch ([string $searchConditions = ''])
  • string $searchConditions: XML definition to search with ('id','login','firstName','lastName','contactData','profile','language')

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
Description | Constants (details) | Methods (details)

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
 CMS_grandFather::SYSTEM_LABEL

Documentation generated on Wed, 15 Feb 2012 15:38:01 +0100 by phpDocumentor 1.4.3