eZUser handles eZ Publish user accounts More...

Inheritance diagram for eZUser:

Collaboration diagram for eZUser:

Public Member Functions
	accessArray ()
	canAssignSection ($checkSectionID)
	canAssignSectionList ()
	canAssignSectionToClassList ($checkSectionID)
	canAssignSectionToObject ($checkSectionID, $contentObject)
	canAssignToObjectSectionList ($contentObject)
	checkUser (&$siteBasics, $uri)
	contentObject ()
	eZUser ($row)
	failedLoginAttempts ()
	forceLogin ()
	generateAccessArray ()
	groups ($asObject=false)
	hasAccessTo ($module, $function=false)
	hasAccessToView ($module, $viewName, &$params)
	hasManageLocations ()
	hasStoredLogin ()
	id ()
	isAnonymous ()
	isEnabled ()
	isLocked ()
	isLoggedIn ()
	lastVisit ()
	limitList ()
	limitValueList ()
	loginCurrent ()
	loginURI ()
	originalPassword ()
	originalPasswordConfirm ()
	postCollectUserInfo ()
	preCollectUserInfo ()
	roleIDList ()
	roles ()
	sessionCleanup ()
	setInformation ($id, $login, $email, $password, $passwordConfirm=false)
	setOriginalPassword ($password)
	setOriginalPasswordConfirm ($password)
	store ($fieldFilters=null)
Static Public Member Functions
static	anonymousId ()
static	authenticateHash ($user, $password, $site, $type, $hash)
static	authenticationMatch ()
static	cleanup ()
static	cleanupCache ()
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 ()
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	getCacheDir ($id=0)
static	getCacheFilename ($id)
static	hashType ()
static	instance ($id=false)
static	isEnabledAfterFailedLogin ($userID, $ignoreTrusted=false)
static	isTrusted ()
static	isUserIPInList ($ipList)
static	isUserLoggedIn ($userID)
static	isUserObject ($contentObject)
static	loginUser ($login, $password, $authenticationMatch=false)
static	logoutCurrent ()
static	maxNumberOfFailedLogin ()
static	passwordCharacterTable ()
static	passwordHashTypeID ($identifier)
static	passwordHashTypeName ($id)
static	removeSessionData ($userID)
static	removeUser ($userID)
static	requireUniqueEmail ()
static	setFailedLoginAttempts ($userID, $value=false, $setByForce=false)
static	site ()
static	updateLastVisit ($userID)
static	validatePassword ($password)
Public Attributes
	$Email
	$Groups
	$Login
	$OriginalPassword
	$OriginalPasswordConfirm
	$PasswordHash
	$PasswordHashType
const	AUTHENTICATE_ALL = 3
const	AUTHENTICATE_EMAIL = 2
	Authenticate by matching the email field.
const	AUTHENTICATE_LOGIN = 1
	Authenticate by matching the login field.
const	PASSWORD_HASH_CRYPT = 6
const	PASSWORD_HASH_MD5_PASSWORD = 1
	MD5 of password.
const	PASSWORD_HASH_MD5_SITE = 3
	MD5 of site, user and password.
const	PASSWORD_HASH_MD5_USER = 2
	MD5 of user and password.
const	PASSWORD_HASH_MYSQL = 4
	Legacy support for mysql hashed passwords.
const	PASSWORD_HASH_PLAINTEXT = 5
	Passwords in plaintext, should not be used for real sites.
Static Protected Member Functions
static	setCurrentlyLoggedInUser ($user, $userID)
Static Protected Attributes
static	$anonymousId = null
Private Member Functions
	generateAccessArrayForCache ($filePath, $userID)
Static Private Member Functions
	retrieveAccessArrayFromCache ($filePath, $mtime, $userID)
	userInfoExpiry ()

Detailed Description

eZUser handles eZ Publish user accounts

Definition at line 43 of file ezuser.php.

Member Function Documentation

eZUser::accessArray ( )

Definition at line 1599 of file ezuser.php.

Referenced by hasAccessTo().

static eZUser::anonymousId ( ) [static]

Definition at line 2659 of file ezuser.php.

Referenced by fetchAnonymousCount(), fetchBuiltin(), fetchLoggedInCount(), fetchLoggedInList(), instance(), and logoutCurrent().

static eZUser::authenticateHash	(	$	user,
		$	password,
		$	site,
		$	type,
		$	hash
	)		`[static]`

Creates a hash out of $user, $password and $site according to the type $type.

Returns:: true if the generated hash is equal to the supplied hash $hash.

Definition at line 1398 of file ezuser.php.

Referenced by eZLDAPUser\loginUser(), eZTextFileUser\loginUser(), and loginUser().

static eZUser::authenticationMatch ( ) [static]

Returns:: a bitfield which decides the authenticate methods.

Definition at line 649 of file ezuser.php.

Referenced by eZLDAPUser\loginUser(), eZTextFileUser\loginUser(), loginUser(), and eZUserType\validateObjectAttributeHTTPInput().

eZUser::canAssignSection ( $ checkSectionID )

Definition at line 1843 of file ezuser.php.

eZUser::canAssignSectionList ( )

Definition at line 1874 of file ezuser.php.

eZUser::canAssignSectionToClassList ( $ checkSectionID )

Definition at line 1908 of file ezuser.php.

eZUser::canAssignSectionToObject	(	$	checkSectionID,
		$	contentObject
	)

Definition at line 1770 of file ezuser.php.

eZUser::canAssignToObjectSectionList ( $ contentObject )

Definition at line 1728 of file ezuser.php.

eZUser::checkUser	(	&$	siteBasics,
		$	uri
	)

Checks if user is logged in, if not and the site requires user login for access a module redirect is returned.

Returns:: null, user login not required.

Definition at line 2420 of file ezuser.php.

static eZUser::cleanup ( ) [static]

Cleans up any cache or session variables that are set. This at least called on login and logout but can be used other places where you must ensure that the cache user values are refetched.

Parameters:

deprecated

Definition at line 972 of file ezuser.php.

Referenced by logoutCurrent().

static eZUser::cleanupCache ( ) [static]

Definition at line 2533 of file ezuser.php.

Referenced by eZContentObjectTreeNodeOperations\move(), and eZContentObjectTreeNode\removeSubtrees().

static eZUser::clearSessionCache ( ) [static]

Removes any cached session information, this is:

logged in user count
anonymous user count
logged in user map

Definition at line 519 of file ezuser.php.

Referenced by removeSessionData().

static eZUser::contentClassIDs ( ) [static]

Returns the IDs of content classes that contain user accounts

Definition at line 2673 of file ezuser.php.

Referenced by eZApproveType\execute(), eZContentObjectTreeNodeOperations\move(), and eZContentObjectTreeNode\removeSubtrees().

eZUser::contentObject ( )

Definition at line 2253 of file ezuser.php.

static eZUser::create ( $ contentObjectID ) [static]

Definition at line 203 of file ezuser.php.

Referenced by eZTextFileUser\loginUser(), eZLDAPUser\publishNewUserGroup(), eZLDAPUser\publishUpdateUser(), and eZSiteInstaller\updateContentObjectAttributes().

static eZUser::createHash	(	$	user,
		$	password,
		$	site,
		$	type,
		$	hash = `false`
	)		`[static]`

Will create a hash of the given string. This is used to store the passwords in the database.

Definition at line 1498 of file ezuser.php.

Referenced by authenticateHash(), eZLDAPUser\loginUser(), eZTextFileUser\loginUser(), loginUser(), and setInformation().

static eZUser::createPassword	(	$	passwordLength,
		$	seed = `false`
	)		`[static]`

Creates a password with number of characters equal to $passwordLength and returns it. If you want pass a value in $seed it will be used as basis for the password, if not it will use the current time value as seed.

Note:: If $passwordLength exceeds 16 it will need to generate new seed for the remaining characters.

Definition at line 1468 of file ezuser.php.

static eZUser::currentUser ( ) [static]

Returns the currently logged in user.

Definition at line 1375 of file ezuser.php.

Referenced by eZDefaultShopAccountHandler\accountName(), eZCollaborationItemMessageLink\addMessage(), eZContentObject\allowedAssignSectionList(), eZGeneralDigestHandler\attribute(), eZSubTreeHandler\attribute(), eZContentObject\cacheInfo(), eZContentObject\canCreateClassList(), eZContentObjectTreeNode\canCreateClassList(), eZContentObjectTreeNode\canEdit(), eZContentObject\canEdit(), eZContentClass\canInstantiateClasses(), eZContentClass\canInstantiateClassList(), eZOrder\canModifyStatus(), eZContentObject\canTranslate(), eZPackage\canUsePackagePolicyFunction(), eZPackage\canUsePolicyFunction(), eZContentObjectVersion\checkAccess(), eZContentObject\checkAccess(), eZContentObjectTreeNode\checkAccess(), eZSubtreeNotificationRule\checkObjectAccess(), eZPackageCreationHandler\checkPackageMaintainer(), checkUser(), eZUserType\classAttributeRemovableInformation(), eZContentObject\copy(), eZContentObject\copyVersion(), eZCollaborationSimpleMessage\create(), eZRSSImport\create(), eZInformationCollection\create(), eZContentObjectVersion\create(), eZContentObjectTreeNode\createObject(), eZBasket\createOrder(), eZContentObjectTreeNode\createPermissionCheckingSQL(), eZPackageCreationHandler\creatorList(), eZWishList\currentWishList(), eZWishList\discountPercent(), eZDefaultShopAccountHandler\email(), eZHTTPHeader\enabled(), eZApproveType\execute(), eZMultiplexerType\execute(), eZWebDAVContentServer\eZWebDAVContentServer(), eZSubTreeHandler\fetchHttpInput(), eZPackage\fetchMaintainerRoleIDList(), eZContentCacheManager\generateObjectViewCache(), eZInformationCollection\generateUserIdentifier(), eZContentObjectTreeNode\getLimitationList(), eZVATManager\getUserCountry(), eZApproveCollaborationHandler\handleCustomAction(), eZContentClass\initializeCopy(), eZPackageCreationHandler\initializePackageChangelog(), eZPackageCreationHandler\initializePackageInformation(), eZPackageCreationHandler\initializePackageMaintainer(), eZCollaborationProfile\instance(), eZContentClass\instantiate(), isEnabled(), eZCollaborationGroup\itemCount(), eZLDAPUser\loginUser(), eZAuthorType\objectAttributeContent(), eZSubtreeSubscriptionType\onPublish(), eZWebDAVContentServer\processClientRequest(), eZContentObjectTreeNode\removeSubtrees(), eZCollaborationNotificationHandler\rules(), eZSubTreeHandler\rules(), eZSubTreeHandler\rulesCount(), eZTrigger\runTrigger(), eZGeneralDigestHandler\settings(), eZPreferences\setValue(), eZOrder\statusModificationList(), eZRSSExport\store(), eZPDFExport\store(), eZRSSImport\store(), eZContentClass\storeDefined(), eZGeneralDigestHandler\storeSettings(), eZSubTreeHandler\subscribedNodes(), eZCollaborationGroup\subTree(), eZContentObjectTreeNode\subTreeCountByNodeID(), eZPreferences\value(), eZPreferences\values(), eZDefaultShopAccountHandler\verifyAccountInformation(), and eZAudit\writeAudit().

static eZUser::currentUserID ( ) [static]

Returns the ID of the currently logged in user.

Definition at line 1385 of file ezuser.php.

static eZUser::definition ( ) [static]

Returns:: the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.

The definition array is an associative array consists of these keys:

fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
keys - an array of fields which is used for uniquely identifying the object in the table.
function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
increment_key - the field which is incremented on table inserts.
class_name - the classname which is used for instantiating new objecs when fetching from the database.
sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either asc or desc.
name - the name of the database table

Example:

static function definition()
{
    return array( "fields" => array( "id" => "ID",
                                     "version" => "Version",
                                     "name" => "Name" ),
                  "keys" => array( "id", "version" ),
                  "function_attributes" => array( "current" => "currentVersion",
                                                  "class_name" => "className" ),
                  "increment_key" => "id",
                  "class_name" => "eZContentClass",
                  "sort" => array( "id" => "asc" ),
                  "name" => "ezcontentclass" );
}

Reimplemented from eZPersistentObject.

Definition at line 74 of file ezuser.php.

Referenced by fetch(), fetchByEmail(), fetchByName(), and removeUser().

eZUser::eZUser ( $ row )

Definition at line 67 of file ezuser.php.

Referenced by create(), fetchLoggedInList(), instance(), eZLDAPUser\loginUser(), eZTextFileUser\loginUser(), and loginUser().

eZUser::failedLoginAttempts ( )

Returns the current user's number of failed login attempts.

Definition at line 1311 of file ezuser.php.

static eZUser::failedLoginAttemptsByUserID ( $ userID ) [static]

Returns the current user's number of failed login attempts.

Definition at line 1319 of file ezuser.php.

Referenced by failedLoginAttempts().

static eZUser::fetch	(	$	id,
		$	asObject = `true`
	)		`[static]`

static eZUser::fetchAnonymousCount ( ) [static]

Returns:: the number of anonymous users in the system.

See also:: fetchLoggedInCount

Definition at line 459 of file ezuser.php.

static eZUser::fetchBuiltin ( $ id ) [static]

Fetches a builtin user and returns it, this helps avoid special cases where user is not logged in.

Definition at line 625 of file ezuser.php.

static eZUser::fetchByEmail	(	$	email,
		$	asObject = `true`
	)		`[static]`

Definition at line 301 of file ezuser.php.

Referenced by eZUserType\fromString(), and eZUserType\validateObjectAttributeHTTPInput().

static eZUser::fetchByName	(	$	login,
		$	asObject = `true`
	)		`[static]`

Definition at line 293 of file ezuser.php.

Referenced by eZUserType\fromString(), eZLDAPUser\loginUser(), eZTextFileUser\loginUser(), eZLDAPUser\publishUpdateUser(), and eZUserType\validateObjectAttributeHTTPInput().

static eZUser::fetchContentList ( ) [static]

Returns:: a list of valid and enabled users, the data returned is an array with ezcontentobject database data.

Definition at line 575 of file ezuser.php.

static eZUser::fetchLoggedInCount ( ) [static]

Returns:: the number of logged in users in the system.

Note:: The count will be cached for the current page if caching is allowed.

See also:: fetchAnonymousCount

Definition at line 430 of file ezuser.php.

static eZUser::fetchLoggedInList	(	$	asObject = `false`,
		$	offset = `false`,
		$	limit = `false`,
		$	sortBy = `false`
	)		`[static]`

Returns:: a list of the logged in users.

Parameters:

$asObject If false it will return a list with only the names of the users as elements and user ID as key, otherwise each entry is a eZUser object.

See also:: fetchLoggedInCount

Definition at line 316 of file ezuser.php.

static eZUser::fetchUserClassList	(	$	asObject = `false`,
		$	fields = `false`
	)		`[static]`

Definition at line 2569 of file ezuser.php.

Referenced by fetchUserClassNames(), and fetchUserGroupClassNames().

static eZUser::fetchUserClassNames ( ) [static]

Definition at line 2601 of file ezuser.php.

Referenced by eZApproveType\customWorkflowEventHTTPAction().

static eZUser::fetchUserGroupClassNames ( ) [static]

Definition at line 2612 of file ezuser.php.

Referenced by eZApproveType\customWorkflowEventHTTPAction(), and eZApproveType\validateGroupIDList().

eZUser::forceLogin ( )

Check if login handler require forced login at user check.

Returns:: true if force login on user check, false if not.

Definition at line 2509 of file ezuser.php.

eZUser::generateAccessArray ( )

Definition at line 1671 of file ezuser.php.

Referenced by accessArray(), and generateAccessArrayForCache().

eZUser::generateAccessArrayForCache	(	$	filePath,
		$	userID
	)		`[private]`

Callback which generates the accessarray for the current user.

Definition at line 1717 of file ezuser.php.

static eZUser::getCacheDir ( $ id = 0 ) [static]

Creates the cache path if it doesn't exist, and returns the cache directory. The $id parameter is used to create multi-level directory names

Returns:: filename of the cachefile

Definition at line 2520 of file ezuser.php.

Referenced by getCacheFilename().

static eZUser::getCacheFilename ( $ id ) [static]

Returns the filename for a cache file with user information

Returns:: filename of the cachefile, or false when the user should not be cached

Definition at line 2547 of file ezuser.php.

Referenced by accessArray().

eZUser::groups ( $ asObject = false )

Returns:: an array of id's with all the groups the user belongs to.

Definition at line 2280 of file ezuser.php.

Referenced by generateAccessArray(), and limitList().

eZUser::hasAccessTo	(	$	module,
		$	function = `false`
	)

Check if user has got access to the specified module and function

Parameters:

module	name
funtion	name

Returns:: Array containg result. Array elements : 'accessWord', yes - access allowed no - access denied limited - access array describing access included 'policies', array containing the policy limitations 'accessList', array describing missing access rights

Definition at line 1554 of file ezuser.php.

Referenced by canAssignSection(), canAssignSectionList(), canAssignSectionToClassList(), canAssignSectionToObject(), canAssignToObjectSectionList(), hasAccessToView(), and hasManageLocations().

eZUser::hasAccessToView	(	$	module,
		$	viewName,
		&$	params
	)

Definition at line 1960 of file ezuser.php.

static eZUser::hashType ( ) [static]

Returns:: the default hash type which is specified in UserSettings/HashType in site.ini

Definition at line 593 of file ezuser.php.

Referenced by eZLDAPUser\loginUser(), eZTextFileUser\loginUser(), loginUser(), and setInformation().

eZUser::hasManageLocations ( )

Check if current user has "content/manage_locations" access

Definition at line 192 of file ezuser.php.

eZUser::hasStoredLogin ( )

Definition at line 251 of file ezuser.php.

eZUser::id ( )

Returns:: the user id.

Definition at line 641 of file ezuser.php.

static eZUser::instance ( $ id = false ) [static]

Finds the user with the id $id and returns the unique instance of it. If the user instance is not created yet it tries to either fetch it from the database with eZUser::fetch(). If $id is false or the user was not found, the default user is returned. This is a site.ini setting under UserSettings:AnonymousUserID. The instance is then returned. If $id is false then the current user is fetched.

Definition at line 1035 of file ezuser.php.

Referenced by accessArray(), anonymousId(), authenticationMatch(), checkUser(), cleanup(), cleanupCache(), contentClassIDs(), createHash(), currentUser(), currentUserID(), eZApproveType\execute(), failedLoginAttemptsByUserID(), fetchAnonymousCount(), fetchContentList(), fetchLoggedInCount(), fetchLoggedInList(), fetchUserClassList(), fetchUserGroupClassNames(), getCacheDir(), getCacheFilename(), groups(), hashType(), hasStoredLogin(), isTrusted(), isUserLoggedIn(), lastVisit(), limitList(), limitValueList(), eZLDAPUser\loginUser(), eZTextFileUser\loginUser(), loginUser(), logoutCurrent(), maxNumberOfFailedLogin(), passwordCharacterTable(), eZLDAPUser\publishNewUserGroup(), eZLDAPUser\publishUpdateUser(), removeSessionData(), requireUniqueEmail(), roleIDList(), setCurrentlyLoggedInUser(), setFailedLoginAttempts(), site(), store(), updateLastVisit(), eZWorkflowProcess\user(), userInfoExpiry(), and validatePassword().

eZUser::isAnonymous ( )

Returns:: true if the user is the anonymous user.

Definition at line 1362 of file ezuser.php.

eZUser::isEnabled ( )

Returns:: true if the user is enabled and can be used on the site.

Definition at line 1343 of file ezuser.php.

static eZUser::isEnabledAfterFailedLogin	(	$	userID,
		$	ignoreTrusted = `false`
	)		`[static]`

Definition at line 909 of file ezuser.php.

Referenced by isLocked(), eZLDAPUser\loginUser(), eZTextFileUser\loginUser(), and loginUser().

eZUser::isLocked ( )

Returns:: true if the user is locked (is enabled after failed login) and can be logged on the site.

Definition at line 1333 of file ezuser.php.

eZUser::isLoggedIn ( )

Returns true if it's a real user which is logged in. False if the user is the default user or the fallback buildtin user.

Definition at line 2267 of file ezuser.php.

static eZUser::isTrusted ( ) [static]

Returns true if current user is trusted user.

Definition at line 875 of file ezuser.php.

Referenced by isEnabledAfterFailedLogin(), and setFailedLoginAttempts().

static eZUser::isUserIPInList ( $ ipList ) [static]

Checks if IP address of current user is in $ipList.

Definition at line 832 of file ezuser.php.

Referenced by isTrusted().

static eZUser::isUserLoggedIn ( $ userID ) [static]

Returns:: true if the user with ID $userID is currently logged into the system.

Note:: The information will be cached for the current page if caching is allowed.

See also:: fetchLoggedInList

Definition at line 488 of file ezuser.php.

static eZUser::isUserObject ( $ contentObject ) [static]

Checks if the supplied content object is a user object ( contains ezuser datatype )

Parameters:

ContentObject

Returns:: true or false

Definition at line 1440 of file ezuser.php.

Referenced by eZApproveType\fetchHTTPInput(), and eZApproveType\validateUserIDList().

eZUser::lastVisit ( )

Returns the last visit timestamp to the current user.

Definition at line 1231 of file ezuser.php.

eZUser::limitList ( )

Returns:: an array of limited assignments

Definition at line 2193 of file ezuser.php.

Referenced by limitValueList().

eZUser::limitValueList ( )

Returns:: an array of values of limited assignments

Definition at line 2211 of file ezuser.php.

eZUser::loginCurrent ( )

Returns:: logs in the current user object

Definition at line 998 of file ezuser.php.

eZUser::loginURI ( )

Check if login handler require special login URI

Returns:: Special login uri. If false, use system standard login uri.

Definition at line 2499 of file ezuser.php.

static eZUser::loginUser	(	$	login,
		$	password,
		$	authenticationMatch = `false`
	)		`[static]`

Logs in the user if applied username and password is valid.

Returns:: The user object (eZContentObject) of the logged in user or false if it failed.

Reimplemented in eZTextFileUser, and eZLDAPUser.

Definition at line 686 of file ezuser.php.

Referenced by eZScript\initialize().

static eZUser::logoutCurrent ( ) [static]

Logs out the current user

Definition at line 1007 of file ezuser.php.

Referenced by checkUser(), and eZScript\shutdown().

static eZUser::maxNumberOfFailedLogin ( ) [static]

Returns max number of failed login attempts.

Definition at line 894 of file ezuser.php.

Referenced by isEnabledAfterFailedLogin(), and setFailedLoginAttempts().

eZUser::originalPassword ( )

Definition at line 231 of file ezuser.php.

eZUser::originalPasswordConfirm ( )

Definition at line 241 of file ezuser.php.

static eZUser::passwordCharacterTable ( ) [static]

Returns:: an array with characters which are allowed in password.

Definition at line 1407 of file ezuser.php.

Referenced by createPassword().

static eZUser::passwordHashTypeID ( $ identifier ) [static]

Returns:: the hash type for the textual identifier $identifier

Definition at line 157 of file ezuser.php.

Referenced by eZUserType\fromString(), and eZUserType\unserializeContentObjectAttribute().

static eZUser::passwordHashTypeName ( $ id ) [static]

Returns:: a textual identifier for the hash type $id

Definition at line 123 of file ezuser.php.

Referenced by eZUserType\serializeContentObjectAttribute(), and eZUserType\toString().

eZUser::postCollectUserInfo ( )

Function performed after user login info has been collected. Store login data as array: array( 'login' => <username>, 'password' = <password> ) to session variable EZ_LOGIN_HANDLER_USER_INFO for automatic processing of login data.

Returns:

See also:: eZUserLoginHandler::checkUser()

Definition at line 2489 of file ezuser.php.

eZUser::preCollectUserInfo ( )

Funtion performed before user login info is collected. It's optional to implement this function in new login handler.

Returns:

See also:: eZUserLoginHandler::checkUser()

Definition at line 2475 of file ezuser.php.

static eZUser::removeSessionData ( $ userID ) [static]

Remove session data for user $userID.

Definition at line 530 of file ezuser.php.

Referenced by eZContentObjectTreeNode\removeSubtrees(), removeUser(), and eZUserSetting\setAttribute().

static eZUser::removeUser ( $ userID ) [static]

Removes the user from the ezuser table.

Note:: Will also remove any notifications and session related to the user.

Definition at line 542 of file ezuser.php.

Referenced by eZUserType\deleteStoredObjectAttribute().

static eZUser::requireUniqueEmail ( ) [static]

Returns:: true if there can only be one instance of an email address on the site.

Definition at line 675 of file ezuser.php.

Referenced by eZUserType\validateObjectAttributeHTTPInput().

eZUser::retrieveAccessArrayFromCache	(	$	filePath,
		$	mtime,
		$	userID
	)		`[static, private]`

Callback which fetches access array from local file.

Definition at line 1708 of file ezuser.php.

eZUser::roleIDList ( )

Returns:: an array of role ids which the user is assigned to

Definition at line 2152 of file ezuser.php.

eZUser::roles ( )

Returns:: an array of roles which the user is assigned to

Definition at line 2141 of file ezuser.php.

eZUser::sessionCleanup ( )

Used by login handler to clean up session variables

Definition at line 961 of file ezuser.php.

Referenced by cleanup().

static eZUser::setCurrentlyLoggedInUser	(	$	user,
		$	userID
	)		`[static, protected]`

Makes sure the user $user is set as the currently logged in user by updating the session and setting the necessary global variables.

All login handlers should use this function to ensure that the process is executed properly.

Definition at line 943 of file ezuser.php.

Referenced by instance(), loginCurrent(), eZLDAPUser\loginUser(), eZTextFileUser\loginUser(), and loginUser().

static eZUser::setFailedLoginAttempts	(	$	userID,
		$	value = `false`,
		$	setByForce = `false`
	)		`[static]`

If $value is false will increase the user's number of failed login attempts otherwise failed_login_attempts will be updated by $value. $setByForce if true checking for trusting or max number of failed login attempts will be ignored.

Definition at line 1251 of file ezuser.php.

Referenced by eZLDAPUser\loginUser(), eZTextFileUser\loginUser(), loginUser(), and eZLDAPUser\publishUpdateUser().

eZUser::setInformation	(	$	id,
		$	login,
		$	email,
		$	password,
		$	passwordConfirm = `false`
	)

Fills in the $id, $login, $email and $password for the user and creates the proper password hash.

Definition at line 264 of file ezuser.php.

eZUser::setOriginalPassword ( $ password )

Definition at line 236 of file ezuser.php.

Referenced by setInformation().

eZUser::setOriginalPasswordConfirm ( $ password )

Definition at line 246 of file ezuser.php.

Referenced by setInformation().

static eZUser::site ( ) [static]

Returns:: the site name used in password hashing.

Definition at line 614 of file ezuser.php.

Referenced by eZLDAPUser\loginUser(), eZTextFileUser\loginUser(), loginUser(), and setInformation().

eZUser::store ( $ fieldFilters = null )

Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it.

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Reimplemented from eZPersistentObject.

Definition at line 215 of file ezuser.php.

static eZUser::updateLastVisit ( $ userID ) [static]

Updates the user's last visit timestamp

Definition at line 1208 of file ezuser.php.

Referenced by instance(), eZLDAPUser\loginUser(), eZTextFileUser\loginUser(), loginUser(), and eZLDAPUser\publishUpdateUser().

eZUser::userInfoExpiry ( ) [static, private]

Callback which figures out global expiry and returns it.

Definition at line 1685 of file ezuser.php.

Referenced by accessArray().

static eZUser::validatePassword ( $ password ) [static]

Checks the password for validity