|
|
| (15 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_PageFormUser''.
| | #REDIRECT [[Class: I2CE_PageFormUser (4.1.7)]] |
| *Extends the class: [[Class: I2CE_PageForm | I2CE_PageForm]].
| |
| *Parent Classses: [[Class: I2CE_PageForm | I2CE_PageForm]] [[Class: I2CE_Page | I2CE_Page]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
| |
| *Child Classes:
| |
| ** [[Class: iHRIS_PageFormUser | iHRIS_PageFormUser]]
| |
| *Location: Part of the module [[I2CE Module List#UserForm|UserForm]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/Forms/modules/UserForm/lib/I2CE_PageFormUser.php modules/Forms/modules/UserForm/lib/I2CE_PageFormUser.php]
| |
| *Author: Luke Duncan <lduncan@intrahealth.org>
| |
| *Since: v2.0.0
| |
| *See: [[Class: I2CE_User | 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 [http://www.php.net/manual/en/language.types.string.php 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:
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $save <br/>Flag to show the save button.
| |
| ***Default Value: false
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $show_edit <br/>(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:
| |
| ** [http://www.php.net/manual/en/language.types.string.php 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:
| |
| ** [http://www.php.net/manual/en/language.types.string.php 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()
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
