Class: I2CE UserAccess Single (4.1.7)

For other versions, see Class: I2CE_UserAccess_Single (versions) .

This article describes the class I2CE_UserAccess_Single .

• Extends the class: I2CE_UserAccess_Mechanism.
• Location: Part of the module UserAccess_Single in the package I2CE 4.1.7-release
• Source: Defined in the file modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v4.1.0

@filesource Class I2CE_UserAccess_Single

Variables

$options

An array of options for connecting and querying to the ldap server

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 107
• Type: protected $options

Methods

_changePassword()

Change the password for this user. Worker method This will update a user's record to change the password in the database. It checks to make sure the new password matches the confirmation.

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 325
• Signature: public function _changePassword($username,$old_password,$new_password)
• Parameters:
  • string $username
  • string $old_password
  • string $new_password
• Returns: boolean
  true on success

_createUser()

Create user worker method

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 361
• Signature: public function _createUser($username,$password,$role,$details)
• Parameters:
  • string $username
  • string $password
  • string $role
    Defaults to false
    • Default Value: false
  • array $details
    Defatuls to empty array,
    • Default Value: array()
• Returns: boolean.
  true on success

_getUserId()

Gets the user id from the username. Worker method

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 288
• Signature: public function _getUserId($username)
• Parameters:
  • string $username
• Returns: int
  or false on failure

_getUserIds()

Gets the user ids @param string $username

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 260
• Signature: public function _getUserIds()

_getUserInfo()

Gets the indicated user details as well as the role. worker function

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 177
• Signature: protected function _getUserInfo($username,$getRole,$details)
• Parameters:
  • string $username
    the user name @oaram boolean $getRole Defaults to false
  • $getRole
    • Default Value: false
  • array $details
    of string. The details we wish on the user. Defaults to empty array
    • Default Value: array()
• Returns: array
  with indexed by the values of $details and values the corresponding detail. Returns false on failure

_getUserNameFromId()

Gets the user id from the username

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 272
• Signature: public function _getUserNameFromId($userid)
• Parameters:
  • int $userid
• Returns: string
  or false on failure

_getUsersByInfo()

Gets the userss by the indicated details as well as the role. worker method @oaram boolean $role Defaults to false

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 208
• Signature: public function _getUsersByInfo($role,$details)
• Parameters:
  • $role
    • Default Value: false
  • array $details
    of string. The details we wish on the user. Defaults to empty array
    • Default Value: array()
• Returns: array
  of usernames which mathc the give input

_setUserInfo()

sets the indicated user details/role . worker function

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 348
• Signature: protected function _setUserInfo($username,$setRole,$details)
• Parameters:
  • string $username
    the user name
  • mixed $setRole
    Defaulst to false. If a string, it is the role to assign to the user
    • Default Value: false
  • array $details
    of string. The keys are the detail, e.g. 'email' and the value at the key is the value of that detail
    • Default Value: array()
• Returns: boolean
  true on success

_userExists()

See if a user is in the system

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 248
• Signature: public function _userExists($username,$has_role)
• Parameters:
  • string $username
  • boolean $has_role
    If true we verify that they have a role set.
• Returns: boolean.

_userHasPassword()

verifies that the specified user has the specified password.

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 47
• Signature: public function _userHasPassword($username,$password)
• Parameters:
  • string $username
  • string $password
• Returns: boolean

canChangePassword()

Whether or not this acccess mechansim can change a user's password

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 115
• Signature: public function canChangePassword()
• Returns: boolean

canCreateNewUser()

Whether or not this acccess mechansim can create ne users

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 131
• Signature: public function canCreateNewUser()
• Returns: boolean

canEditUserDetails()

Whether or not this acccess mechansim can create edit details of existing users

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 123
• Signature: public function canEditUserDetails()
• Returns: boolean

displayName()

Gets the display name for the user

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 153
• Signature: public function displayName($username,$user)
• Parameters:
  • string $username
  • array $user
    details
• Returns: string

doAutoLogin()

Check to see if we should do a automatic login

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 38
• Signature: public function doAutoLogin()

ensureDefaultOptions()

ensrure default options are set

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 61
• Signature: public function ensureDefaultOptions($options)
• Parameters:
  • array $options
• Returns: array

getAllowedDetails()

Gets an array of the allowed user details such as email, firstname, lastname

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 140
• Signature: public function getAllowedDetails()
• Returns: array

logActivity()

Logs a user activiity @param string $actitivty, such as login, logout, access. Default is access @param int $timesamp. Defaults to null, in which case it should be now

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 371
• Signature: public function logActivity($username,$activity,$timestamp)
• Parameters:
  • string $username
  • $activity
    • Default Value: 'access'
  • $timestamp
    • Default Value: null

setPerson()

Set the person details.

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 336
• Signature: protected function setPerson($username,$password,$details,$create)
• Parameters:
  • string $username
  • $password
  • array $details
  • boolean $create

setRole()

Sets the role in the ldap hierarchy for the indicated user

• Defined in i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php on line 308
• Signature: protected function setRole($username,$role)
• Parameters:
  • string $username
  • string $role
• Returns: boolean.
  true on success

Inherited Methods

__construct()

This public method is inherited from I2CE_UserAccess_Mechanism->__construct()

changePassword()

This public method is inherited from I2CE_UserAccess_Mechanism->changePassword()

createUser()

This public method is inherited from I2CE_UserAccess_Mechanism->createUser()

generatePassword()

This public method is inherited from I2CE_UserAccess_Mechanism->generatePassword()

getAutoLoginUser()

This public method is inherited from I2CE_UserAccess_Mechanism->getAutoLoginUser()

getDetailName()

This public method is inherited from I2CE_UserAccess_Mechanism->getDetailName()

getSessionDetails()

This public method is inherited from I2CE_UserAccess_Mechanism->getSessionDetails()

getSessionID()

This public method is inherited from I2CE_UserAccess_Mechanism->getSessionID()

getSessionRole()

This public method is inherited from I2CE_UserAccess_Mechanism->getSessionRole()

getSessionUserName()

This public method is inherited from I2CE_UserAccess_Mechanism->getSessionUserName()

getUserId()

This public method is inherited from I2CE_UserAccess_Mechanism->getUserId()

getUserIds()

This public method is inherited from I2CE_UserAccess_Mechanism->getUserIds()

getUserInfo()

This public method is inherited from I2CE_UserAccess_Mechanism->getUserInfo()

getUserNameFromId()

This public method is inherited from I2CE_UserAccess_Mechanism->getUserNameFromId()

getUsersByInfo()

This public method is inherited from I2CE_UserAccess_Mechanism->getUsersByInfo()

hasSession()

This public method is inherited from I2CE_UserAccess_Mechanism->hasSession()

isRequired()

This public method is inherited from I2CE_UserAccess_Mechanism->isRequired()

setSession()

This public method is inherited from I2CE_UserAccess_Mechanism->setSession()

setUserInfo()

This public method is inherited from I2CE_UserAccess_Mechanism->setUserInfo()

unsetSession()

This public method is inherited from I2CE_UserAccess_Mechanism->unsetSession()

userExists()

This public method is inherited from I2CE_UserAccess_Mechanism->userExists()

userHasPassword()

This public method is inherited from I2CE_UserAccess_Mechanism->userHasPassword()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Variables

$options

Theis protected variable is inherited from I2CE_UserAccess_Mechanism->$options

$protocol

Theis protected variable is inherited from I2CE_UserAccess_Mechanism->$protocol

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()