|
|
| (20 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class ''I2CE_User''.
| | #REDIRECT [[Class: I2CE_User (4.1.7)]] |
| *Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]].
| |
| *Location: Part of the module [[iHRIS Module List#user|user]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/User/lib/I2CE_User.php modules/User/lib/I2CE_User.php]
| |
| ==Variables==
| |
| ===$userDB===
| |
| The user database -- may be empty to use the database that is currently being used set base on the value of I2CE::getConfig()->database->user
| |
| *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $userDB
| |
| | |
| ===$id===
| |
| *Type: public $id
| |
| | |
| ===$username===
| |
| *Type: public $username
| |
| | |
| ===$password===
| |
| *Type: public $password
| |
| | |
| ===$firstname===
| |
| *Type: public $firstname
| |
| | |
| ===$lastname===
| |
| *Type: public $lastname
| |
| | |
| ===$email===
| |
| *Type: public $email
| |
| | |
| ===$role===
| |
| *Type: public $role
| |
| | |
| ===$creator===
| |
| *Type: public $creator
| |
| | |
| ===$md5password===
| |
| *Type: public $md5password
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| Create a new instance of a user. If the id isn't given then it will be determined from the session array.
| |
| *Signature: public function __construct($id,$populate,$checkSession,$log)
| |
| *Parameters:
| |
| ** integer $id <br/>The id of the user in the database.
| |
| ***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['userid'] for a user id. 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 dot record this in the login table
| |
| ***Default Value: true
| |
| ===addUserLog()===
| |
| Add a new record to the user log for this user showing they have logged in. @global array
| |
| *Signature: private function addUserLog()
| |
| ===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.
| |
| *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: [http://www.php.net/manual/en/language.types.array.php array ]<br/>keys are 'sucess' and 'message' the message to display back to the user signifying success or failure. @global array
| |
| ===displayName()===
| |
| *Signature: public function displayName()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>The first initial and last name of this user.
| |
| ===findUser()===
| |
| *Signature: static public function findUser($field,$value,$log)
| |
| *Parameters:
| |
| *$field
| |
| *$value
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $log <br/>Defaults to false whch means we do not record this in the login table
| |
| ***Default Value: false
| |
| ===getId()===
| |
| Get the ID of the user
| |
| *Signature: public function getId()
| |
| *Returns: integer
| |
| ===getPreferredLocale()===
| |
| Gets the prefered locales for the user
| |
| *Signature: public function getPreferredLocale()
| |
| *Returns: $string
| |
| ===getRole()===
| |
| Get's the role associated with a user.
| |
| *Signature: public function getRole()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getUserDB()===
| |
| Returns the database where the user table can be found. This will add the trailing period if it isn't already there.
| |
| *Signature: static public function getUserDB()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===logged_in()===
| |
| Checks to see if the user is logged in.
| |
| *Signature: public function logged_in()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===login()===
| |
| Login the user. Check the login and password of the user and log them in. If the password is incorrect then an error message will be set on the [[Class: I2CE_Template | template]].
| |
| *Signature: public function login($username,$password,$template)
| |
| *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
| |
| ** [[Class: I2CE_Template | I2CE_Template]] $template @global array
| |
| ===logout()===
| |
| Log the user out of the system. @global array
| |
| *Signature: public function logout()
| |
| ===mailPassword()===
| |
| *Signature: protected function mailPassword()
| |
| ===populate()===
| |
| Populate the member variables of this object. This will also update the user log to show the latest activity for this login.
| |
| *Signature: public function populate($update_log)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $update_log @global array
| |
| ***Default Value: true
| |
| ===save()===
| |
| Saves the user to the database. This method saves all the user data and updates the access the user has for this system. @global array
| |
| *Signature: public function save($transact)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $transact <br/>Defaults to true meaning to wrap the save in a transaction.
| |
| ***Default Value: true
| |
| ===setCreator()===
| |
| Set the creator id of this user.
| |
| *Signature: public function setCreator($creator)
| |
| *Parameters:
| |
| ** integer $creator
| |
| ===setId()===
| |
| Sets the id of the user if not known at creation.
| |
| *Signature: public function setId($id)
| |
| *Parameters:
| |
| ** integer $id
| |
| ===setPassword()===
| |
| *Signature: public function setPassword($password,$do_email)
| |
| *Parameters:
| |
| *$password
| |
| *$do_email
| |
| ***Default Value: true
| |
| ===setPreferredLocale()===
| |
| Sets the prefered locales for the user
| |
| *Signature: public function setPreferredLocale($locale)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $locale
| |
| *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
| |
| ===username()===
| |
| Get the username
| |
| *Signature: public function username()
| |
| ==Inherited Fuzzy Methods==
| |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
