Class: I2CE UserAccess LDAP (Development)

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

This article describes the class I2CE_UserAccess_LDAP .

• Extends the class: I2CE_UserAccess_Mechanism.
• Location: Part of the module UserAccess_LDAP in the package I2CE 4.1-dev
• Source: Defined in the file modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v4.0.3

@filesource Class I2CE_UserAccess_LDAP

Variables

$options

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

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 66
• Type: protected $options

$ldap

the ldap connect;

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 83
• Type: protected resource $ldap

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_LDAP/lib/I2CE_UserAccess_LDAP.php on line 670
• 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_LDAP/lib/I2CE_UserAccess_LDAP.php on line 746
• 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

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

_getUserIds()

Gets the user id

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 279
• Signature: public function _getUserIds()
• Returns: array
  of ids

_getUserInfo()

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

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 380
• 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

_getUserNameFromId()

Gets the user id from the username

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 331
• 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_LDAP/lib/I2CE_UserAccess_LDAP.php on line 494
• 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_LDAP/lib/I2CE_UserAccess_LDAP.php on line 730
• 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_LDAP/lib/I2CE_UserAccess_LDAP.php on line 431
• 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_LDAP/lib/I2CE_UserAccess_LDAP.php on line 254
• 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_LDAP/lib/I2CE_UserAccess_LDAP.php on line 165
• Signature: public function canChangePassword()
• Returns: boolean

canCreateNewUser()

Whether or not this acccess mechansim can create ne users

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 181
• 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_LDAP/lib/I2CE_UserAccess_LDAP.php on line 173
• Signature: public function canEditUserDetails()
• Returns: boolean

displayName()

Gets the display name for the user

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

encryptPassword()

Encrypts the password

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 129
• Signature: protected function encryptPassword($passwd)
• Parameters:
  • string $passwd
• Returns: string

ensureDefaultOptions()

ensrure default options are set

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

ensureID()

Ensures that an id is set for the given username @param string $usernmae

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 552
• Signature: protected function ensureID($username)
• Parameters:
  • $username
• Returns: int
  the id, 0 on failure

getAllowedDetails()

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

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 190
• Signature: public function getAllowedDetails()
• Returns: array

getConnection()

Get the ldap connection @param string $dn. The dn underwhich the user lives. Defaults to null in which case we user $this->options['ldap_user_dn'];

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 92
• Signature: protected function getConnection($cached,$bind_user,$bind_dn,$bind_pass)
• Parameters:
  • boolean $cached
    Defaiults to true in which case we get the cached connection
    • Default Value: true
  • boolean $bind_user
    Defaults to null in which case we get the user from $this->options['ldap_user']
    • Default Value: null
  • $bind_dn
    • Default Value: null
  • boolean $bind_pass
    Defaults to null in which case we get the user from $this->options['ldap_user']
    • Default Value: null
• Returns: mixed.
  False on failure or resource on success

getDetailName()

Returns the display name of the given detail

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 153
• Signature: public function getDetailName($detail)
• Parameters:
  • string $detail
• Returns: string

getIdQry()

Gets the id query for the application for the given username

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 220
• Signature: protected function getIdQry($username)
• Parameters:
  • string $username
    Defaults to null in which we get the dn for the node containing the uid's
    • Default Value: null
• Returns: string

getPeopleQry()

Gets the query for the people for the given username

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 239
• Signature: protected function getPeopleQry($username)
• Parameters:
  • string $username
    Defaults to null in which we get the dn for the node containing the uid's
    • Default Value: null
• Returns: string

getRoleQry()

Gets the role query for the application for the given username

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 202
• Signature: protected function getRoleQry($username)
• Parameters:
  • string $username
    Defaults to null in which we get the dn for the node containing the uid's
    • Default Value: null
• Returns: string

getUIDFromDN()

Looks for the UID in a DN

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 357
• Signature: protected function getUIDFromDN($dn)
• Parameters:
  • string $dn
• Returns: mixed.
  String, the uid on success, false on failure

ldap_escape()

LDAP escaping function to prevent against injection.

• Defined in i2ce/modules/User/modules/UserAccess_LDAP/lib/I2CE_UserAccess_LDAP.php on line 44
• Signature: protected function ldap_escape($str,$for_dn)
• Parameters:
  • string $str
    the string to escape
  • booleans $for_dn
    Defaults to false. True if we are escaping for a dn returns string
    • Default Value: false

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_LDAP/lib/I2CE_UserAccess_LDAP.php on line 772
• 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_LDAP/lib/I2CE_UserAccess_LDAP.php on line 682
• 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_LDAP/lib/I2CE_UserAccess_LDAP.php on line 607
• 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()

_userHasDefaultPassword()

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

changePassword()

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

createUser()

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

doAutoLogin()

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

generatePassword()

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

getAutoLoginUser()

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

getSessionActivity()

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

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()

hasBeenLoggedOut()

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

hasSession()

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

isLoggingFromAnotherIP()

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

isRequired()

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

logOutPreviousSessions()

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

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()

updateSessionActivity()

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

userExists()

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

userHasDefaultPassword()

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

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()