eZPublish  4.5
eZLDAPUser Class Reference

The class eZLDAPUser does. More...

+ Inheritance diagram for eZLDAPUser:
+ Collaboration diagram for eZLDAPUser:

Public Member Functions

 eZLDAPUser ()
 
- Public Member Functions inherited from eZUser
 accessArray ()
 Returns either cached or newly generated accessArray for the user depending on site.ini[RoleSettings] setting. More...
 
 canAssignSection ($checkSectionID)
 
 canAssignSectionList ()
 
 canAssignSectionToClassList ($checkSectionID)
 
 canAssignSectionToObject ($checkSectionID, $contentObject)
 
 canAssignToObjectSectionList ($contentObject)
 
 canLoginToSiteAccess ($access)
 
 checkUser (&$siteBasics, $uri)
 
 contentObject ()
 
 eZUser ($row=array())
 
 failedLoginAttempts ()
 
 forceLogin ()
 
 generateAccessArray ()
 Generates the accessArray for the user (for $this). More...
 
 getUserCache ()
 Get User cache from cache file. More...
 
 groups ($asObject=false)
 
 hasAccessTo ($module, $function=false)
 
 hasAccessToView ($module, $viewName, &$params)
 
 hasManageLocations ()
 
 hasStoredLogin ()
 
 id ()
 
 isAnonymous ()
 
 isEnabled ()
 
 isLocked ()
 
 isLoggedIn ()
 
 lastVisit ()
 
 limitList ($useGroupsCache=true)
 
 limitValueList ()
 
 loginCount ()
 Returns the login count for the current user. More...
 
 loginCurrent ()
 
 loginURI ()
 
 originalPassword ()
 
 originalPasswordConfirm ()
 
 postCollectUserInfo ()
 
 preCollectUserInfo ()
 
 purgeUserCache ()
 Delete User cache from locale var and cache file for current user. More...
 
 roleIDList ()
 
 roles ()
 
 sessionCleanup ()
 
 setInformation ($id, $login, $email, $password, $passwordConfirm=false)
 
 setOriginalPassword ($password)
 
 setOriginalPasswordConfirm ($password)
 
 setUserCache (array $userCache)
 Set User cache from cache file Needs to be in excact same format as eZUser::getUserCache()! More...
 
 store ($fieldFilters=null)
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 
 attributes ()
 
 eZPersistentObject ($row)
 
 fill ($row)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 remove ($conditions=null, $extraConditions=null)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 sync ($fieldFilters=null)
 

Static Public Member Functions

static getGroupNameByDN ($ds, $groupDN)
 
static getNodeAssignmentsForGroupName ($groupName, $isFirstGroupAssignment, &$defaultUserPlacement, &$extraNodeAssignments, $createMissingGroups, $parentNodeID)
 
static getUserGroupsTree (&$requiredParams, $filter, $curDN, &$groupsTree, &$stack, $depth=0)
 
static goAndPublishGroups (&$requiredParams, $curDN, &$groupsTree, &$stack, $depth, $isUser=false)
 
static ldap_escape ($str, $for_dn=false)
 
static loginUser ($login, $password, $authenticationMatch=false)
 
static publishNewUserGroup ($parentNodeIDs, $newGroupAttributes, $isUtf8Encoding=false)
 
static publishUpdateUser ($parentNodeIDs, $defaultUserPlacement, $userAttributes, $isUtf8Encoding=false)
 
- Static Public Member Functions inherited from eZUser
static anonymousId ()
 Gets the id of the anonymous user. More...
 
static authenticateHash ($user, $password, $site, $type, $hash)
 
static authenticationMatch ()
 
static cleanup ()
 Cleanup user related session values, for use by login / logout code. More...
 
static cleanupCache ()
 Expire user access / info cache globally. More...
 
static clearSessionCache ()
 
static contentClassIDs ()
 
static create ($contentObjectID)
 
static createHash ($user, $password, $site, $type, $hash=false)
 
static createPassword ($passwordLength, $seed=false)
 
static currentUser ()
 
static currentUserID ()
 
static definition ()
 
static failedLoginAttemptsByUserID ($userID)
 
static fetch ($id, $asObject=true)
 
static fetchAnonymousCount ()
 Return the number of anonymous users in the system. More...
 
static fetchBuiltin ($id)
 
static fetchByEmail ($email, $asObject=true)
 
static fetchByName ($login, $asObject=true)
 
static fetchContentList ()
 
static fetchLoggedInCount ()
 
static fetchLoggedInList ($asObject=false, $offset=false, $limit=false, $sortBy=false)
 
static fetchUserClassList ($asObject=false, $fields=false)
 
static fetchUserClassNames ()
 
static fetchUserGroupClassNames ()
 
static generateUserCacheForFile ($filePath, $userId)
 Callback which generates user cache for user. More...
 
static getCacheDir ($userId=0)
 Creates the cache path if it doesn't exist, and returns the cache directory. More...
 
static getCacheFilename ($userId)
 Returns the filename for a cache file with user information. More...
 
static getUserCacheByAnonymousId ()
 Get User cache from cache file for Anonymous user(usefull for sessionless users) More...
 
static hashType ()
 
static instance ($id=false)
 Returns a shared instance of the eZUser class pr $id value. More...
 
static isEnabledAfterFailedLogin ($userID, $ignoreTrusted=false)
 
static isTrusted ()
 
static isUserIPInList ($ipList)
 
static isUserLoggedIn ($userID)
 
static isUserObject ($contentObject)
 
static loginUser ($login, $password, $authenticationMatch=false)
 Logs in the user if applied username and password is valid. More...
 
static logoutCurrent ()
 
static maxNumberOfFailedLogin ()
 
static passwordCharacterTable ()
 
static passwordHashTypeID ($identifier)
 
static passwordHashTypeName ($id)
 
static purgeUserCacheByAnonymousId ()
 Delete User cache from cache file for Anonymous user(usefull for sessionless users) More...
 
static purgeUserCacheByUserId ($userId)
 Delete User cache pr user. More...
 
static removeSessionData ($userID)
 Remove session data for user $userID. More...
 
static removeUser ($userID)
 
static requireUniqueEmail ()
 
static retrieveUserCacheFromFile ($filePath, $mtime, $userId)
 Callback which fetches user cache from local file. More...
 
static setFailedLoginAttempts ($userID, $value=false, $setByForce=false)
 
static site ()
 
static updateLastVisit ($userID, $updateLoginCount=false)
 
static validateLoginName ($loginName, &$errorText)
 Validates user login name using site.ini[UserSettings]UserNameValidationRegex[]. More...
 
static validatePassword ($password)
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 
static conditionTextByRow ($conditions, $row)
 
static count ($def, $conds=null, $field=null)
 
static definition ()
 
static escapeArray ($array)
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
static fetchObjectList ($def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null, $custom_tables=null, $custom_conds=null)
 
static getShortAttributeName ($db, $def, $attrName)
 
static handleRows ($rows, $class_name, $asObject)
 
static newObjectOrder ($def, $orderField, $conditions)
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 
static updateObjectList ($parameters)
 

Additional Inherited Members

- Public Attributes inherited from eZUser
 $Email
 
 $Groups
 
 $Login
 
 $OriginalPassword
 
 $OriginalPasswordConfirm
 
 $PasswordHash
 
 $PasswordHashType
 
const AUTHENTICATE_ALL = 3
 
const AUTHENTICATE_EMAIL = 2
 Authenticate by matching the email field. More...
 
const AUTHENTICATE_LOGIN = 1
 Authenticate by matching the login field. More...
 
const PASSWORD_HASH_CRYPT = 6
 
const PASSWORD_HASH_MD5_PASSWORD = 1
 MD5 of password. More...
 
const PASSWORD_HASH_MD5_SITE = 3
 MD5 of site, user and password. More...
 
const PASSWORD_HASH_MD5_USER = 2
 MD5 of user and password. More...
 
const PASSWORD_HASH_MYSQL = 4
 Legacy support for mysql hashed passwords. More...
 
const PASSWORD_HASH_PLAINTEXT = 5
 Passwords in plaintext, should not be used for real sites. More...
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 Whether the data is dirty, ie needs to be stored, or not. More...
 
- Protected Member Functions inherited from eZUser
 generateGroupIdList ()
 Generate list of group id's. More...
 
- Static Protected Member Functions inherited from eZUser
static _loginUser ($login, $password, $authenticationMatch=false)
 Logs in an user if applied login and password is valid. More...
 
static getUserCacheByUserId ($userId)
 Get User cache from cache file (usefull for sessionless users) More...
 
static loginFailed ($userID=false, $login)
 Does some house keeping work when a log in has failed. More...
 
static loginSucceeded ($user)
 Does some house keeping work once a log in has succeeded. More...
 
static setCurrentlyLoggedInUser ($user, $userID)
 
static userInfoExpiry ()
 
- Protected Attributes inherited from eZUser
 $UserCache = null
 
- Static Protected Attributes inherited from eZUser
static $anonymousId = null
 
static $userHasLoggedOut = false
 

Detailed Description

The class eZLDAPUser does.

Member Function Documentation

eZLDAPUser::eZLDAPUser ( )

Constructor

static eZLDAPUser::getGroupNameByDN (   $ds,
  $groupDN 
)
static
static eZLDAPUser::getNodeAssignmentsForGroupName (   $groupName,
  $isFirstGroupAssignment,
$defaultUserPlacement,
$extraNodeAssignments,
  $createMissingGroups,
  $parentNodeID 
)
static
static eZLDAPUser::getUserGroupsTree ( $requiredParams,
  $filter,
  $curDN,
$groupsTree,
$stack,
  $depth = 0 
)
static

Referenced by loginUser().

static eZLDAPUser::goAndPublishGroups ( $requiredParams,
  $curDN,
$groupsTree,
$stack,
  $depth,
  $isUser = false 
)
static
static eZLDAPUser::ldap_escape (   $str,
  $for_dn = false 
)
static
static eZLDAPUser::loginUser (   $login,
  $password,
  $authenticationMatch = false 
)
static

Logs in the user if applied username and password is valid. The userID is returned if succesful, false if not.

static eZLDAPUser::publishNewUserGroup (   $parentNodeIDs,
  $newGroupAttributes,
  $isUtf8Encoding = false 
)
static

Referenced by goAndPublishGroups().

static eZLDAPUser::publishUpdateUser (   $parentNodeIDs,
  $defaultUserPlacement,
  $userAttributes,
  $isUtf8Encoding = false 
)
static

Referenced by loginUser().


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