Class: iHRIS PageFormParentPerson: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 1: Line 1:
This article desrcibes the class '''iHRIS_PageFormParentPerson''' which extends the class [[Class: I2CE_PageForm | I2CE_PageForm]]
This article desrcibes the class '''iHRIS_PageFormParentPerson'''.
*Extends the class: [[Class: I2CE_PageForm | I2CE_PageForm]].
It is contained in the module [[iHRIS Module List#Person|Person]] in the package [https://launchpad.net/ihris-common iHRIS Common]
It is contained in the module [[iHRIS Module List#Person|Person]] in the package [https://launchpad.net/ihris-common iHRIS Common]


Line 49: Line 50:
It will be used for the default form template and php page for the form submission.
It will be used for the default form template and php page for the form submission.
*Signature: protected function getForm($html)
*Signature: protected function getForm($html)
*Returns: [http://www.php.net/manual/en/language.types.string.php string]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
Parameters:
Parameters:
* [http://www.php.net/manual/en/language.types.boolean.php boolean] $html<br/>Set to true if this is to be used for the html template page to load.
* [http://www.php.net/manual/en/language.types.boolean.php boolean ] $html<br/>Set to true if this is to be used for the html template page to load.
**Default Value: false  
**Default Value: false  
===loadHTMLTemplates()===
===loadHTMLTemplates()===
Line 76: Line 77:
*Signature: public function setFormLink($link)
*Signature: public function setFormLink($link)
Parameters:
Parameters:
* [http://www.php.net/manual/en/language.types.string.php string] $link
* [http://www.php.net/manual/en/language.types.string.php string ] $link
==Inherited Variables==
==Inherited Variables==
===$objects===
===$objects===

Revision as of 21:25, 16 October 2009

This article desrcibes the class iHRIS_PageFormParentPerson.

It is contained in the module Person in the package iHRIS Common

The class is defined in the file: modules/Person/lib/iHRIS_PageFormParentPerson.php

Manage adding or editing forms associated with a person to the database. @subpackage Common @copyright Copyright © 2007, 2008 IntraHealth International, Inc. Page object to handle the adding or editing forms associated with a person to the database. @subpackage Common

  • Author: Luke Duncan <lduncan@intrahealth.org>
  • Since: v2.0.0

Variables

$id

The record id number of the object being edited.

  • Type: protected nteger $id

$parent_id

The recored if number of the parent of the object being edited

  • Type: protected nteger $parent_id

$form_name

The form name being edited by this page.

  • Type: protected ng $form_name

$form_link

The link used to access this form $var protected string $form_link

  • Type: protected $form_link

Methods

__construct()

Create a new instance of this page.

This will call the parent constructor and then setup the base template pages for the {@link I2CE_Template template}. It also sets up the values for the member variables. @param string $title The title for this page. @param string $form_name The form name of the form being edited. @param mixed $access The role required to access this page. @param array $files The list of template files to load for this page.

  • Signature: public function __construct($args,$request_remainder)

Parameters:

  • $args
  • $request_remainder

getForm()

Return the form name for this page.

It will be used for the default form template and php page for the form submission.

  • Signature: protected function getForm($html)
  • Returns: string

Parameters:

  • boolean $html
    Set to true if this is to be used for the html template page to load.
    • Default Value: false

loadHTMLTemplates()

Load the HTML template files for editing.

  • Signature: protected function loadHTMLTemplates()

loadObjects()

Create and load data for the objects used for this form.

Create the list object and if this is a form submission load the data from the form data. It determines the type based on the {@link $type} member variable.

  • Signature: protected function loadObjects()

save()

Save the objects to the database.

Save the default object being edited and return to the view page. @global array

  • Signature: protected function save()

setDisplayData()

Set the data to be displayed for the page.

  • Signature: protected function setDisplayData()

setFormLink()

Sets the form link

  • Signature: public function setFormLink($link)

Parameters:

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

setDisplayData()

This method is inherited from I2CE_Page->setDisplayData()

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

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

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