Class: iHRIS PageFormParentTrainingInstitution: Difference between revisions

From IHRIS Wiki
No edit summary
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
The class iHRIS_PageFormParentTrainingInstitution contains 2 definitions:
#REDIRECT [[Class: iHRIS_PageFormParentTrainingInstitution (4.1.7)]]
*Definition in [[#qualify/lib/iHRIS_PageFormParentTrainingInstitution.php|qualify/lib/iHRIS_PageFormParentTrainingInstitution.php]] of the package <span style='color:Teal'>iHRIS Qualify</span>
*Definition in [[#common/modules/TrainingInstitution/lib/iHRIS_PageFormParentTrainingInstitution.php|common/modules/TrainingInstitution/lib/iHRIS_PageFormParentTrainingInstitution.php]] of the package <span style='color:SaddleBrown'>iHRIS Common</span>
=qualify/lib/iHRIS_PageFormParentTrainingInstitution.php=
This article describes the class ''iHRIS_PageFormParentTrainingInstitution''.
*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]]
*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_PageFormParentTrainingInstitution.php lib/iHRIS_PageFormParentTrainingInstitution.php]
*Author: Luke Duncan <lduncan@intrahealth.org>
*Since: v2.0.0
Manage adding or editing forms associated with a training institution to the database.    @copyright Copyright &copy; 2007, 2008 IntraHealth International, Inc.
==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
 
==Methods==
===__construct()===
Create a new instance of a page. The default constructor should be called by any pages extending this object.  It creates the [[Class: I2CE_Template | ]] and [[Class: I2CE_User | ]] objects and sets up the basic member variables.
*Signature: public function __construct($args,$request_remainder)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $args
** [http://www.php.net/manual/en/language.types.array.php array ] $request_remainder <br/>The remainder of the request path
===displayControls()===
Display the save or confirm button templates as needed.
*Signature: protected function displayControls($save,$show_edit)
*Parameters:
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $save <br/>Flag to show the save button.
***Default Value: false
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $show_edit <br/>(defaults to true)
***Default Value: true
===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()===
Override the default save method to redirect back the training institution page.
*Signature: protected function save()
===setDisplayData()===
Set the data to be displayed for the page.
*Signature: protected function setDisplayData()
 
=common/modules/TrainingInstitution/lib/iHRIS_PageFormParentTrainingInstitution.php=
This article describes the class ''iHRIS_PageFormParentTrainingInstitution''.
*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]]
*Location: Part of the module [[iHRIS Common Module List#training-institution|training-institution]] 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/TrainingInstitution/lib/iHRIS_PageFormParentTrainingInstitution.php modules/TrainingInstitution/lib/iHRIS_PageFormParentTrainingInstitution.php]
*Author: Luke Duncan <lduncan@intrahealth.org>
*Since: v2.0.0
Manage adding or editing forms associated with a training institution to the database.    @copyright Copyright &copy; 2007, 2008 IntraHealth International, Inc.    Page object to handle the adding or editing forms associated with a training institution 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
 
==Methods==
===__construct()===
Create a new instance of a page. The default constructor should be called by any pages extending this object.  It creates the [[Class: I2CE_Template | ]] and [[Class: I2CE_User | ]] objects and sets up the basic member variables.
*Signature: public function __construct($args,$request_remainder)
*Parameters:
** [http://www.php.net/manual/en/language.types.array.php array ] $args
** [http://www.php.net/manual/en/language.types.array.php array ] $request_remainder <br/>The remainder of the request path
===displayControls()===
Display the save or confirm button templates as needed.
*Signature: protected function displayControls($save,$show_edit)
*Parameters:
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $save <br/>Flag to show the save button.
***Default Value: false
** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $show_edit <br/>(defaults to true)
***Default Value: true
===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()===
Override the default save method to redirect back the training institution page.
*Signature: protected function save()
===setDisplayData()===
Set the data to be displayed for the page.
*Signature: protected function setDisplayData()
 
 
 
[[Category:Class Documentation]]

Latest revision as of 10:05, 23 August 2013