View source for Class: I2CE User (4.0.12)

{{otherversions|Class: I2CE_User}}
This article describes the class ''I2CE_User'' .
*Extends the class: [[Class: I2CE_Fuzzy (4.0.12) | I2CE_Fuzzy]].
*Location: Part of the module [[I2CE Module List (4.0.12)#user|user]] in the package [https://launchpad.net/i2ce I2CE] 4.0.12-release
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L34 modules/User/lib/I2CE_User.php] on line 34
==Variables==
===$role===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L40 i2ce/modules/User/lib/I2CE_User.php] on line 40
*Type: public [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $role

===$username===
the username
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L45 i2ce/modules/User/lib/I2CE_User.php] on line 45
*Type: public [http://www.php.net/manual/en/language.types.string.php string ] $username

===$details===
@var public string $role the role associated to the user .  An array of user details
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L52 i2ce/modules/User/lib/I2CE_User.php] on line 52
*Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $details

===$logged_in===
flags the user as logged in
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L57 i2ce/modules/User/lib/I2CE_User.php] on line 57
*Type: protected [http://www.php.net/manual/en/language.types.boolean.php boolean ] $logged_in

===$locale===
@var protected string $localeThe preferred locale for the user
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L172 i2ce/modules/User/lib/I2CE_User.php] on line 172
*Type: protected $locale

===$id===
.  False or int, the id for this user.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L250 i2ce/modules/User/lib/I2CE_User.php] on line 250
*Type: protected [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $id

==Methods==
===__construct()===
Create a new instance of a user. If the username isn't given then it will be determined from the session array.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L286 i2ce/modules/User/lib/I2CE_User.php] on line 286
*Signature: public function __construct($username,$populate,$checkSession,$log)
*Parameters:
** integer $username <br/>The id of the user in the database.  or '0' (the detauls) to get it from the session
***Default Value: '0'
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $populate <br/>A flag to determine if the user should be automatically populated at creation. Defaults to true
***Default Value: true 
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $checkSession <br/>A flag to determine if we should check the $_SESSION for user information Defaults to true
***Default Value: true
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $log <br/>Defaults to true which means we log the activity
***Default Value: false 
===__get()===
Magic method to get user details
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L444 i2ce/modules/User/lib/I2CE_User.php] on line 444
*Signature: public function __get($detail)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $detail
*Returns: mixed.<br/>false on failure
===__set()===
Magic method to set user details
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L420 i2ce/modules/User/lib/I2CE_User.php] on line 420
*Signature: public function __set($detail,$value)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $detail
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $value
===__unset()===
Magic method to unset user details
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L435 i2ce/modules/User/lib/I2CE_User.php] on line 435
*Signature: public function __unset($detail)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $detail
===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 [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L99 i2ce/modules/User/lib/I2CE_User.php] on line 99
*Signature: public function changePassword($old_password,$new_password)
*Parameters:
** [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: boolean.<br/>true on success
===displayName()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L505 i2ce/modules/User/lib/I2CE_User.php] on line 505
*Signature: public function displayName()
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>The display name of this user.
===findUsersByInfo()===
Gets the userss by the indicated  details as well as the  role. @oaram boolean $role Defaults to false
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L524 i2ce/modules/User/lib/I2CE_User.php] on line 524
*Signature: static public function findUsersByInfo($role,$details,$include_internal)
*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()
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $include_internal <br/>Defaults to true in which case we include the internal administator user if it matches the given details/role
***Default Value: true
*Returns: mixed.<br/>I2CE_User on success, false on failure.
===generatePassword()===
Generate a password
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L80 i2ce/modules/User/lib/I2CE_User.php] on line 80
*Signature: static public function generatePassword()
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getDetailName()===
Returns the display name of the given detail
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L142 i2ce/modules/User/lib/I2CE_User.php] on line 142
*Signature: static public function getDetailName($detail)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $detail
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getId()===
Gets the user id from the username
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L257 i2ce/modules/User/lib/I2CE_User.php] on line 257
*Signature: public function getId()
*Returns: [http://www.php.net/manual/en/language.types.integer.php int ]<br/>or false on failure
===getPreferredLocale()===
Gets the prefered locales for the user
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L178 i2ce/modules/User/lib/I2CE_User.php] on line 178
*Signature: public function getPreferredLocale()
*Returns: $string
===getRole()===
Get's the role associated with a user.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L462 i2ce/modules/User/lib/I2CE_User.php] on line 462
*Signature: public function getRole()
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===hasDetail()===
check if  the specified detail can be set @params string $detail
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L64 i2ce/modules/User/lib/I2CE_User.php] on line 64
*Signature: static public function hasDetail($detail)
*Parameters:
**$detail 
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===hasPreferredLocale()===
Checks if  the prefered locale for the user has been saved
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L202 i2ce/modules/User/lib/I2CE_User.php] on line 202
*Signature: public function hasPreferredLocale()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===isRequired()===
Checks to see if the indicated detail is required $param string $detail returns boolean
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L156 i2ce/modules/User/lib/I2CE_User.php] on line 156
*Signature: static public function isRequired($detail)
*Parameters:
**$detail 
===logged_in()===
Checks to see if this user has been logged in
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L335 i2ce/modules/User/lib/I2CE_User.php] on line 335
*Signature: public function logged_in()
===login()===
Login the user and populate their details then an error message will be set on the [[Class: I2CE_Template (4.0.12) | template]].
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L349 i2ce/modules/User/lib/I2CE_User.php] on line 349
*Signature: public function login($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: boolean.<br/>True on success, error message  of failure
===logout()===
Log the user out of the system. @global array
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L480 i2ce/modules/User/lib/I2CE_User.php] on line 480
*Signature: public function logout()
===populate()===
Populate the member variables of this object. This will also update the user log to show the latest activity for this login.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L383 i2ce/modules/User/lib/I2CE_User.php] on line 383
*Signature: public function populate($details,$role,$id)
*Parameters:
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $details <br/>If null, we try to get the details and rolefrom the access mechanism if an array, it is the array of details with key the name of details.  Defaults to null. @param mixed role.  Default to null otherwise it should be a string, the role.
***Default Value: null
**$role 
***Default Value: null
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $id <br/>Defaults to false otherwise it should be an int  the id.
***Default Value: false 
*Returns: true<br/>on success
===save()===
Saves the user to the database. This method saves all the user data and updates the access the user has for this system.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L540 i2ce/modules/User/lib/I2CE_User.php] on line 540
*Signature: public function save($password)
*Parameters:
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $password <br/>If it is a string, it is the password to set for the user.  detaulst to false in which case we do not set the password
***Default Value: false
===setPassword()===
Set the password for the user
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L117 i2ce/modules/User/lib/I2CE_User.php] on line 117
*Signature: public function setPassword($password)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $password
*Returns: mixed.<br/>true on success. on failure it is false or a the message to display back to the user signifying why it  failed.
===setPreferredLocale()===
Sets the prefered locales for the user
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L222 i2ce/modules/User/lib/I2CE_User.php] on line 222
*Signature: public function setPreferredLocale($locale,$save)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $locale
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $save <br/>Defaults to true.
***Default Value: true
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>$locales.  false on failure  string or array of strings, the locales on success
===setRole()===
Get's the role associated with a user. @param string $ole
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L471 i2ce/modules/User/lib/I2CE_User.php] on line 471
*Signature: public function setRole($role)
*Parameters:
**$role 
===userExists()===
See if a user is in the system
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L128 i2ce/modules/User/lib/I2CE_User.php] on line 128
*Signature: static 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()===
Checks to see if the specified user has the given password
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L268 i2ce/modules/User/lib/I2CE_User.php] on line 268
*Signature: static 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 ]
===username()===
Get the username
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.12-release/annotate/head:/modules/User/lib/I2CE_User.php#L498 i2ce/modules/User/lib/I2CE_User.php] on line 498
*Signature: public function username()
==Inherited Methods==
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy (4.0.12)#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Fuzzy Methods==
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy (4.0.12)#userMessage() | I2CE_Fuzzy->userMessage()]]


[[Category:Class Documentation (4.0.12)]]