Class: I2CE User (4.0.12)

From IHRIS Wiki
Revision as of 10:45, 10 March 2011 by Litlfred (talk | contribs) (Created page with '{{otherversions|Class: I2CE_User}} This article describes the class ''I2CE_User'' . *Extends the class: I2CE_Fuzzy. *Location: Part of the module…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
For other versions, see Class: I2CE_User (versions) .


This article describes the class I2CE_User .

Variables

$role

$username

the username

$details

@var public string $role the role associated to the user . An array of user details

$logged_in

flags the user as logged in

$locale

@var protected string $localeThe preferred locale for the user

$id

. False or int, the id for this user.

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 i2ce/modules/User/lib/I2CE_User.php on line 286
  • Signature: public function __construct($username,$populate,$checkSession,$log)
  • Parameters:
    • integer $username
      The id of the user in the database. or '0' (the detauls) to get it from the session
      • Default Value: '0'
    • boolean $populate
      A flag to determine if the user should be automatically populated at creation. Defaults to true
      • Default Value: true
    • boolean $checkSession
      A flag to determine if we should check the $_SESSION for user information Defaults to true
      • Default Value: true
    • boolean $log
      Defaults to true which means we log the activity
      • Default Value: false

__get()

Magic method to get user details

__set()

Magic method to set user details

__unset()

Magic method to unset user details

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.

displayName()

findUsersByInfo()

Gets the userss by the indicated details as well as the role. @oaram boolean $role Defaults to false

  • Defined in i2ce/modules/User/lib/I2CE_User.php on line 524
  • Signature: static public function findUsersByInfo($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 in which case we include the internal administator user if it matches the given details/role
      • Default Value: true
  • Returns: mixed.
    I2CE_User on success, false on failure.

generatePassword()

Generate a password

getDetailName()

Returns the display name of the given detail

getId()

Gets the user id from the username

getPreferredLocale()

Gets the prefered locales for the user

getRole()

Get's the role associated with a user.

hasDetail()

check if the specified detail can be set @params string $detail

hasPreferredLocale()

Checks if the prefered locale for the user has been saved

isRequired()

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

logged_in()

Checks to see if this user has been logged in

login()

Login the user and populate their details then an error message will be set on the template.

logout()

Log the user out of the system. @global array

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 i2ce/modules/User/lib/I2CE_User.php on line 383
  • Signature: public function populate($details,$role,$id)
  • Parameters:
    • mixed $details
      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
    • mixed $id
      Defaults to false otherwise it should be an int the id.
      • Default Value: false
  • Returns: true
    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 i2ce/modules/User/lib/I2CE_User.php on line 540
  • Signature: public function save($password)
  • Parameters:
    • mixed $password
      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 i2ce/modules/User/lib/I2CE_User.php on line 117
  • Signature: public function setPassword($password)
  • Parameters:
  • Returns: mixed.
    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 i2ce/modules/User/lib/I2CE_User.php on line 222
  • Signature: public function setPreferredLocale($locale,$save)
  • Parameters:
  • Returns: string
    $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

userExists()

See if a user is in the system

userHasPassword()

Checks to see if the specified user has the given password

username()

Get the username

Inherited Methods

_hasMethod()

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

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_User_(4.0.12)&oldid=37581"