Class: I2CE UserAccess LDAP (4.1.7)

From IHRIS Wiki
(Redirected from Class: I2CE UserAccess LDAP)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
For other versions, see Class: I2CE_UserAccess_LDAP (versions) .


This article describes the class I2CE_UserAccess_LDAP .

@filesource Class I2CE_UserAccess_LDAP

Variables

$options

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

$ldap

the ldap connect;

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.

_createUser()

Create user worker method

_getUserId()

Gets the user id from the username

_getUserIds()

Gets the user id

_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

_getUsersByInfo()

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

_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

_userHasPassword()

verifies that the specified user has the specified password

canChangePassword()

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

canCreateNewUser()

Whether or not this acccess mechansim can create ne users

canEditUserDetails()

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

displayName()

Gets the display name for the user

encryptPassword()

Encrypts the password

ensureDefaultOptions()

ensrure default options are set

ensureID()

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

getAllowedDetails()

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

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

getIdQry()

Gets the id query for the application for the given username

getPeopleQry()

Gets the query for the people for the given username

getRoleQry()

Gets the role query for the application for the given username

getUIDFromDN()

Looks for the UID in a DN

ldap_escape()

LDAP escaping function to prevent against injection.

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

setPerson()

Set the person details.

setRole()

Sets the role in the ldap hierarchy for the indicated user

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

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

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

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_UserAccess_LDAP_(4.1.7)&oldid=50654"