Class: iHRIS PageFormSalary (Development): Difference between revisions
No edit summary |
No edit summary |
||
Line 2: | Line 2: | ||
This article describes the class ''iHRIS_PageFormSalary'' . | This article describes the class ''iHRIS_PageFormSalary'' . | ||
*Extends the class: [[Class: I2CE_PageForm (Development) | I2CE_PageForm]]. | *Extends the class: [[Class: I2CE_PageForm (Development) | I2CE_PageForm]]. | ||
*Location: Part of the module [[iHRIS Manage Module List (Development)#ihris-manage- | *Location: Part of the module [[iHRIS Manage Module List (Development)#ihris-manage-Salary|ihris-manage-Salary]] in the package [https://launchpad.net/ihris-manage iHRIS Manage] 4.1-dev | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L39 modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 39 | ||
*Author: Luke Duncan <lduncan@intrahealth.org>/Carl Leitner<litlfred@ibiblio.org> | *Author: Luke Duncan <lduncan@intrahealth.org>/Carl Leitner<litlfred@ibiblio.org> | ||
*Since: v2.0.0 | *Since: v2.0.0 | ||
Line 10: | Line 10: | ||
===$last_id=== | ===$last_id=== | ||
The id of the previous salary record | The id of the previous salary record | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L56 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 56 | ||
*Type: private integer $last_id | *Type: private integer $last_id | ||
===$last=== | ===$last=== | ||
the [[Class: iHRIS_Salary (Development) | ]] object for the previous record. | the [[Class: iHRIS_Salary (Development) | ]] object for the previous record. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L60 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 60 | ||
*Type: private [[Class: I2CE_Form (Development) | I2CE_Form]] $last | *Type: private [[Class: I2CE_Form (Development) | I2CE_Form]] $last | ||
===$id=== | ===$id=== | ||
The record id number of the object being edited. | The record id number of the object being edited. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L77 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 77 | ||
*Type: protected integer $id | *Type: protected integer $id | ||
===$position_id=== | ===$position_id=== | ||
The record id number of the parent person_position of the object being edited | The record id number of the parent person_position of the object being edited | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L81 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 81 | ||
*Type: protected integer $position_id | *Type: protected integer $position_id | ||
===$person_id=== | ===$person_id=== | ||
The record id number of the person of the object being edited | The record id number of the person of the object being edited | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L86 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 86 | ||
*Type: protected integer $person_id | *Type: protected integer $person_id | ||
===$person=== | ===$person=== | ||
person The person of the object being edited | person The person of the object being edited | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L92 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 92 | ||
*Type: protected Person $person | *Type: protected Person $person | ||
===$person_position=== | ===$person_position=== | ||
@var PersonPosition $personPosition The record id number of the person of the object being edited | @var PersonPosition $personPosition The record id number of the person of the object being edited | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L97 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 97 | ||
*Type: protected $person_position | *Type: protected $person_position | ||
===$position=== | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L163 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 163 | |||
*Type: protected $position | |||
==Methods== | ==Methods== | ||
===__construct()=== | ===__construct()=== | ||
Create a new instance of this page. This will call the parent constructor and then setup the base template pages for the 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 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 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 Template template. It also sets up the values for the member variables. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L113 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 113 | ||
*Signature: public function __construct($args,$request_remainder) | *Signature: public function __construct($args,$request_remainder) | ||
*Parameters: | *Parameters: | ||
Line 53: | Line 57: | ||
===displayControls()=== | ===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. | 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. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L259 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 259 | ||
*Signature: protected function displayControls($save,$show_edit) | *Signature: protected function displayControls($save,$show_edit) | ||
*Parameters: | *Parameters: | ||
Line 62: | Line 66: | ||
===getDefaultHTMLFile()=== | ===getDefaultHTMLFile()=== | ||
Return the default HTML file used by this page. | Return the default HTML file used by this page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L44 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 44 | ||
*Signature: protected function getDefaultHTMLFile() | *Signature: protected function getDefaultHTMLFile() | ||
*Returns: [http://www.php.net/manual/en/language.types.string.php string ] | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] | ||
===getForm()=== | ===getForm()=== | ||
Return the form name for this page. | Return the form name for this page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L67 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 67 | ||
*Signature: protected function getForm($html) | *Signature: protected function getForm($html) | ||
*Parameters: | *Parameters: | ||
Line 75: | Line 79: | ||
===getTitle()=== | ===getTitle()=== | ||
Return the title for this page. | Return the title for this page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L50 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 50 | ||
*Signature: | *Signature: public function getTitle() | ||
*Returns: [http://www.php.net/manual/en/language.types.string.php string ] | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] | ||
===initPage()=== | |||
Initializes any data for the page | |||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L168 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 168 | |||
*Signature: protected function initPage() | |||
*Returns: boolean.<br/>True on sucess. False on failture | |||
===loadHTMLTemplates()=== | ===loadHTMLTemplates()=== | ||
Load the HTML template files for editing. | Load the HTML template files for editing. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L155 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 155 | ||
*Signature: protected function loadHTMLTemplates() | *Signature: protected function loadHTMLTemplates() | ||
===save()=== | ===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. | 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. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L275 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 275 | ||
*Signature: protected function save() | *Signature: protected function save() | ||
===setDisplayData()=== | ===setDisplayData()=== | ||
Set the data to be displayed for the page. | Set the data to be displayed for the page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L222 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 222 | ||
*Signature: protected function setDisplayData() | *Signature: protected function setDisplayData() | ||
===validate()=== | ===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 [[Class: I2CE_Form (Development) | ::validate() validate]] method on the object. | 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 [[Class: I2CE_Form (Development) | ::validate() validate]] method on the object. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.1-dev/annotate/head:/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php#L237 manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php] on line 237 | ||
*Signature: protected function validate() | *Signature: protected function validate() | ||
==Inherited Methods== | ==Inherited Methods== | ||
===getChildObjects()=== | |||
This public method is inherited from [[Class: I2CE_PageForm (Development)#getChildObjects() | I2CE_PageForm->getChildObjects()]] | |||
===getSecondaryObjects()=== | |||
This public method is inherited from [[Class: I2CE_PageForm (Development)#getSecondaryObjects() | I2CE_PageForm->getSecondaryObjects()]] | |||
===hasInvalid()=== | ===hasInvalid()=== | ||
This public method is inherited from [[Class: I2CE_PageForm (Development)#hasInvalid() | I2CE_PageForm->hasInvalid()]] | This public method is inherited from [[Class: I2CE_PageForm (Development)#hasInvalid() | I2CE_PageForm->hasInvalid()]] | ||
Line 109: | Line 116: | ||
This public method is inherited from [[Class: I2CE_PageForm (Development)#invalidMessage() | I2CE_PageForm->invalidMessage()]] | This public method is inherited from [[Class: I2CE_PageForm (Development)#invalidMessage() | I2CE_PageForm->invalidMessage()]] | ||
=== | ===setObject()=== | ||
This public method is inherited from [[Class: I2CE_PageForm (Development)# | This public method is inherited from [[Class: I2CE_PageForm (Development)#setObject() | I2CE_PageForm->setObject()]] | ||
===getParent()=== | |||
This protected method is inherited from [[Class: I2CE_PageForm (Development)#getParent() | I2CE_PageForm->getParent()]] | |||
===getPrimary()=== | |||
This protected method is inherited from [[Class: I2CE_PageForm (Development)#getPrimary() | I2CE_PageForm->getPrimary()]] | |||
===loadObjects()=== | |||
This protected method is inherited from [[Class: I2CE_PageForm (Development)#loadObjects() | I2CE_PageForm->loadObjects()]] | |||
===setForm()=== | |||
This protected method is inherited from [[Class: I2CE_PageForm (Development)#setForm() | I2CE_PageForm->setForm()]] | |||
===usesConfirmPage()=== | ===usesConfirmPage()=== | ||
This public method is inherited from [[Class: | This public method is inherited from [[Class: I2CE_PageFormBase (Development)#usesConfirmPage() | I2CE_PageFormBase->usesConfirmPage()]] | ||
===action()=== | ===action()=== | ||
This protected method is inherited from [[Class: | This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#action() | I2CE_PageFormBase->action()]] | ||
===action_display()=== | |||
This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#action_display() | I2CE_PageFormBase->action_display()]] | |||
=== | ===action_save()=== | ||
This protected method is inherited from [[Class: | This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#action_save() | I2CE_PageFormBase->action_save()]] | ||
===canSave()=== | |||
This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#canSave() | I2CE_PageFormBase->canSave()]] | |||
=== | ===checkActionPermission()=== | ||
This protected method is inherited from [[Class: | This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#checkActionPermission() | I2CE_PageFormBase->checkActionPermission()]] | ||
===isConfirm()=== | ===isConfirm()=== | ||
This protected method is inherited from [[Class: | This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#isConfirm() | I2CE_PageFormBase->isConfirm()]] | ||
===isEdit()=== | ===isEdit()=== | ||
This protected method is inherited from [[Class: | This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#isEdit() | I2CE_PageFormBase->isEdit()]] | ||
===isEditing()=== | ===isEditing()=== | ||
This protected method is inherited from [[Class: | This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#isEditing() | I2CE_PageFormBase->isEditing()]] | ||
===isSave()=== | ===isSave()=== | ||
This protected method is inherited from [[Class: | This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#isSave() | I2CE_PageFormBase->isSave()]] | ||
===setEditing()=== | ===setEditing()=== | ||
This protected method is inherited from [[Class: | This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#setEditing() | I2CE_PageFormBase->setEditing()]] | ||
===_flattenRequestVars()=== | ===_flattenRequestVars()=== | ||
Line 162: | Line 184: | ||
===getTemplate()=== | ===getTemplate()=== | ||
This public method is inherited from [[Class: I2CE_Page (Development)#getTemplate() | I2CE_Page->getTemplate()]] | This public method is inherited from [[Class: I2CE_Page (Development)#getTemplate() | I2CE_Page->getTemplate()]] | ||
===getURLRoot()=== | |||
This public method is inherited from [[Class: I2CE_Page (Development)#getURLRoot() | I2CE_Page->getURLRoot()]] | |||
===getUser()=== | ===getUser()=== | ||
Line 228: | Line 253: | ||
===actionCommandLine()=== | ===actionCommandLine()=== | ||
This protected method is inherited from [[Class: I2CE_Page (Development)#actionCommandLine() | I2CE_Page->actionCommandLine()]] | This protected method is inherited from [[Class: I2CE_Page (Development)#actionCommandLine() | I2CE_Page->actionCommandLine()]] | ||
===displayCommandLine()=== | |||
This protected method is inherited from [[Class: I2CE_Page (Development)#displayCommandLine() | I2CE_Page->displayCommandLine()]] | |||
===displayWeb()=== | |||
This protected method is inherited from [[Class: I2CE_Page (Development)#displayWeb() | I2CE_Page->displayWeb()]] | |||
===getAccess()=== | ===getAccess()=== | ||
Line 234: | Line 265: | ||
===initializeTemplate()=== | ===initializeTemplate()=== | ||
This protected method is inherited from [[Class: I2CE_Page (Development)#initializeTemplate() | I2CE_Page->initializeTemplate()]] | This protected method is inherited from [[Class: I2CE_Page (Development)#initializeTemplate() | I2CE_Page->initializeTemplate()]] | ||
===setActiveMenu()=== | |||
This protected method is inherited from [[Class: I2CE_Page (Development)#setActiveMenu() | I2CE_Page->setActiveMenu()]] | |||
===setupGetPost()=== | ===setupGetPost()=== | ||
Line 246: | Line 280: | ||
===$node_ids=== | ===$node_ids=== | ||
Theis protected variable is inherited from [[Class: I2CE_PageForm (Development)#$node_ids | I2CE_PageForm->$node_ids]] | Theis protected variable is inherited from [[Class: I2CE_PageForm (Development)#$node_ids | I2CE_PageForm->$node_ids]] | ||
===$editing=== | |||
Theis protected variable is inherited from [[Class: I2CE_PageFormBase (Development)#$editing | I2CE_PageFormBase->$editing]] | |||
===$factory=== | ===$factory=== | ||
Theis protected variable is inherited from [[Class: | Theis protected variable is inherited from [[Class: I2CE_PageFormBase (Development)#$factory | I2CE_PageFormBase->$factory]] | ||
===$button_templates=== | |||
Theis protected variable is inherited from [[Class: I2CE_PageFormBase (Development)#$button_templates | I2CE_PageFormBase->$button_templates]] | |||
===$checked_validation=== | |||
Theis protected variable is inherited from [[Class: I2CE_PageFormBase (Development)#$checked_validation | I2CE_PageFormBase->$checked_validation]] | |||
===$usesConfimPage=== | ===$usesConfimPage=== | ||
Theis protected variable is inherited from [[Class: | Theis protected variable is inherited from [[Class: I2CE_PageFormBase (Development)#$usesConfimPage | I2CE_PageFormBase->$usesConfimPage]] | ||
===$template=== | ===$template=== | ||
Line 267: | Line 307: | ||
===$user=== | ===$user=== | ||
Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$user | I2CE_Page->$user]] | Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$user | I2CE_Page->$user]] | ||
===$redirect=== | |||
Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$redirect | I2CE_Page->$redirect]] | |||
===$post=== | ===$post=== | ||
Line 288: | Line 331: | ||
===$permissionParser=== | ===$permissionParser=== | ||
Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$permissionParser | I2CE_Page->$permissionParser]] | Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$permissionParser | I2CE_Page->$permissionParser]] | ||
===$root_url=== | |||
Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$root_url | I2CE_Page->$root_url]] | |||
===$page=== | ===$page=== | ||
Line 312: | Line 358: | ||
===addColorPickerTriple()=== | ===addColorPickerTriple()=== | ||
This method is inherited from [[Class: I2CE_Page (Development)#addColorPickerTriple() | I2CE_Page->addColorPickerTriple()]] | This method is inherited from [[Class: I2CE_Page (Development)#addColorPickerTriple() | I2CE_Page->addColorPickerTriple()]] | ||
===addReportSelector()=== | |||
This method is inherited from [[Class: I2CE_Page (Development)#addReportSelector() | I2CE_Page->addReportSelector()]] | |||
===addDatePicker()=== | ===addDatePicker()=== | ||
Line 336: | Line 385: | ||
===setClassValues()=== | ===setClassValues()=== | ||
This method is inherited from [[Class: I2CE_Page (Development)#setClassValues() | I2CE_Page->setClassValues()]] | This method is inherited from [[Class: I2CE_Page (Development)#setClassValues() | I2CE_Page->setClassValues()]] | ||
===useDropDown()=== | |||
This method is inherited from [[Class: I2CE_Page (Development)#useDropDown() | I2CE_Page->useDropDown()]] | |||
===addOption()=== | ===addOption()=== | ||
Line 348: | Line 400: | ||
===addAutoCompleteInputTree()=== | ===addAutoCompleteInputTree()=== | ||
This method is inherited from [[Class: I2CE_Page (Development)#addAutoCompleteInputTree() | I2CE_Page->addAutoCompleteInputTree()]] | This method is inherited from [[Class: I2CE_Page (Development)#addAutoCompleteInputTree() | I2CE_Page->addAutoCompleteInputTree()]] | ||
===setForm()=== | |||
This method is inherited from [[Class: I2CE_Page (Development)#setForm() | I2CE_Page->setForm()]] | |||
===getField()=== | ===getField()=== | ||
Line 357: | Line 412: | ||
===isReview()=== | ===isReview()=== | ||
This method is inherited from [[Class: I2CE_Page (Development)#isReview() | I2CE_Page->isReview()]] | This method is inherited from [[Class: I2CE_Page (Development)#isReview() | I2CE_Page->isReview()]] | ||
===makeJumper()=== | ===makeJumper()=== | ||
This method is inherited from [[Class: I2CE_Page (Development)#makeJumper() | I2CE_Page->makeJumper()]] | This method is inherited from [[Class: I2CE_Page (Development)#makeJumper() | I2CE_Page->makeJumper()]] | ||
===makeScalingJumper()=== | |||
This method is inherited from [[Class: I2CE_Page (Development)#makeScalingJumper() | I2CE_Page->makeScalingJumper()]] | |||
===menuSelect()=== | ===menuSelect()=== | ||
Line 375: | Line 427: | ||
===addAjaxUpdate()=== | ===addAjaxUpdate()=== | ||
This method is inherited from [[Class: I2CE_Page (Development)#addAjaxUpdate() | I2CE_Page->addAjaxUpdate()]] | This method is inherited from [[Class: I2CE_Page (Development)#addAjaxUpdate() | I2CE_Page->addAjaxUpdate()]] | ||
===addAjaxLoad()=== | |||
This method is inherited from [[Class: I2CE_Page (Development)#addAjaxLoad() | I2CE_Page->addAjaxLoad()]] | |||
===addAjaxToggle()=== | ===addAjaxToggle()=== |
Latest revision as of 09:29, 6 May 2015
This article describes the class iHRIS_PageFormSalary .
- Extends the class: I2CE_PageForm.
- Location: Part of the module ihris-manage-Salary in the package iHRIS Manage 4.1-dev
- Source: Defined in the file modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 39
- 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
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 56
- Type: private integer $last_id
$last
the object for the previous record.
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 60
- Type: private I2CE_Form $last
$id
The record id number of the object being edited.
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 77
- Type: protected integer $id
$position_id
The record id number of the parent person_position of the object being edited
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 81
- Type: protected integer $position_id
$person_id
The record id number of the person of the object being edited
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 86
- Type: protected integer $person_id
$person
person The person of the object being edited
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 92
- Type: protected Person $person
$person_position
@var PersonPosition $personPosition The record id number of the person of the object being edited
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 97
- Type: protected $person_position
$position
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 163
- Type: protected $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 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 Template template. It also sets up the values for the member variables.
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 113
- 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.
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 259
- Signature: protected function displayControls($save,$show_edit)
- Parameters:
getDefaultHTMLFile()
Return the default HTML file used by this page.
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 44
- Signature: protected function getDefaultHTMLFile()
- Returns: string
getForm()
Return the form name for this page.
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 67
- Signature: protected function getForm($html)
- Parameters:
- boolean $html
Set to true if this is to be used for the html template page.- Default Value: false
- boolean $html
- Returns: string @see PersonPageForm
getTitle()
Return the title for this page.
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 50
- Signature: public function getTitle()
- Returns: string
initPage()
Initializes any data for the page
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 168
- Signature: protected function initPage()
- Returns: boolean.
True on sucess. False on failture
loadHTMLTemplates()
Load the HTML template files for editing.
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 155
- Signature: protected function loadHTMLTemplates()
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.
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 275
- Signature: protected function save()
setDisplayData()
Set the data to be displayed for the page.
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 222
- Signature: protected function setDisplayData()
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 ::validate() validate method on the object.
- Defined in manage/modules/ManagePersonPosition/modules/Salary/lib/iHRIS_PageFormSalary.php on line 237
- Signature: protected function validate()
Inherited Methods
getChildObjects()
This public method is inherited from I2CE_PageForm->getChildObjects()
getSecondaryObjects()
This public method is inherited from I2CE_PageForm->getSecondaryObjects()
hasInvalid()
This public method is inherited from I2CE_PageForm->hasInvalid()
invalidMessage()
This public method is inherited from I2CE_PageForm->invalidMessage()
setObject()
This public method is inherited from I2CE_PageForm->setObject()
getParent()
This protected method is inherited from I2CE_PageForm->getParent()
getPrimary()
This protected method is inherited from I2CE_PageForm->getPrimary()
loadObjects()
This protected method is inherited from I2CE_PageForm->loadObjects()
setForm()
This protected method is inherited from I2CE_PageForm->setForm()
usesConfirmPage()
This public method is inherited from I2CE_PageFormBase->usesConfirmPage()
action()
This protected method is inherited from I2CE_PageFormBase->action()
action_display()
This protected method is inherited from I2CE_PageFormBase->action_display()
action_save()
This protected method is inherited from I2CE_PageFormBase->action_save()
canSave()
This protected method is inherited from I2CE_PageFormBase->canSave()
checkActionPermission()
This protected method is inherited from I2CE_PageFormBase->checkActionPermission()
isConfirm()
This protected method is inherited from I2CE_PageFormBase->isConfirm()
isEdit()
This protected method is inherited from I2CE_PageFormBase->isEdit()
isEditing()
This protected method is inherited from I2CE_PageFormBase->isEditing()
isSave()
This protected method is inherited from I2CE_PageFormBase->isSave()
setEditing()
This protected method is inherited from I2CE_PageFormBase->setEditing()
_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()
getURLRoot()
This public method is inherited from I2CE_Page->getURLRoot()
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()
displayCommandLine()
This protected method is inherited from I2CE_Page->displayCommandLine()
displayWeb()
This protected method is inherited from I2CE_Page->displayWeb()
getAccess()
This protected method is inherited from I2CE_Page->getAccess()
initializeTemplate()
This protected method is inherited from I2CE_Page->initializeTemplate()
setActiveMenu()
This protected method is inherited from I2CE_Page->setActiveMenu()
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
$editing
Theis protected variable is inherited from I2CE_PageFormBase->$editing
$factory
Theis protected variable is inherited from I2CE_PageFormBase->$factory
$button_templates
Theis protected variable is inherited from I2CE_PageFormBase->$button_templates
$checked_validation
Theis protected variable is inherited from I2CE_PageFormBase->$checked_validation
$usesConfimPage
Theis protected variable is inherited from I2CE_PageFormBase->$usesConfimPage
$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
$redirect
Theis protected variable is inherited from I2CE_Page->$redirect
$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
$root_url
Theis protected variable is inherited from I2CE_Page->$root_url
$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()
addReportSelector()
This method is inherited from I2CE_Page->addReportSelector()
addDatePicker()
This method is inherited from I2CE_Page->addDatePicker()
selectOptionsImmediate()
This method is inherited from I2CE_Page->selectOptionsImmediate()
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()
useDropDown()
This method is inherited from I2CE_Page->useDropDown()
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()
makeJumper()
This method is inherited from I2CE_Page->makeJumper()
makeScalingJumper()
This method is inherited from I2CE_Page->makeScalingJumper()
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()
addAjaxLoad()
This method is inherited from I2CE_Page->addAjaxLoad()
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()