Class: iHRIS PageFormParentPerson: Difference between revisions

From IHRIS Wiki
No edit summary
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article describes the class ''iHRIS_PageFormParentPerson''.
#REDIRECT [[Class: iHRIS_PageFormParentPerson (4.1.7)]]
*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]]
*Child Classes:
** [[Class: iHRIS_PageFormContact | iHRIS_PageFormContact]]
** [[Class: iHRIS_PageFormDeparture | iHRIS_PageFormDeparture]]
** [[Class: iHRIS_PageFormMakeOffer | iHRIS_PageFormMakeOffer]]
** [[Class: iHRIS_PageFormGraduate | iHRIS_PageFormGraduate]]
*Location: Part of the module [[iHRIS Common Module List#Person|Person]] in the package [https://launchpad.net/ihris-common iHRIS Common]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.0-release/annotate/head:/modules/Person/lib/iHRIS_PageFormParentPerson.php modules/Person/lib/iHRIS_PageFormParentPerson.php]
*Author: Luke Duncan <lduncan@intrahealth.org>
*Since: v2.0.0
Manage adding or editing forms associated with a person to the database.    @copyright Copyright &copy; 2007, 2008 IntraHealth International, Inc.    Page object to handle the adding or editing forms associated with a person to the database.
==Variables==
===$id===
The record id number of the object being edited.
*Type: protected integer $id
 
===$parent_id===
The recored if number of the parent of the object being edited
*Type: protected integer $parent_id
 
===$form_name===
The form name being edited by this page.
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $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 [[Class: 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)
*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
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===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  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
 
 
[[Category:Class Documentation]]

Latest revision as of 09:05, 23 August 2013