Class: iHRIS PageFormSalary: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 2: Line 2:
*Extends the class: [[Class: I2CE_PageForm | I2CE_PageForm]].
*Extends the class: [[Class: I2CE_PageForm | I2CE_PageForm]].
*Location: Part of the module [[iHRIS Manage Module List#ihris-manage-PersonPosition|ihris-manage-PersonPosition]] in the package [https://launchpad.net/ihris-manage iHRIS Manage]
*Location: Part of the module [[iHRIS Manage 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.1-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L39 modules/ManagePersonPosition/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 9: Line 9:
===$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.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L56 manage/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php] on line 56
*Type: private integer $last_id
*Type: private integer $last_id


===$last===
===$last===
the [[Class: iHRIS_Salary | ]] object for the previous record.
the [[Class: iHRIS_Salary | ]] object for the previous record.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L60 manage/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php] on line 60
*Type: private [[Class: I2CE_Form | I2CE_Form]] $last
*Type: private [[Class: I2CE_Form | 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.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L77 manage/modules/ManagePersonPosition/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.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L81 manage/modules/ManagePersonPosition/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.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L86 manage/modules/ManagePersonPosition/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.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L92 manage/modules/ManagePersonPosition/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.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L97 manage/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php] on line 97
*Type: protected $person_position
*Type: protected $person_position


Line 38: Line 45:
===__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.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L113 manage/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php] on line 113
*Signature: public function __construct($args,$request_remainder)
*Signature: public function __construct($args,$request_remainder)
*Parameters:
*Parameters:
Line 44: Line 52:
===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.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L265 manage/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php] on line 265
*Signature: protected function displayControls($save,$show_edit)
*Signature: protected function displayControls($save,$show_edit)
*Parameters:
*Parameters:
Line 52: Line 61:
===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.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L44 manage/modules/ManagePersonPosition/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.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L67 manage/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php] on line 67
*Signature: protected function getForm($html)
*Signature: protected function getForm($html)
*Parameters:
*Parameters:
Line 63: Line 74:
===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.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L50 manage/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php] on line 50
*Signature: protected function getTitle()
*Signature: protected 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 ]
===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.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L151 manage/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php] on line 151
*Signature: protected function loadHTMLTemplates()
*Signature: protected function loadHTMLTemplates()
===loadObjects()===
===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  member variable.
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  member variable.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L164 manage/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php] on line 164
*Signature: protected function loadObjects()
*Signature: protected function loadObjects()
===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.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L281 manage/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php] on line 281
*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.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L214 manage/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php] on line 214
*Signature: protected function setDisplayData()
*Signature: protected function setDisplayData()
===setForm()===
===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.
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.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L225 manage/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php] on line 225
*Signature: protected function setForm()
*Signature: protected function setForm()
===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 | ::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 | ::validate() validate]] method on the  object.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-manage/4.0.2-release/annotate/head:/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php#L243 manage/modules/ManagePersonPosition/lib/iHRIS_PageFormSalary.php] on line 243
*Signature: protected function validate()
*Signature: protected function validate()
==Inherited Methods==
==Inherited Methods==

Revision as of 10:21, 10 November 2009

This article describes the class iHRIS_PageFormSalary.

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

$last

the object for the previous record.

$id

The record id number of the object being edited.

$position_id

The record id number of the parent person_position of the object being edited

$person_id

The record id number of the person of the object being edited

$person

person The person of the object being edited

$person_position

@var PersonPosition $personPosition The record id number of the person of the object being edited

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.

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.

getDefaultHTMLFile()

Return the default HTML file used by this page.

getForm()

Return the form name for this page.

getTitle()

Return the title for this page.

loadHTMLTemplates()

Load the HTML template files for editing.

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 member variable.

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.

setDisplayData()

Set the data to be displayed for the page.

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.

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.

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

action()

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

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

setEditing()

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

setObject()

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

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

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

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

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

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_iHRIS_PageFormSalary&oldid=10874"