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

Inherited Methods

hasInvalid()

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

invalidMessage()

This public method is inherited from I2CE_PageForm->invalidMessage()

setFormAttributes()

This public method is inherited from I2CE_PageForm->setFormAttributes()

usesConfirmPage()

This public method is inherited from I2CE_PageForm->usesConfirmPage()

getParent()

This protected method is inherited from I2CE_PageForm->getParent()

getPrimary()

This protected method is inherited from I2CE_PageForm->getPrimary()

isConfirm()

This protected method is inherited from I2CE_PageForm->isConfirm()

isEdit()

This protected method is inherited from I2CE_PageForm->isEdit()

isEditing()

This protected method is inherited from I2CE_PageForm->isEditing()

isSave()

This protected method is inherited from I2CE_PageForm->isSave()

setDisplayData()

This protected method is inherited from I2CE_PageForm->setDisplayData()

setEditing()

This protected method is inherited from I2CE_PageForm->setEditing()

setForm()

This protected method is inherited from I2CE_PageForm->setForm()

setObject()

This protected method is inherited from I2CE_PageForm->setObject()

validate()

This protected method is inherited from I2CE_PageForm->validate()

_flattenRequestVars()

This public method is inherited from I2CE_Page->_flattenRequestVars()

display()

This public method is inherited from I2CE_Page->display()

fixupRequestVariables()

This public method is inherited from I2CE_Page->fixupRequestVariables()

flattenRequestVars()

This public method is inherited from I2CE_Page->flattenRequestVars()

get()

This public method is inherited from I2CE_Page->get()

getAccessedBaseURL()

This public method is inherited from I2CE_Page->getAccessedBaseURL()

getTemplate()

This public method is inherited from I2CE_Page->getTemplate()

getUser()

This public method is inherited from I2CE_Page->getUser()

get_exists()

This public method is inherited from I2CE_Page->get_exists()

hasPermission()

This public method is inherited from I2CE_Page->hasPermission()

isGet()

This public method is inherited from I2CE_Page->isGet()

isPost()

This public method is inherited from I2CE_Page->isPost()

module()

This public method is inherited from I2CE_Page->module()

page()

This public method is inherited from I2CE_Page->page()

pageRemainder()

This public method is inherited from I2CE_Page->pageRemainder()

pageRoot()

This public method is inherited from I2CE_Page->pageRoot()

post()

This public method is inherited from I2CE_Page->post()

post_exists()

This public method is inherited from I2CE_Page->post_exists()

redirect()

This public method is inherited from I2CE_Page->redirect()

request()

This public method is inherited from I2CE_Page->request()

request_exists()

This public method is inherited from I2CE_Page->request_exists()

rewrittenURLs()

This public method is inherited from I2CE_Page->rewrittenURLs()

session_req()

This public method is inherited from I2CE_Page->session_req()

session_req_exists()

This public method is inherited from I2CE_Page->session_req_exists()

setAccess()

This public method is inherited from I2CE_Page->setAccess()

setIsPost()

This public method is inherited from I2CE_Page->setIsPost()

setRedirect()

This public method is inherited from I2CE_Page->setRedirect()

_display()

This protected method is inherited from I2CE_Page->_display()

actionCommandLine()

This protected method is inherited from I2CE_Page->actionCommandLine()

getAccess()

This protected method is inherited from I2CE_Page->getAccess()

getTitle()

This protected method is inherited from I2CE_Page->getTitle()

initializeTemplate()

This protected method is inherited from I2CE_Page->initializeTemplate()

setupGetPost()

This protected method is inherited from I2CE_Page->setupGetPost()

_hasMethod()

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

Inherited Variables

$objects

Theis protected variable is inherited from I2CE_PageForm->$objects

$node_ids

Theis protected variable is inherited from I2CE_PageForm->$node_ids

$factory

Theis protected variable is inherited from I2CE_PageForm->$factory

$usesConfimPage

Theis protected variable is inherited from I2CE_PageForm->$usesConfimPage

$formAttributes

Theis protected variable is inherited from I2CE_PageForm->$formAttributes

$template

Theis protected variable is inherited from I2CE_Page->$template

$defaultHTMLFile

Theis protected variable is inherited from I2CE_Page->$defaultHTMLFile

$role

Theis protected variable is inherited from I2CE_Page->$role

$user

Theis protected variable is inherited from I2CE_Page->$user

$post

Theis protected variable is inherited from I2CE_Page->$post

$get

Theis protected variable is inherited from I2CE_Page->$get

$page_root

Theis protected variable is inherited from I2CE_Page->$page_root

$page_remainder

Theis protected variable is inherited from I2CE_Page->$page_remainder

$args

Theis protected variable is inherited from I2CE_Page->$args

$request_remainder

Theis protected variable is inherited from I2CE_Page->$request_remainder

$permissionParser

Theis protected variable is inherited from I2CE_Page->$permissionParser

$page

Theis protected variable is inherited from I2CE_Page->$page

$module

Theis protected variable is inherited from I2CE_Page->$module

$is_post

Theis protected variable is inherited from I2CE_Page->$is_post

$session_req

Theis protected variable is inherited from I2CE_Page->$session_req

Inherited Fuzzy Methods

launchBackgroundProcess()

This method is inherited from I2CE_Page->launchBackgroundProcess()

launchBackgroundPHPScript()

This method is inherited from I2CE_Page->launchBackgroundPHPScript()

launchBackgroundPage()

This method is inherited from I2CE_Page->launchBackgroundPage()

addColorPickerTriple()

This method is inherited from I2CE_Page->addColorPickerTriple()

selectOptionsImmediate()

This method is inherited from I2CE_Page->selectOptionsImmediate()

setDisplayData()

This method is inherited from I2CE_Page->setDisplayData()

setDisplayDataImmediate()

This method is inherited from I2CE_Page->setDisplayDataImmediate()

addFormWorm()

This method is inherited from I2CE_Page->addFormWorm()

getClassValue()

This method is inherited from I2CE_Page->getClassValue()

loadClassValues()

This method is inherited from I2CE_Page->loadClassValues()

setClassValue()

This method is inherited from I2CE_Page->setClassValue()

setClassValues()

This method is inherited from I2CE_Page->setClassValues()

addOption()

This method is inherited from I2CE_Page->addOption()

addOptions()

This method is inherited from I2CE_Page->addOptions()

addAutoCompleteInputTreeById()

This method is inherited from I2CE_Page->addAutoCompleteInputTreeById()

addAutoCompleteInputTree()

This method is inherited from I2CE_Page->addAutoCompleteInputTree()

setForm()

This method is inherited from I2CE_Page->setForm()

getField()

This method is inherited from I2CE_Page->getField()

setReview()

This method is inherited from I2CE_Page->setReview()

isReview()

This method is inherited from I2CE_Page->isReview()

setShowForm()

This method is inherited from I2CE_Page->setShowForm()

showForm()

This method is inherited from I2CE_Page->showForm()

makeJumper()

This method is inherited from I2CE_Page->makeJumper()

menuSelect()

This method is inherited from I2CE_Page->menuSelect()

addUpdateSelect()

This method is inherited from I2CE_Page->addUpdateSelect()

addAjaxUpdate()

This method is inherited from I2CE_Page->addAjaxUpdate()

addAjaxToggle()

This method is inherited from I2CE_Page->addAjaxToggle()

addAjaxRequestFunction()

This method is inherited from I2CE_Page->addAjaxRequestFunction()

addAjaxCompleteFunction()

This method is inherited from I2CE_Page->addAjaxCompleteFunction()

addAjaxToggleOnFunction()

This method is inherited from I2CE_Page->addAjaxToggleOnFunction()

addAjaxToggleOffFunction()

This method is inherited from I2CE_Page->addAjaxToggleOffFunction()

hasAjax()

This method is inherited from I2CE_Page->hasAjax()

setDataTypePriority()

This method is inherited from I2CE_Page->setDataTypePriority()

setData()

This method is inherited from I2CE_Page->setData()

getData()

This method is inherited from I2CE_Page->getData()

getDefaultData()

This method is inherited from I2CE_Page->getDefaultData()

removeData()

This method is inherited from I2CE_Page->removeData()

getDataNames()

This method is inherited from I2CE_Page->getDataNames()

ensureNode()

This method is inherited from I2CE_Page->ensureNode()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()