View source for Class: I2CE UserAccess Single (4.1.1)

{{otherversions|Class: I2CE_UserAccess_Single}}
This article describes the class ''I2CE_UserAccess_Single'' .
*Extends the class: [[Class: I2CE_UserAccess_Mechanism (4.1.1) | I2CE_UserAccess_Mechanism]].
*Location: Part of the module [[I2CE Module List (4.1.1)#UserAccess_Single|UserAccess_Single]] in the package [https://launchpad.net/i2ce I2CE] 4.1.1-release
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L33 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 [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L107 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 [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L325 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 325
*Signature: public function _changePassword($username,$old_password,$new_password)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $username
** [http://www.php.net/manual/en/language.types.string.php string ] $old_password
** [http://www.php.net/manual/en/language.types.string.php string ] $new_password
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success
===_createUser()===
Create user worker method
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L361 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 361
*Signature: public function _createUser($username,$password,$role,$details)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $username
** [http://www.php.net/manual/en/language.types.string.php string ] $password
** [http://www.php.net/manual/en/language.types.string.php string ] $role <br/>Defaults to false
***Default Value: false
** [http://www.php.net/manual/en/language.types.array.php array ] $details <br/>Defatuls to empty array,
***Default Value: array()
*Returns: boolean.<br/>true on success
===_getUserId()===
Gets the user id from the username. Worker method
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L288 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 288
*Signature: public function _getUserId($username)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $username
*Returns: [http://www.php.net/manual/en/language.types.integer.php int ]<br/>or false on failure
===_getUserIds()===
Gets the user ids @param string $username
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L260 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 [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L177 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 177
*Signature: protected function _getUserInfo($username,$getRole,$details)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $username <br/>the user name @oaram boolean $getRole Defaults to false
**$getRole 
***Default Value: false
** [http://www.php.net/manual/en/language.types.array.php array ] $details <br/>of string.  The details we wish on the user.  Defaults to empty array
***Default Value: array()
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>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 [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L272 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 272
*Signature: public function _getUserNameFromId($userid)
*Parameters:
** [http://www.php.net/manual/en/language.types.integer.php int ] $userid
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>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 [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L208 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
** [http://www.php.net/manual/en/language.types.array.php array ] $details <br/>of string.  The details we wish on the user.  Defaults to empty array
***Default Value: array()
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of usernames which mathc the give input
===_setUserInfo()===
sets the indicated user details/role . worker function
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L348 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 348
*Signature: protected function _setUserInfo($username,$setRole,$details)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $username <br/>the user name
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $setRole <br/>Defaulst to false.  If a string, it is the role to assign to the user
***Default Value: false
** [http://www.php.net/manual/en/language.types.array.php array ] $details <br/>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: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success
===_userExists()===
See if a user is in the system
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L248 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 248
*Signature: public function _userExists($username,$has_role)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $username
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $has_role <br/>If true  we verify that they have a role set.
*Returns: boolean.
===_userHasPassword()===
verifies that the specified user has the specified password.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L47 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 47
*Signature: public function _userHasPassword($username,$password)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $username
** [http://www.php.net/manual/en/language.types.string.php string ] $password
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===canChangePassword()===
Whether or not this acccess mechansim can change a user's password
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L115 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 115
*Signature: public function canChangePassword()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===canCreateNewUser()===
Whether or not this acccess mechansim can create ne users
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L131 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 131
*Signature: public function canCreateNewUser()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===canEditUserDetails()===
Whether or not this acccess mechansim can create edit details of existing users
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L123 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 123
*Signature: public function canEditUserDetails()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===displayName()===
Gets the display name for the user
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L153 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 153
*Signature: public function displayName($username,$user)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $username
** [http://www.php.net/manual/en/language.types.array.php array ] $user <br/>details
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===doAutoLogin()===
Check to see if we should do a automatic login
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L38 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 [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L61 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 61
*Signature: public function ensureDefaultOptions($options)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $options
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===getAllowedDetails()===
Gets an array of the allowed user details such as email, firstname, lastname
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L140 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 140
*Signature: public function getAllowedDetails()
*Returns: [http://www.php.net/manual/en/language.types.array.php 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 [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L371 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 371
*Signature: public function logActivity($username,$activity,$timestamp)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $username
**$activity 
***Default Value: 'access'
**$timestamp 
***Default Value: null
===setPerson()===
Set the person details.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L336 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 336
*Signature: protected function setPerson($username,$password,$details,$create)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $username
**$password 
** [http://www.php.net/manual/en/language.types.array.php array ] $details
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $create
===setRole()===
Sets the role in the ldap hierarchy for the indicated user
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1.1-release/annotate/head:/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php#L308 i2ce/modules/User/modules/UserAccess_SingleUser/lib/I2CE_UserAccess_Single.php] on line 308
*Signature: protected function setRole($username,$role)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $username
** [http://www.php.net/manual/en/language.types.string.php string ] $role
*Returns: boolean.<br/>true on success
==Inherited Methods==
===__construct()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#__construct() | I2CE_UserAccess_Mechanism->__construct()]]

===changePassword()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#changePassword() | I2CE_UserAccess_Mechanism->changePassword()]]

===createUser()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#createUser() | I2CE_UserAccess_Mechanism->createUser()]]

===generatePassword()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#generatePassword() | I2CE_UserAccess_Mechanism->generatePassword()]]

===getAutoLoginUser()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#getAutoLoginUser() | I2CE_UserAccess_Mechanism->getAutoLoginUser()]]

===getDetailName()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#getDetailName() | I2CE_UserAccess_Mechanism->getDetailName()]]

===getSessionDetails()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#getSessionDetails() | I2CE_UserAccess_Mechanism->getSessionDetails()]]

===getSessionID()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#getSessionID() | I2CE_UserAccess_Mechanism->getSessionID()]]

===getSessionRole()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#getSessionRole() | I2CE_UserAccess_Mechanism->getSessionRole()]]

===getSessionUserName()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#getSessionUserName() | I2CE_UserAccess_Mechanism->getSessionUserName()]]

===getUserId()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#getUserId() | I2CE_UserAccess_Mechanism->getUserId()]]

===getUserIds()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#getUserIds() | I2CE_UserAccess_Mechanism->getUserIds()]]

===getUserInfo()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#getUserInfo() | I2CE_UserAccess_Mechanism->getUserInfo()]]

===getUserNameFromId()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#getUserNameFromId() | I2CE_UserAccess_Mechanism->getUserNameFromId()]]

===getUsersByInfo()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#getUsersByInfo() | I2CE_UserAccess_Mechanism->getUsersByInfo()]]

===hasSession()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#hasSession() | I2CE_UserAccess_Mechanism->hasSession()]]

===isRequired()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#isRequired() | I2CE_UserAccess_Mechanism->isRequired()]]

===setSession()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#setSession() | I2CE_UserAccess_Mechanism->setSession()]]

===setUserInfo()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#setUserInfo() | I2CE_UserAccess_Mechanism->setUserInfo()]]

===unsetSession()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#unsetSession() | I2CE_UserAccess_Mechanism->unsetSession()]]

===userExists()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#userExists() | I2CE_UserAccess_Mechanism->userExists()]]

===userHasPassword()===
This public method is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#userHasPassword() | I2CE_UserAccess_Mechanism->userHasPassword()]]

===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy (4.1.1)#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Variables==
===$options===
Theis protected variable is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#$options | I2CE_UserAccess_Mechanism->$options]]

===$protocol===
Theis protected variable is inherited from [[Class: I2CE_UserAccess_Mechanism (4.1.1)#$protocol | I2CE_UserAccess_Mechanism->$protocol]]
==Inherited Fuzzy Methods==
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy (4.1.1)#userMessage() | I2CE_Fuzzy->userMessage()]]


[[Category:Class Documentation (4.1.1)]]