Class: I2CE UserAccess Mechanism (Development)

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

This article describes the class I2CE_UserAccess_Mechanism .

• Extends the class: I2CE_Fuzzy.
• Child Classes:
  • I2CE_UserAccess
  • I2CE_UserAccess_DHIS
  • I2CE_UserAccess_LDAP
  • I2CE_UserAccess_LDAP_DB
  • I2CE_UserAccess_Single
• Location: Part of the module I2CE in the package I2CE 4.1-dev
• Source: Defined in the file lib/I2CE_UserAccess_Mechanism.php on line 33
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v4.0.3

@filesource Class I2CE_UserAccess_Mechanism

Variables

$options

. Intialization options

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 37
• Type: protected array $options

$protocol

. The user access protocol this is.

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 42
• Type: protected string $protocol

Methods

__construct()

Create a new instance of a default I2CE table user access mechanism

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 46
• Signature: public function __construct()

_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/lib/I2CE_UserAccess_Mechanism.php on line 473
• 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/lib/I2CE_UserAccess_Mechanism.php on line 515
• 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/lib/I2CE_UserAccess_Mechanism.php on line 176
• 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/lib/I2CE_UserAccess_Mechanism.php on line 148
• Signature: public function _getUserIds()

_getUserInfo()

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

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 318
• 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/lib/I2CE_UserAccess_Mechanism.php on line 198
• 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/lib/I2CE_UserAccess_Mechanism.php on line 403
• 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/lib/I2CE_UserAccess_Mechanism.php on line 353
• 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/lib/I2CE_UserAccess_Mechanism.php on line 594
• 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.

_userHasDefaultPassword()

verifies that the specified user has the specified password. @param string $password

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 240
• Signature: public function _userHasDefaultPassword($username)
• Parameters:
  • string $username
• Returns: boolean

_userHasPassword()

verifies that the specified user has the specified password.

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 264
• 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/lib/I2CE_UserAccess_Mechanism.php on line 413
• Signature: public function canChangePassword()
• Returns: boolean

canCreateNewUser()

Whether or not this acccess mechansim can create ne users

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 207
• Signature: public function canCreateNewUser()
• Returns: boolean

canEditUserDetails()

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

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 215
• Signature: public function canEditUserDetails()
• Returns: boolean

changePassword()

Change the password for this user. 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/lib/I2CE_UserAccess_Mechanism.php on line 447
• Signature: final public function changePassword($username,$old_password,$new_password)
• Parameters:
  • string $username
  • string $old_password
    If false then we don't check against the old password
  • string $new_password
• Returns: booelan.
  true on success

createUser()

Create user .

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 488
• Signature: final public function createUser($username,$password,$role,$details)
• Parameters:
  • string $username
  • string $password
  • string $role
    Defaults to false
  • array $details
    Defatuls to empty array,
    • Default Value: array()
• Returns: boolean.
  true on success

displayName()

Gets the display name for the userdetails

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 605
• Signature: public function displayName($username,$user)
• Parameters:
  • string $username
  • array $user
    user details
• Returns: string

doAutoLogin()

Check to see if we should do a automatic login

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 83
• Signature: public function doAutoLogin()

ensureDefaultOptions()

Ensure default options are set

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 99
• Signature: protected function ensureDefaultOptions($options)
• Parameters:
  • array $options
• Returns: array;

generatePassword()

Generate a password

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 112
• Signature: public function generatePassword()
• Returns: string

getAllowedDetails()

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

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 273
• Signature: public function getAllowedDetails()
• Returns: array

getAutoLoginUser()

Get the username for an autologin

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 90
• Signature: public function getAutoLoginUser()
• Returns: string

getDetailName()

Returns the display name of the given detail

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 422
• Signature: public function getDetailName($detail)
• Parameters:
  • string $detail
• Returns: string

getSessionActivity()

Get the last activity time for this session.

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 724
• Signature: static final public function getSessionActivity()
• Returns: integer

getSessionDetails()

Get any user details stored in the session

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 710
• Signature: static final public function getSessionDetails()
• Returns: mixed.
  an array of details on succes, null on failture

getSessionID()

Get any user id

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 697
• Signature: static final public function getSessionID()
• Returns: mixed.
  an int on succes, false on failture

getSessionRole()

Get any user role

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 684
• Signature: static final public function getSessionRole()
• Returns: mixed.
  an strint on succes, null on failture

getSessionUserName()

Get any username stored in the suession

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 672
• Signature: static final public function getSessionUserName()
• Returns: mixed.
  an string on succes, null on failture

getUserId()

Gets the user id from the username

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 157
• Signature: final public function getUserId($username)
• Parameters:
  • string $username
• Returns: int
  or false on failure

getUserIds()

Gets the user ids

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 134
• Signature: final public function getUserIds()
• Returns: array
  of ids

getUserInfo()

Gets the indicated user details as well as the role

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 284
• Signature: final public 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 failture

getUserNameFromId()

Gets the user id from the username

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 185
• Signature: final 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/lib/I2CE_UserAccess_Mechanism.php on line 365
• Signature: public function getUsersByInfo($role,$details,$include_internal)
• Parameters:
  • $role
    • Default Value: false
  • array $details
    of string. The details we wish on the user. Defaults to empty array
    • Default Value: array()
  • boolean $include_internal
    Defaults to true. If so, then we include the internal administrator user if they match the given details and role
    • Default Value: true
• Returns: array
  of usernames which mathc the give input

hasBeenLoggedOut()

Checks to see if this user has been logged out by other means to invalidate login. This is a placeholder to be implemented in sub classes.

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 551
• Signature: public function hasBeenLoggedOut($username)
• Parameters:
  • string $username
• Returns: boolean

hasSession()

Checks to see if a user has been stored in the session

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 642
• Signature: static final public function hasSession()

isLoggingFromAnotherIP()

Checks to see if a person is logging in from another IP address. This is a placeholder than sub classes can implement. No checks can be done from here.

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 540
• Signature: public function isLoggingFromAnotherIP($username,$ip_address)
• Parameters:
  • string $username
  • string $ip_address
• Returns: boolean

isRequired()

Checks to see if the indicated detail is required $param string $detail returns boolean

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 432
• Signature: public function isRequired($detail)
• Parameters:
  • $detail

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/lib/I2CE_UserAccess_Mechanism.php on line 528
• Signature: public function logActivity($username,$activity,$ip_address,$timestamp)
• Parameters:
  • string $username
  • $activity
    • Default Value: 'access'
  • $ip_address
    • Default Value: '127.0.0.1'
  • $timestamp
    • Default Value: null

logOutPreviousSessions()

Logs out other sessions with the same username if single login option is set. This does nothing in the base class, but can be implemented in subclasses.

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 563
• Signature: public function logOutPreviousSessions($username)
• Parameters:
  • string $username
• Returns: boolean

setSession()

Store info on the authenticated user in session variables @param array $deatails. array of user details

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 616
• Signature: static final public function setSession($username,$role,$details,$id)
• Parameters:
  • string $username
  • string $role
  • $details
  • $id

setUserInfo()

sets the indicated user details/role.

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 330
• Signature: final public 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

unsetSession()

Store info on the authenticated user in session variables @param string $username @param string $role @param array $deatails. array of user details

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 631
• Signature: static final public function unsetSession()

updateSessionActivity()

Update the session activity time.

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 735
• Signature: static final public function updateSessionActivity()

userExists()

See if a user is in the system

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 579
• Signature: final public function userExists($username,$has_role)
• Parameters:
  • string $username
  • boolean $has_role
    If true we verify that they have a role set.
• Returns: boolean.

userHasDefaultPassword()

checks to see if a user has a default password. @param string $password

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 225
• Signature: final public function userHasDefaultPassword($username)
• Parameters:
  • string $username
• Returns: boolean

userHasPassword()

verifies that the specified user has the specified password.

• Defined in i2ce/lib/I2CE_UserAccess_Mechanism.php on line 250
• Signature: final public function userHasPassword($username,$password)
• Parameters:
  • string $username
  • string $password
• Returns: boolean

Inherited Methods

_hasMethod()

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

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()