Class: iHRIS PageFormParentPerson: Difference between revisions

From IHRIS Wiki
(Created page with 'This article desrcibes the class '''iHRIS_PageFormParentPerson'''which extends the class I2CE_PageForm It is contained in the module [[iHRIS Module Lis…')
 
 
(34 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article desrcibes the class '''iHRIS_PageFormParentPerson'''which extends the class [[Class: I2CE_PageForm | I2CE_PageForm]]
#REDIRECT [[Class: iHRIS_PageFormParentPerson (4.1.7)]]
It is contained in the module [[iHRIS Module List#Person|Person]] in the package [https://launchpad.net/ihris-common iHRIS Common]
The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.0-release/files/head:modules/Person/lib/iHRIS_PageFormParentPerson.php modules/Person/lib/iHRIS_PageFormParentPerson.php]
Manage adding or editing forms associated with a person to the database.
 
@package iHRIS
@subpackage Common
@access public
@author Luke Duncan <lduncan@intrahealth.org>
@copyright Copyright &copy; 2007, 2008 IntraHealth International, Inc.
@since v2.0.0
@version v2.0.0
Page object to handle the adding or editing forms associated with a person to the database.
 
@package iHRIS
@subpackage Common
@access public
==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: [http://www.php.net/manual/en/language.types.string.php string]
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.
**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:
* [http://www.php.net/manual/en/language.types.string.php string] $link
==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]]
==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()]]
 
 
[[Category:Class Documentation]]

Latest revision as of 09:05, 23 August 2013