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 on line 33
• 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

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 105
• Type: protected $db

$user_fields

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

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 111
• 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

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 117
• Type: protected $user_form_fields

$user

The I2CE_User which makes up this form protected I2CE_User $user

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 163
• Type: protected $user

$userDB

The user database protected string $userDB

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 170
• 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.

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 87
• 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()

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 204
• Signature: public function __get($key)
• Parameters:
  • $key

__set()

Set the member variable in the array.

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 222
• Signature: protected function __set($key,$value)
• Parameters:
  • string $key
  • mixed $value

__unset()

Unset a member variable.

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 233
• 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.

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 141
• 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.

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 330
• 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()

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 126
• 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

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 69
• 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

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 42
• 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

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 183
• 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.

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 248
• 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

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 303
• Signature: public function save()

tryGeneratePassword()

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

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 264
• 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

• Defined in i2ce/modules/Forms/modules/UserForm/lib/I2CE_User_Form.php on line 282
• Signature: public function validate()

Inherited Methods

addChildForm()

This public method is inherited from I2CE_Form->addChildForm()

addField()

This public method is inherited from I2CE_Form->addField()

cleanup()

This public method is inherited from I2CE_Form->cleanup()

current()

This public method is inherited from I2CE_Form->current()

displayField()

This public method is inherited from I2CE_Form->displayField()

form()

This public method is inherited from I2CE_Form->form()

getAllowedParentForms()

This public method is inherited from I2CE_Form->getAllowedParentForms()

getAttribute()

This public method is inherited from I2CE_Form->getAttribute()

getChildForms()

This public method is inherited from I2CE_Form->getChildForms()

getChildFormsByForm()

This public method is inherited from I2CE_Form->getChildFormsByForm()

getChildren()

This public method is inherited from I2CE_Form->getChildren()

getDisplayName()

This public method is inherited from I2CE_Form->getDisplayName()

getField()

This public method is inherited from I2CE_Form->getField()

getFieldNames()

This public method is inherited from I2CE_Form->getFieldNames()

getFormId()

This public method is inherited from I2CE_Form->getFormId()

getHTMLName()

This public method is inherited from I2CE_Form->getHTMLName()

getId()

This public method is inherited from I2CE_Form->getId()

getParent()

This public method is inherited from I2CE_Form->getParent()

getParentForm()

This public method is inherited from I2CE_Form->getParentForm()

getParentID()

This public method is inherited from I2CE_Form->getParentID()

getQueryDisplay()

This public method is inherited from I2CE_Form->getQueryDisplay()

getQueryFields()

This public method is inherited from I2CE_Form->getQueryFields()

getQueryString()

This public method is inherited from I2CE_Form->getQueryString()

hasAttribute()

This public method is inherited from I2CE_Form->hasAttribute()

hasInvalid()

This public method is inherited from I2CE_Form->hasInvalid()

key()

This public method is inherited from I2CE_Form->key()

listFields()

This public method is inherited from I2CE_Form->listFields()

next()

This public method is inherited from I2CE_Form->next()

processDOM()

This public method is inherited from I2CE_Form->processDOM()

removeField()

This public method is inherited from I2CE_Form->removeField()

reset()

This public method is inherited from I2CE_Form->reset()

rewind()

This public method is inherited from I2CE_Form->rewind()

search()

This public method is inherited from I2CE_Form->search()

setAttribute()

This public method is inherited from I2CE_Form->setAttribute()

setDisplayName()

This public method is inherited from I2CE_Form->setDisplayName()

setForm()

This public method is inherited from I2CE_Form->setForm()

setFromPost()

This public method is inherited from I2CE_Form->setFromPost()

setId()

This public method is inherited from I2CE_Form->setId()

setParent()

This public method is inherited from I2CE_Form->setParent()

valid()

This public method is inherited from I2CE_Form->valid()

__isset()

This protected method is inherited from I2CE_Form->__isset()

addFormFields()

This protected method is inherited from I2CE_Form->addFormFields()

getFormFieldsData()

This protected method is inherited from I2CE_Form->getFormFieldsData()

lookupArray()

This protected method is inherited from I2CE_Form->lookupArray()

_hasMethod()

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

Inherited Variables

$children

Theis public variable is inherited from I2CE_Form->$children

$fields

Theis protected variable is inherited from I2CE_Form->$fields

$parent

Theis protected variable is inherited from I2CE_Form->$parent

$id

Theis protected variable is inherited from I2CE_Form->$id

$attributes

Theis protected variable is inherited from I2CE_Form->$attributes

$parent_forms

Theis protected variable is inherited from I2CE_Form->$parent_forms

Inherited Fuzzy Methods

isNumeric()

This method is inherited from I2CE_Form->isNumeric()

getLimitStyles()

This method is inherited from I2CE_Form->getLimitStyles()

checkLimit()

This method is inherited from I2CE_Form->checkLimit()

checkWhereClause()

This method is inherited from I2CE_Form->checkWhereClause()

createCheckFunction()

This method is inherited from I2CE_Form->createCheckFunction()

createCheckLimitString()

This method is inherited from I2CE_Form->createCheckLimitString()

generateLimit()

This method is inherited from I2CE_Form->generateLimit()

generateWhereClause()

This method is inherited from I2CE_Form->generateWhereClause()

processLimit()

This method is inherited from I2CE_Form->processLimit()

getDisplayedExistingLimit()

This method is inherited from I2CE_Form->getDisplayedExistingLimit()

isComponentized()

This method is inherited from I2CE_Form->isComponentized()

addChild()

This method is inherited from I2CE_Form->addChild()

getChildIds()

This method is inherited from I2CE_Form->getChildIds()

getStorage()

This method is inherited from I2CE_Form->getStorage()

isWritable()

This method is inherited from I2CE_Form->isWritable()

populateChild()

This method is inherited from I2CE_Form->populateChild()

populateChildren()

This method is inherited from I2CE_Form->populateChildren()

populateFirst()

This method is inherited from I2CE_Form->populateFirst()

populateHistory()

This method is inherited from I2CE_Form->populateHistory()

populateLast()

This method is inherited from I2CE_Form->populateLast()

delete()

This method is inherited from I2CE_Form->delete()

setChangeType()

This method is inherited from I2CE_Form->setChangeType()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()