Class: iHRIS PageFormParentTrainingInstitution: Difference between revisions
No edit summary |
No edit summary |
||
| Line 25: | Line 25: | ||
==Methods== | ==Methods== | ||
===__construct()=== | ===__construct()=== | ||
Create a new instance of a page. | 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 | I2CE_Template]] and [[Class: I2CE_User | I2CE_User]] objects and sets up the basic member variables. | ||
The default constructor should be called by any pages extending this object. It creates the | |||
[[Class: I2CE_Template | I2CE_Template]] and [[Class: I2CE_User | I2CE_User]] objects and sets up the basic member variables. | |||
*Signature: public function __construct($args,$request_remainder) | *Signature: public function __construct($args,$request_remainder) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $args | ** [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 | ** [http://www.php.net/manual/en/language.types.array.php array ] $request_remainder <br/>The remainder of the request path | ||
===displayControls()=== | ===displayControls()=== | ||
Display the save or confirm button templates as needed. | Display the save or confirm button templates as needed. | ||
*Signature: protected function displayControls($save,$show_edit) | *Signature: protected function displayControls($save,$show_edit) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.types.boolean.php boolean ] $save<br/>Flag to show the save button. | ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $save <br/>Flag to show the save button. | ||
**Default Value: false | ***Default Value: false | ||
* [http://www.php.net/manual/en/language.types.boolean.php boolean ] $show_edit<br/>(defaults to true) | ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $show_edit <br/>(defaults to true) | ||
**Default Value: true | ***Default Value: true | ||
===getForm()=== | ===getForm()=== | ||
Return the form name for this page. | Return the form name for this page. 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) | ||
*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 ] | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] | ||
===loadHTMLTemplates()=== | ===loadHTMLTemplates()=== | ||
Load the HTML template files for editing. | Load the HTML template files for editing. | ||
*Signature: protected function loadHTMLTemplates() | *Signature: protected function loadHTMLTemplates() | ||
===loadObjects()=== | ===loadObjects()=== | ||
Create and load data for the objects used for this form. | 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. | ||
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() | *Signature: protected function loadObjects() | ||
===save()=== | ===save()=== | ||
| Line 270: | Line 261: | ||
==Methods== | ==Methods== | ||
===__construct()=== | ===__construct()=== | ||
Create a new instance of a page. | 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 | I2CE_Template]] and [[Class: I2CE_User | I2CE_User]] objects and sets up the basic member variables. | ||
The default constructor should be called by any pages extending this object. It creates the | |||
[[Class: I2CE_Template | I2CE_Template]] and [[Class: I2CE_User | I2CE_User]] objects and sets up the basic member variables. | |||
*Signature: public function __construct($args,$request_remainder) | *Signature: public function __construct($args,$request_remainder) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.types.array.php array ] $args | ** [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 | ** [http://www.php.net/manual/en/language.types.array.php array ] $request_remainder <br/>The remainder of the request path | ||
===displayControls()=== | ===displayControls()=== | ||
Display the save or confirm button templates as needed. | Display the save or confirm button templates as needed. | ||
*Signature: protected function displayControls($save,$show_edit) | *Signature: protected function displayControls($save,$show_edit) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.types.boolean.php boolean ] $save<br/>Flag to show the save button. | ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $save <br/>Flag to show the save button. | ||
**Default Value: false | ***Default Value: false | ||
* [http://www.php.net/manual/en/language.types.boolean.php boolean ] $show_edit<br/>(defaults to true) | ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $show_edit <br/>(defaults to true) | ||
**Default Value: true | ***Default Value: true | ||
===getForm()=== | ===getForm()=== | ||
Return the form name for this page. | Return the form name for this page. 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) | ||
*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 ] | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] | ||
===loadHTMLTemplates()=== | ===loadHTMLTemplates()=== | ||
Load the HTML template files for editing. | Load the HTML template files for editing. | ||
*Signature: protected function loadHTMLTemplates() | *Signature: protected function loadHTMLTemplates() | ||
===loadObjects()=== | ===loadObjects()=== | ||
Create and load data for the objects used for this form. | 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. | ||
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() | *Signature: protected function loadObjects() | ||
===save()=== | ===save()=== | ||
Revision as of 22:42, 16 October 2009
The class iHRIS_PageFormParentTrainingInstitution contains 2 definitions:
- Definition in lib/iHRIS_PageFormParentTrainingInstitution.php
- Definition in modules/TrainingInstitution/lib/iHRIS_PageFormParentTrainingInstitution.php
modules/TrainingInstitution/lib/iHRIS_PageFormParentTrainingInstitution.php
This article desrcibes the class iHRIS_PageFormParentTrainingInstitution.
- Extends the class: I2CE_PageForm.
- Location: Part of the module training-institution in the package iHRIS Common
- Source: Defined in the file 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 © 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 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
Methods
__construct()
Create a new instance of a page. The default constructor should be called by any pages extending this object. It creates the I2CE_Template and I2CE_User objects and sets up the basic member variables.
- Signature: public function __construct($args,$request_remainder)
- Parameters:
displayControls()
Display the save or confirm button templates as needed.
- Signature: protected function displayControls($save,$show_edit)
- Parameters:
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:
- boolean $html
Set to true if this is to be used for the html template page to load.- Default Value: false
- boolean $html
- Returns: 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 {@link $type} 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()
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()
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()
modules/TrainingInstitution/lib/iHRIS_PageFormParentTrainingInstitution.php
This article desrcibes the class iHRIS_PageFormParentTrainingInstitution.
- Extends the class: I2CE_PageForm.
- Location: Part of the module training-institution in the package iHRIS Common
- Source: Defined in the file 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 © 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 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
Methods
__construct()
Create a new instance of a page. The default constructor should be called by any pages extending this object. It creates the I2CE_Template and I2CE_User objects and sets up the basic member variables.
- Signature: public function __construct($args,$request_remainder)
- Parameters:
displayControls()
Display the save or confirm button templates as needed.
- Signature: protected function displayControls($save,$show_edit)
- Parameters:
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:
- boolean $html
Set to true if this is to be used for the html template page to load.- Default Value: false
- boolean $html
- Returns: 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 {@link $type} 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()
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()
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()
