Class: I2CE PageFormUser

This article describes the class I2CE_PageFormUser.

• Extends the class: I2CE_PageForm.
• Parent Classses: I2CE_PageForm I2CE_Page I2CE_Fuzzy
• Child Classes:
  • iHRIS_PageFormUser
• Location: Part of the module UserForm in the package I2CE
• Source: Defined in the file modules/Forms/modules/UserForm/lib/I2CE_PageFormUser.php
• Author: Luke Duncan <lduncan@intrahealth.org>
• Since: v2.0.0
• See: I2CE_User

This page is used to add and edit user records to give access to the site. Object to display the form to edit users in the database.

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 string $userDB

Methods

__construct()

Create a new instance of a form page. This will call the constructor for all Page objects and then set up some additional member variables for forms. @param string $title The title for this page. @param string $defaultHTMLFile The default HTML file for this page. @param mixed $access The role required to access this page. @param array $files The list of template files to load for this page.

• Signature: public function __construct($args,$request_remainder)
• Parameters:
  • $args
  • $request_remainder

action()

Perform the actions of the page.

• Signature: protected function action()

displayControls()

Display the save or confirm buttons as needed.

• Signature: protected function displayControls($save,$show_edit)
• Parameters:
  • boolean $save
    Flag to show the save button.
    • Default Value: false
  • boolean $show_edit
    (defaults to true)
    • Default Value: true

listUsersToEdit()

Populate a drop down of users that can be edited by the current user given his/her access level.

• Signature: public function listUsersToEdit($selectId)
• Parameters:
  • string $selectId @global array

listUsersToEditByCreator()

Populate a drop down of users that can be edited by the current user of the users that were created by the current user

• Signature: public function listUsersToEditByCreator($selectId)
• Parameters:
  • string $selectId @global array

loadHTMLTemplates()

Load the HTML template files for editing and confirming the index information.

• Signature: protected function loadHTMLTemplates()

loadObjects()

Create and load data for the objects used for this form. Create the index object and if this is a form submission the load the data from the $_POST array.

• Signature: protected function loadObjects()

save()

Save the objects to the database. Save the default object being edited and return to the view page.

• Signature: protected function save()