Class: I2CE User Form

This article describes the class I2CE_User_Form.

• Extends the class: I2CE_Form.
• Location: Part of the module UserForm in the package I2CE
• Source: Defined in the file modules/Forms/modules/UserForm/lib/I2CE_User_Form.php
• Author: Luke Duncan <lduncan@intrahealth.org>
• Since: v2.0.0

Object for dealing with system users. This class uses the interface to handle editing of users from within the system as well as handles role access for pages.

Form Fields

This class is a form class and provides the following form fields

username

The form field username is implemented by STRING_LINE 

password

The form field password is implemented by STRING_PASS 

confirm

The form field confirm is implemented by STRING_PASS 

firstname

The form field firstname is implemented by STRING_LINE 

lastname

The form field lastname is implemented by STRING_LINE 

email

The form field email is implemented by STRING_LINE 

role

The form field role is implemented by MAP 

creator

The form field creator is implemented by INT 

generate_password

The form field generate_password is implemented by YESNO 

Variables

$db

• Type: protected $db

$user_fields

an array of the fields which are handled by I2CE_User rather than by the form mechanism

• Type: protected array $user_fields

$user_form_fields

an array of the fields which are handled by I2CE_User rather than by the form mechanism and are also form fields @var protected array $user_fields

• Type: protected $user_form_fields

$user

The I2CE_User which makes up this form protected I2CE_User $user

• Type: protected $user

$userDB

The user database protected string $userDB

• Type: protected $userDB

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($form,$id)
• Parameters:
  • $form
    • Default Value: 'user'
  • integer $id
    The id of the user in the database.
    • Default Value: '0'

__get()

• Signature: public function __get($key)
• Parameters:
  • $key

__set()

Set the member variable in the array.

• Signature: protected function __set($key,$value)
• Parameters:
  • string $key
  • mixed $value

__unset()

Unset a member variable.

• Signature: protected function __unset($key)
• Parameters:
  • string $key

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($post)
• Parameters:
  • array &$post
• Returns: string
  The message to display back to the user signifying success or failure. @global array

clearFields()

Remove fields from the form. This is to be used when only certain fields of the form are being dealt with so the others can be removed to save processing.

• Signature: public function clearFields($fields,$keep)
• Parameters:
  • array $fields
    The fields being worked with.
  • boolean $keep
    A flag to determine if the given fields should be removed or all except the given fields.
    • Default Value: true

displayName()

• Signature: public function displayName()
• Returns: string
  The first initial and last name of this user.

getRoleNameFromShortName()

Get the display name associated to a role's shortname

• Signature: static public function getRoleNameFromShortName($name)
• Parameters:
  • string $name
    the shortname of the role
• Returns: string

getTrickleUpFromShortName()

Returns the role trickle up from the shortname

• Signature: static public function getTrickleUpFromShortName($name)
• Parameters:
  • string $name
    the role shortname
• Returns: array
  (an empty array if there is no such tag name)

load()

Load the member variables from an array

• Signature: public function load($post,$loadID,$populate_on_set_id)
• Parameters:
  • array $post
    The Post vairables. Usually from an http request.
  • boolean $loadID
    Defaults to true. If true, and there is exactly one of entry in the array $post['forms'][$this->form_name], we set the values of the form's field, id and parent from that entry. If false, we set the values from $post['forms'][$this->form_name][$this->getID()] if it is present
    • Default Value: true
  • $populate_on_set_id
    • Default Value: true

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

tryGeneratePassword()

Try to generate a new password and assign it to the password and confirm variables.

• Signature: public function tryGeneratePassword()

validate()

Checks to make sure all the required fields are valid. Checks to make sure the username is unique in the system and that the password matches the confirmed password. @global array

• Signature: public function validate()