Class: iHRIS PageFormFacilityInstitution: 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]].
*Parent Classses:  [[Class: I2CE_PageForm | I2CE_PageForm]] [[Class: I2CE_Page | I2CE_Page]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
*Parent Classses:  [[Class: I2CE_PageForm | I2CE_PageForm]] [[Class: I2CE_Page | I2CE_Page]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
*Location: Part of the module [[iHRIS Module List#ihris-qualify|ihris-qualify]] in the package [https://launchpad.net/qualify iHRIS Qualify]
*Location: Part of the module [[iHRIS Qualify Module List#ihris-qualify|ihris-qualify]] in the package [https://launchpad.net/qualify iHRIS Qualify]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0.-release/annotate/head:/lib/iHRIS_PageFormFacilityInstitution.php lib/iHRIS_PageFormFacilityInstitution.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/qualify/4.0.-release/annotate/head:/lib/iHRIS_PageFormFacilityInstitution.php lib/iHRIS_PageFormFacilityInstitution.php]
*Author: Luke Duncan <lduncan@intrahealth.org>
*Author: Luke Duncan <lduncan@intrahealth.org>
Line 29: Line 29:
** [http://www.php.net/manual/en/language.types.string.php string ] $value
** [http://www.php.net/manual/en/language.types.string.php string ] $value
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
==Inherited Methods==
===__construct()===
This public method is inherited from [[Class: I2CE_PageForm#__construct() | I2CE_PageForm->__construct()]]
===hasInvalid()===
This public method is inherited from [[Class: I2CE_PageForm#hasInvalid() | I2CE_PageForm->hasInvalid()]]
===invalidMessage()===
This public method is inherited from [[Class: I2CE_PageForm#invalidMessage() | I2CE_PageForm->invalidMessage()]]
===setFormAttributes()===
This public method is inherited from [[Class: I2CE_PageForm#setFormAttributes() | I2CE_PageForm->setFormAttributes()]]
===usesConfirmPage()===
This public method is inherited from [[Class: I2CE_PageForm#usesConfirmPage() | I2CE_PageForm->usesConfirmPage()]]
===getParent()===
This protected method is inherited from [[Class: I2CE_PageForm#getParent() | I2CE_PageForm->getParent()]]
===getPrimary()===
This protected method is inherited from [[Class: I2CE_PageForm#getPrimary() | I2CE_PageForm->getPrimary()]]
===isConfirm()===
This protected method is inherited from [[Class: I2CE_PageForm#isConfirm() | I2CE_PageForm->isConfirm()]]
===isEdit()===
This protected method is inherited from [[Class: I2CE_PageForm#isEdit() | I2CE_PageForm->isEdit()]]
===isEditing()===
This protected method is inherited from [[Class: I2CE_PageForm#isEditing() | I2CE_PageForm->isEditing()]]
===isSave()===
This protected method is inherited from [[Class: I2CE_PageForm#isSave() | I2CE_PageForm->isSave()]]
===loadObjects()===
This protected method is inherited from [[Class: I2CE_PageForm#loadObjects() | I2CE_PageForm->loadObjects()]]
===setDisplayData()===
This protected method is inherited from [[Class: I2CE_PageForm#setDisplayData() | I2CE_PageForm->setDisplayData()]]
===setEditing()===
This protected method is inherited from [[Class: I2CE_PageForm#setEditing() | I2CE_PageForm->setEditing()]]
===setForm()===
This protected method is inherited from [[Class: I2CE_PageForm#setForm() | I2CE_PageForm->setForm()]]
===setObject()===
This protected method is inherited from [[Class: I2CE_PageForm#setObject() | I2CE_PageForm->setObject()]]
===validate()===
This protected method is inherited from [[Class: I2CE_PageForm#validate() | I2CE_PageForm->validate()]]
===_flattenRequestVars()===
This public method is inherited from [[Class: I2CE_Page#_flattenRequestVars() | I2CE_Page->_flattenRequestVars()]]
===display()===
This public method is inherited from [[Class: I2CE_Page#display() | I2CE_Page->display()]]
===fixupRequestVariables()===
This public method is inherited from [[Class: I2CE_Page#fixupRequestVariables() | I2CE_Page->fixupRequestVariables()]]
===flattenRequestVars()===
This public method is inherited from [[Class: I2CE_Page#flattenRequestVars() | I2CE_Page->flattenRequestVars()]]
===get()===
This public method is inherited from [[Class: I2CE_Page#get() | I2CE_Page->get()]]
===getAccessedBaseURL()===
This public method is inherited from [[Class: I2CE_Page#getAccessedBaseURL() | I2CE_Page->getAccessedBaseURL()]]
===getTemplate()===
This public method is inherited from [[Class: I2CE_Page#getTemplate() | I2CE_Page->getTemplate()]]
===getUser()===
This public method is inherited from [[Class: I2CE_Page#getUser() | I2CE_Page->getUser()]]
===get_exists()===
This public method is inherited from [[Class: I2CE_Page#get_exists() | I2CE_Page->get_exists()]]
===hasPermission()===
This public method is inherited from [[Class: I2CE_Page#hasPermission() | I2CE_Page->hasPermission()]]
===isGet()===
This public method is inherited from [[Class: I2CE_Page#isGet() | I2CE_Page->isGet()]]
===isPost()===
This public method is inherited from [[Class: I2CE_Page#isPost() | I2CE_Page->isPost()]]
===module()===
This public method is inherited from [[Class: I2CE_Page#module() | I2CE_Page->module()]]
===page()===
This public method is inherited from [[Class: I2CE_Page#page() | I2CE_Page->page()]]
===pageRemainder()===
This public method is inherited from [[Class: I2CE_Page#pageRemainder() | I2CE_Page->pageRemainder()]]
===pageRoot()===
This public method is inherited from [[Class: I2CE_Page#pageRoot() | I2CE_Page->pageRoot()]]
===post()===
This public method is inherited from [[Class: I2CE_Page#post() | I2CE_Page->post()]]
===post_exists()===
This public method is inherited from [[Class: I2CE_Page#post_exists() | I2CE_Page->post_exists()]]
===redirect()===
This public method is inherited from [[Class: I2CE_Page#redirect() | I2CE_Page->redirect()]]
===request()===
This public method is inherited from [[Class: I2CE_Page#request() | I2CE_Page->request()]]
===request_exists()===
This public method is inherited from [[Class: I2CE_Page#request_exists() | I2CE_Page->request_exists()]]
===rewrittenURLs()===
This public method is inherited from [[Class: I2CE_Page#rewrittenURLs() | I2CE_Page->rewrittenURLs()]]
===session_req()===
This public method is inherited from [[Class: I2CE_Page#session_req() | I2CE_Page->session_req()]]
===session_req_exists()===
This public method is inherited from [[Class: I2CE_Page#session_req_exists() | I2CE_Page->session_req_exists()]]
===setAccess()===
This public method is inherited from [[Class: I2CE_Page#setAccess() | I2CE_Page->setAccess()]]
===setIsPost()===
This public method is inherited from [[Class: I2CE_Page#setIsPost() | I2CE_Page->setIsPost()]]
===setRedirect()===
This public method is inherited from [[Class: I2CE_Page#setRedirect() | I2CE_Page->setRedirect()]]
===_display()===
This protected method is inherited from [[Class: I2CE_Page#_display() | I2CE_Page->_display()]]
===actionCommandLine()===
This protected method is inherited from [[Class: I2CE_Page#actionCommandLine() | I2CE_Page->actionCommandLine()]]
===getAccess()===
This protected method is inherited from [[Class: I2CE_Page#getAccess() | I2CE_Page->getAccess()]]
===getTitle()===
This protected method is inherited from [[Class: I2CE_Page#getTitle() | I2CE_Page->getTitle()]]
===initializeTemplate()===
This protected method is inherited from [[Class: I2CE_Page#initializeTemplate() | I2CE_Page->initializeTemplate()]]
===loadHTMLTemplates()===
This protected method is inherited from [[Class: I2CE_Page#loadHTMLTemplates() | I2CE_Page->loadHTMLTemplates()]]
===setupGetPost()===
This protected method is inherited from [[Class: I2CE_Page#setupGetPost() | I2CE_Page->setupGetPost()]]
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==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]]
[[Category:Class Documentation]]

Revision as of 13:12, 19 October 2009

This article describes the class iHRIS_PageFormFacilityInstitution.

Handles the action of linking health facilities with training institutions. @copyright Copyright © 2007, 2008 IntraHealth International, Inc. The page class for displaying the form to link health facilities with training institutions.

Methods

action()

Perform the main actions of the page.

  • Signature: protected function action()

displayControls()

Display the save or confirm button templates as needed.

  • Signature: protected function displayControls($save,$show_edit)
  • Parameters:
    • boolean $save
      Flag to show the save button.
      • Default Value: false
    • boolean $show_edit
      (defaults to true)
      • Default Value: true

save()

Save the objects to the database. This method overrides the default save because the object used to edit on this page needs to be converted to multiple FacilityInstitution objects.

  • Signature: protected function save()

search()

Search the database for the matching facilities or institutions.

  • Signature: protected function search($field,$value)
  • Parameters:
  • Returns: array