Class: I2CE PageFormUser

From IHRIS Wiki
Revision as of 16:02, 16 October 2009 by Litlfred (talk | contribs) (Created page with 'This article desrcibes the class '''I2CE_PageFormUser'''which extends the class I2CE_PageForm It is contained in the module [[iHRIS Module List#UserFor…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This article desrcibes the class I2CE_PageFormUserwhich extends the class I2CE_PageForm It is contained in the module UserForm in the package I2CE The class is defined in the file: modules/Forms/modules/UserForm/lib/I2CE_PageFormUser.php This page is used to add and edit user records to give access to the site. @package I2CE @subpackage Common @access public @author Luke Duncan <lduncan@intrahealth.org> @since v2.0.0 @version v2.0.0 @see I2CE_User Object to display the form to edit users in the database. @package I2CE @subpackage Common @access public

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 ng $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. @global array

  • Signature: public function listUsersToEdit($selectId)

Parameters:

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

@global array

  • Signature: public function listUsersToEditByCreator($selectId)

Parameters:

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

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