eZPublishCommunityProject(LegacyStack)  2013.6
eZTextFileUser Class Reference

Handles logins for users defined a simple text file. More...

+ Inheritance diagram for eZTextFileUser:
+ Collaboration diagram for eZTextFileUser:

Public Member Functions

 eZTextFileUser ()
- Public Member Functions inherited from eZUser
 accessArray ()
 Returns either cached or newly generated accessArray for the user depending on site.ini[RoleSettings] setting. More...
 accountKey ()
 Returns the eZUserAccountKey associated with this user. 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 ($useCache=true)
 isLocked ()
 isLoggedIn ()
 Returns true if the user is a registered and not anonymous user. More...
 isRegistered ()
 Returns true if the user is a registered and not anonymous user. More...
 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)
 Returns the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched. More...
 attributes ()
 Returns the attributes for this object, taken from the definition fields and function attributes. More...
 eZPersistentObject ($row)
 Initializes the object with the $row. More...
 fill ($row)
 Tries to fill in the data in the object by using the object definition which is returned by the function definition() and the database row data $row. More...
 hasAttribute ($attr)
 Checks if $attr is part of the definition fields or function attributes. More...
 hasDirtyData ()
 Returns true if the data is considered dirty and needs to be stored. More...
 remove ($conditions=null, $extraConditions=null)
 Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. More...
 setAttribute ($attr, $val)
 Sets the attribute $attr to the value $val. More...
 setHasDirtyData ($hasDirtyData)
 Sets whether the object has dirty data or not. More...
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it. More...
 sync ($fieldFilters=null)
 Makes sure data is stored if the data is considered dirty. More...

Static Public Member Functions

static loginUser ($login, $password, $authenticationMatch=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 fetchUnactivated ($sort=false, $limit=10, $offset=0)
 Return an array of unactivated eZUser object. More...
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 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 isCurrentUserRegistered ()
 Returns whether the current user is a registered user. 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 setCurrentlyLoggedInUser ($user, $userID, $flags=0)
 Makes sure the $user is set as the currently logged in user by updating the session and setting the necessary global variables. More...
static setFailedLoginAttempts ($userID, $value=false, $setByForce=false)
static site ()
static updateLastVisit ($userID, $updateLoginCount=false)
static updateLastVisitByLogout ($userID)
 Update LastVisit When a user logout. More...
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)
 Calls conditionTextByRow with an empty row and $conditions. More...
static conditionTextByRow ($conditions, $row)
 Generates an SQL sentence from the conditions $conditions and row data $row. More...
static count ($def, $conds=null, $field=null)
 Fetches the number of rows by using the object definition. More...
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array. More...
static escapeArray ($array)
 Escapes strings in an array with the help of eZDBInterface::escapeString(). More...
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 Fetches and returns an object based on the given parameters and returns is either as an object or as an array. More...
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)
 Creates an SQL query out of the different parameters and returns an array with the result. More...
static getShortAttributeName ($db, $def, $attrName)
 Returns the short attribute name (alias) if it's defined, given attribute name otherwise. More...
static handleRows ($rows, $class_name, $asObject)
 Creates PHP objects out of the database rows $rows. More...
static newObjectOrder ($def, $orderField, $conditions)
 Returns an order value which can be used for new items in table, for instance placement. More...
static removeObject ($def, $conditions=null, $extraConditions=null)
 Deletes the object from the table defined in $def with conditions $conditions and extra conditions $extraConditions. More...
static reorderObject ($def, $orderField, $conditions, $down=true)
 Moves a row in a database table. More...
static replaceFieldsWithShortNames ($db, $fieldDefs, &$fields)
 For the given array $fields treats its keys (for associative array) or values (for non-associative array) as table fields names and replaces them with short names (aliases) found in $fieldDefs. More...
static storeObject ($obj, $fieldFilters=null)
 Stores the data in $obj to database. More...
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 Sets row id $id2 to have the placement of row id $id1. More...
static updateObjectList ($parameters)
 Updates rows matching the given parameters. More...

Additional Inherited Members

- Public Attributes inherited from eZUser
 Authenticate by matching the email field. More...
 Authenticate by matching the login field. More...
 MD5 of password. More...
 MD5 of site, user and password. More...
 MD5 of user and password. More...
 Legacy support for mysql hashed passwords. More...
 Passwords in plaintext, should not be used for real sites. More...
- Public Attributes inherited from eZPersistentObject
- 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 userInfoExpiry ()
- Protected Attributes inherited from eZUser
 $UserCache = null
- Static Protected Attributes inherited from eZUser
static $anonymousId = null
static $userHasLoggedOut = false

Detailed Description

Handles logins for users defined a simple text file.

The handler will read the users from the text file defined in textfile.ini, the file contains multiple users on separate lines. Each line is again separated by a field-separator (default is tab).

Once a login is requested by a user the handler will do one of two things:

  • Login the user with the existing user object found in the system
  • Creates a new user with the information found in the text file and login with that user.

Member Function Documentation

eZTextFileUser::eZTextFileUser ( )


static eZTextFileUser::loginUser (   $login,
  $authenticationMatch = false 

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

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