Class: I2CE UserAccess (4.0.3)

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

This article describes the class I2CE_UserAccess .

• Extends the class: I2CE_UserAccess_Mechanism.
• Location: Part of the module UserAccess in the package I2CE 4.0.3-release
• Source: Defined in the file modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 34
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v4.0.3

@filesource Class I2CE_UserAccess_Internal A user access control mechansim where username and the user details are stored in one table and access is in another table and the tables are joined on a userid.

Variables

$detailTable

@var protected string $userTable the user detail table.

• Defined in i2ce/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 147
• Type: protected $detailTable

$accessTable

the user access table.

• Defined in i2ce/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 152
• Type: protected string $accessTable

$logTable

the user acitivity log table.

• Defined in i2ce/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 159
• Type: protected string $logTable

Methods

__construct()

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

• Defined in i2ce/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 136
• 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/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 392
• Signature: public function _changePassword($username,$old_password,$new_password)
• Parameters:
  • string $username
  • string $old_password
  • string $new_password
• Returns: boolean

_createUser()

Create user worker method

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

_getUserId()

Gets the user id from the user name

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

_getUserInfo()

Gets the indicated user details as well the role

• Defined in i2ce/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 218
• Signature: public function _getUserInfo($username,$getRole,$details)
• Parameters:
  • string $username @oaram boolean $getRole Defaults to false
  • $getRole
    • Default Value: false
  • $details
    • Default Value: array()
• Returns: array.
  associative array of user info (role, email and other details)

_getUserNameFromId()

Gets the user id from the username

• Defined in i2ce/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 365
• 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/lib/I2CE_UserAccess.php on line 259
• 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()

Gets the role assigned to a user

• Defined in i2ce/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 174
• Signature: public function _setUserInfo($username,$setRole,$details)
• Parameters:
  • string $username
  • mixed $setRole
    Defaulst to false. If a string, it is the role to assign to the user @param string
    • Default Value: false
  • $details
    • Default Value: array()
• Returns: boolean.
  true on success

_userExists()

See if a user is in the system

• Defined in i2ce/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 320
• 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/lib/I2CE_UserAccess.php on line 422
• 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/lib/I2CE_UserAccess.php on line 308
• Signature: public function canChangePassword()
• Returns: boolean

canCreateNewUser()

Whether or not this acccess mechansim can create ne users

• Defined in i2ce/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 50
• 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/lib/I2CE_UserAccess.php on line 58
• Signature: public function canEditUserDetails()
• Returns: boolean

displayName()

Gets the display name for the user

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

encryptPassword()

Encrypts the password @param string $passwd

• Defined in i2ce/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 42
• Signature: protected function encryptPassword($password)
• Parameters:
  • $password
• Returns: string

ensureDefaultOptions()

ensrure default options are set

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

getAllowedDetails()

Gets an array of the allowed details

• Defined in i2ce/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 68
• Signature: public function getAllowedDetails()
• Returns: array

getDetailColumnTypes()

An array of the details and their associated mdb2 types

• Defined in i2ce/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 92
• Signature: protected function getDetailColumnTypes()

getDetailColumns()

An array of the details and their associated columns

• Defined in i2ce/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 78
• Signature: protected function getDetailColumns()

getDetailName()

Returns the display name of the given detail

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

isRequired()

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

• Defined in i2ce/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 505
• 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/modules/User/modules/UserAccess/lib/I2CE_UserAccess.php on line 452
• Signature: public function logActivity($username,$activity,$timestamp)
• Parameters:
  • string $username
  • $activity
    • Default Value: 'access'
  • $timestamp
    • Default Value: null

Inherited Methods

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

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

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

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