|
|
| (26 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class '''iHRIS_PageFormSalary'''.
| | #REDIRECT [[Class: iHRIS_PageFormSalary (4.1.7)]] |
| *Extends the class: [[Class: I2CE_PageForm | I2CE_PageForm]].
| |
| *Location: Part of the module [[iHRIS Module List#ihris-manage-PersonPosition|ihris-manage-PersonPosition]] in the package [https://launchpad.net/ihris-manage iHRIS Manage]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.0-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php]
| |
| | |
| *Author: Luke Duncan <lduncan@intrahealth.org>/Carl Leitner<litlfred@ibiblio.org>
| |
| *Since: v2.0.0
| |
| Manage adding or editing salary details to the database.
| |
| @copyright Copyright © 2007, 2008 IntraHealth International, Inc.
| |
| Page object to handle the adding or editing salary details to the database.
| |
| ==Variables==
| |
| ===$last_id===
| |
| The id of the previous salary record
| |
| *Type: private nteger $last_id
| |
| | |
| ===$last===
| |
| the iHRIS_Salary object for the previous record.
| |
| *Type: private [[Class: I2CE_Form | I2CE_Form]] $last
| |
| | |
| ===$id===
| |
| The record id number of the object being edited.
| |
| *Type: protected nteger $id
| |
| | |
| ===$position_id===
| |
| The record id number of the parent person_position of the object being edited
| |
| *Type: protected nteger $position_id
| |
| | |
| ===$person_id===
| |
| The record id number of the person of the object being edited
| |
| *Type: protected nteger $person_id
| |
| | |
| ===$person===
| |
| person The person of the object being edited
| |
| *Type: protected Person $person
| |
| | |
| ===$person_position===
| |
| @var PersonPosition $personPosition The record id number of the person of the object being edited
| |
| *Type: protected $person_position
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| Create a new instance of this page.
| |
| | |
| This will call the parent constructor and then setup the base
| |
| template pages for the {@link Template template}. It also sets up the values
| |
| for the member variables.
| |
| Create a new instance of this page.
| |
| | |
| This will call the parent constructor and then setup the base
| |
| template pages for the {@link Template template}. It also sets up the values
| |
| for the member variables.
| |
| *Signature: public function __construct($args,$request_remainder)
| |
| Parameters:
| |
| *$args
| |
| *$request_remainder
| |
| ===displayControls()===
| |
| Display the save or confirm buttons as needed.
| |
| | |
| If the page is a confirmation view then the save / edit button template will be displayed.
| |
| Otherwise the confirm and return buttons will be shown.
| |
| @global array
| |
| *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. (Defaults to false)
| |
| **Default Value: false
| |
| * [http://www.php.net/manual/en/language.types.boolean.php boolean ] $show_edit<br/>(defaults to true)
| |
| **Default Value: true
| |
| ===getDefaultHTMLFile()===
| |
| Return the default HTML file used by this page.
| |
| *Signature: protected function getDefaultHTMLFile()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===getForm()===
| |
| Return the form name for this page.
| |
| *Signature: protected function getForm($html)
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| @see PersonPageForm
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.boolean.php boolean ] $html<br/>Set to true if this is to be used for the html template page.
| |
| **Default Value: false
| |
| ===getTitle()===
| |
| Return the title for this page.
| |
| *Signature: protected function getTitle()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===loadHTMLTemplates()===
| |
| Load the HTML template files for editing.
| |
| *Signature: protected function loadHTMLTemplates()
| |
| ===loadObjects()===
| |
| Create and load data for the objects used for this form.
| |
| | |
| Create the list object and if this is a form submission load
| |
| the data from the form data. It determines the type based on the
| |
| {@link $type} member variable.
| |
| *Signature: protected function loadObjects()
| |
| ===save()===
| |
| Save the objects to the database.
| |
| | |
| Save the default object being edited and return to the view page. If the action needs to be
| |
| logged then the log method is also called. Any pages overriding this default save method
| |
| will need to include any logging necessary.
| |
| *Signature: protected function save()
| |
| ===setDisplayData()===
| |
| Set the data to be displayed for the page.
| |
| *Signature: protected function setDisplayData()
| |
| ===setForm()===
| |
| Set the I2CE_Form object in the page template.
| |
| | |
| This method will pass the edit object to the page template so that it can process all the form variables.
| |
| *Signature: protected function setForm()
| |
| ===validate()===
| |
| Run the validation methods for all the objects being edited.
| |
| | |
| If this is a form submit then run the validation methods for the default object being edited. The default method
| |
| calls the {@link I2CE_Form::validate() validate} method on the {@link $edit_obj} object.
| |
| *Signature: protected function validate()
| |
| ==Inherited Variables==
| |
| ===$objects===
| |
| Theis protected variable is inherited from [[Class: I2CE_PageForm#$objects | I2CE_PageForm->$objects]]
| |
| | |
| ===$node_ids===
| |
| Theis protected variable is inherited from [[Class: I2CE_PageForm#$node_ids | I2CE_PageForm->$node_ids]]
| |
| | |
| ===$factory===
| |
| Theis protected variable is inherited from [[Class: I2CE_PageForm#$factory | I2CE_PageForm->$factory]]
| |
| | |
| ===$usesConfimPage===
| |
| Theis protected variable is inherited from [[Class: I2CE_PageForm#$usesConfimPage | I2CE_PageForm->$usesConfimPage]]
| |
| | |
| ===$formAttributes===
| |
| Theis protected variable is inherited from [[Class: I2CE_PageForm#$formAttributes | I2CE_PageForm->$formAttributes]]
| |
| | |
| ===$template===
| |
| Theis protected variable is inherited from [[Class: I2CE_Page#$template | I2CE_Page->$template]]
| |
| | |
| ===$defaultHTMLFile===
| |
| Theis protected variable is inherited from [[Class: I2CE_Page#$defaultHTMLFile | I2CE_Page->$defaultHTMLFile]]
| |
| | |
| ===$role===
| |
| Theis protected variable is inherited from [[Class: I2CE_Page#$role | I2CE_Page->$role]]
| |
| | |
| ===$user===
| |
| Theis protected variable is inherited from [[Class: I2CE_Page#$user | I2CE_Page->$user]]
| |
| | |
| ===$post===
| |
| Theis protected variable is inherited from [[Class: I2CE_Page#$post | I2CE_Page->$post]]
| |
| | |
| ===$get===
| |
| Theis protected variable is inherited from [[Class: I2CE_Page#$get | I2CE_Page->$get]]
| |
| | |
| ===$page_root===
| |
| Theis protected variable is inherited from [[Class: I2CE_Page#$page_root | I2CE_Page->$page_root]]
| |
| | |
| ===$page_remainder===
| |
| Theis protected variable is inherited from [[Class: I2CE_Page#$page_remainder | I2CE_Page->$page_remainder]]
| |
| | |
| ===$args===
| |
| Theis protected variable is inherited from [[Class: I2CE_Page#$args | I2CE_Page->$args]]
| |
| | |
| ===$request_remainder===
| |
| Theis protected variable is inherited from [[Class: I2CE_Page#$request_remainder | I2CE_Page->$request_remainder]]
| |
| | |
| ===$permissionParser===
| |
| Theis protected variable is inherited from [[Class: I2CE_Page#$permissionParser | I2CE_Page->$permissionParser]]
| |
| | |
| ===$page===
| |
| Theis protected variable is inherited from [[Class: I2CE_Page#$page | I2CE_Page->$page]]
| |
| | |
| ===$module===
| |
| Theis protected variable is inherited from [[Class: I2CE_Page#$module | I2CE_Page->$module]]
| |
| | |
| ===$is_post===
| |
| Theis protected variable is inherited from [[Class: I2CE_Page#$is_post | I2CE_Page->$is_post]]
| |
| | |
| ===$session_req===
| |
| Theis protected variable is inherited from [[Class: I2CE_Page#$session_req | I2CE_Page->$session_req]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===launchBackgroundProcess()===
| |
| This method is inherited from [[Class: I2CE_Page#launchBackgroundProcess() | I2CE_Page->launchBackgroundProcess()]]
| |
| | |
| ===launchBackgroundPHPScript()===
| |
| This method is inherited from [[Class: I2CE_Page#launchBackgroundPHPScript() | I2CE_Page->launchBackgroundPHPScript()]]
| |
| | |
| ===launchBackgroundPage()===
| |
| This method is inherited from [[Class: I2CE_Page#launchBackgroundPage() | I2CE_Page->launchBackgroundPage()]]
| |
| | |
| ===addColorPickerTriple()===
| |
| This method is inherited from [[Class: I2CE_Page#addColorPickerTriple() | I2CE_Page->addColorPickerTriple()]]
| |
| | |
| ===selectOptionsImmediate()===
| |
| This method is inherited from [[Class: I2CE_Page#selectOptionsImmediate() | I2CE_Page->selectOptionsImmediate()]]
| |
| | |
| ===setDisplayData()===
| |
| This method is inherited from [[Class: I2CE_Page#setDisplayData() | I2CE_Page->setDisplayData()]]
| |
| | |
| ===setDisplayDataImmediate()===
| |
| This method is inherited from [[Class: I2CE_Page#setDisplayDataImmediate() | I2CE_Page->setDisplayDataImmediate()]]
| |
| | |
| ===addFormWorm()===
| |
| This method is inherited from [[Class: I2CE_Page#addFormWorm() | I2CE_Page->addFormWorm()]]
| |
| | |
| ===getClassValue()===
| |
| This method is inherited from [[Class: I2CE_Page#getClassValue() | I2CE_Page->getClassValue()]]
| |
| | |
| ===loadClassValues()===
| |
| This method is inherited from [[Class: I2CE_Page#loadClassValues() | I2CE_Page->loadClassValues()]]
| |
| | |
| ===setClassValue()===
| |
| This method is inherited from [[Class: I2CE_Page#setClassValue() | I2CE_Page->setClassValue()]]
| |
| | |
| ===setClassValues()===
| |
| This method is inherited from [[Class: I2CE_Page#setClassValues() | I2CE_Page->setClassValues()]]
| |
| | |
| ===addOption()===
| |
| This method is inherited from [[Class: I2CE_Page#addOption() | I2CE_Page->addOption()]]
| |
| | |
| ===addOptions()===
| |
| This method is inherited from [[Class: I2CE_Page#addOptions() | I2CE_Page->addOptions()]]
| |
| | |
| ===addAutoCompleteInputTreeById()===
| |
| This method is inherited from [[Class: I2CE_Page#addAutoCompleteInputTreeById() | I2CE_Page->addAutoCompleteInputTreeById()]]
| |
| | |
| ===addAutoCompleteInputTree()===
| |
| This method is inherited from [[Class: I2CE_Page#addAutoCompleteInputTree() | I2CE_Page->addAutoCompleteInputTree()]]
| |
| | |
| ===setForm()===
| |
| This method is inherited from [[Class: I2CE_Page#setForm() | I2CE_Page->setForm()]]
| |
| | |
| ===getField()===
| |
| This method is inherited from [[Class: I2CE_Page#getField() | I2CE_Page->getField()]]
| |
| | |
| ===setReview()===
| |
| This method is inherited from [[Class: I2CE_Page#setReview() | I2CE_Page->setReview()]]
| |
| | |
| ===isReview()===
| |
| This method is inherited from [[Class: I2CE_Page#isReview() | I2CE_Page->isReview()]]
| |
| | |
| ===setShowForm()===
| |
| This method is inherited from [[Class: I2CE_Page#setShowForm() | I2CE_Page->setShowForm()]]
| |
| | |
| ===showForm()===
| |
| This method is inherited from [[Class: I2CE_Page#showForm() | I2CE_Page->showForm()]]
| |
| | |
| ===makeJumper()===
| |
| This method is inherited from [[Class: I2CE_Page#makeJumper() | I2CE_Page->makeJumper()]]
| |
| | |
| ===menuSelect()===
| |
| This method is inherited from [[Class: I2CE_Page#menuSelect() | I2CE_Page->menuSelect()]]
| |
| | |
| ===addUpdateSelect()===
| |
| This method is inherited from [[Class: I2CE_Page#addUpdateSelect() | I2CE_Page->addUpdateSelect()]]
| |
| | |
| ===addAjaxUpdate()===
| |
| This method is inherited from [[Class: I2CE_Page#addAjaxUpdate() | I2CE_Page->addAjaxUpdate()]]
| |
| | |
| ===addAjaxToggle()===
| |
| This method is inherited from [[Class: I2CE_Page#addAjaxToggle() | I2CE_Page->addAjaxToggle()]]
| |
| | |
| ===addAjaxRequestFunction()===
| |
| This method is inherited from [[Class: I2CE_Page#addAjaxRequestFunction() | I2CE_Page->addAjaxRequestFunction()]]
| |
| | |
| ===addAjaxCompleteFunction()===
| |
| This method is inherited from [[Class: I2CE_Page#addAjaxCompleteFunction() | I2CE_Page->addAjaxCompleteFunction()]]
| |
| | |
| ===addAjaxToggleOnFunction()===
| |
| This method is inherited from [[Class: I2CE_Page#addAjaxToggleOnFunction() | I2CE_Page->addAjaxToggleOnFunction()]]
| |
| | |
| ===addAjaxToggleOffFunction()===
| |
| This method is inherited from [[Class: I2CE_Page#addAjaxToggleOffFunction() | I2CE_Page->addAjaxToggleOffFunction()]]
| |
| | |
| ===hasAjax()===
| |
| This method is inherited from [[Class: I2CE_Page#hasAjax() | I2CE_Page->hasAjax()]]
| |
| | |
| ===setDataTypePriority()===
| |
| This method is inherited from [[Class: I2CE_Page#setDataTypePriority() | I2CE_Page->setDataTypePriority()]]
| |
| | |
| ===setData()===
| |
| This method is inherited from [[Class: I2CE_Page#setData() | I2CE_Page->setData()]]
| |
| | |
| ===getData()===
| |
| This method is inherited from [[Class: I2CE_Page#getData() | I2CE_Page->getData()]]
| |
| | |
| ===getDefaultData()===
| |
| This method is inherited from [[Class: I2CE_Page#getDefaultData() | I2CE_Page->getDefaultData()]]
| |
| | |
| ===removeData()===
| |
| This method is inherited from [[Class: I2CE_Page#removeData() | I2CE_Page->removeData()]]
| |
| | |
| ===getDataNames()===
| |
| This method is inherited from [[Class: I2CE_Page#getDataNames() | I2CE_Page->getDataNames()]]
| |
| | |
| ===ensureNode()===
| |
| This method is inherited from [[Class: I2CE_Page#ensureNode() | I2CE_Page->ensureNode()]]
| |
| | |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
