Class: iHRIS PageFormSalary (Development)

For other versions, see Class: iHRIS_PageFormSalary (versions) .

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:
  • boolean $save
    Flag to show the save button. (Defaults to false)
    • Default Value: false
  • boolean $show_edit
    (defaults to true) @global array
    • Default Value: true

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

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

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