Class: iHRIS PageFormParentPerson: Difference between revisions
No edit summary |
No edit summary |
||
Line 7: | Line 7: | ||
** [[Class: iHRIS_PageFormGraduate | iHRIS_PageFormGraduate]] | ** [[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] | *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. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/lib/iHRIS_PageFormParentPerson.php#L39 modules/Person/lib/iHRIS_PageFormParentPerson.php] on line 39 | ||
*Author: Luke Duncan <lduncan@intrahealth.org> | *Author: Luke Duncan <lduncan@intrahealth.org> | ||
*Since: v2.0.0 | *Since: v2.0.0 | ||
Line 14: | Line 14: | ||
===$id=== | ===$id=== | ||
The record id number of the object being edited. | The record id number of the object being edited. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/lib/iHRIS_PageFormParentPerson.php#L53 common/modules/Person/lib/iHRIS_PageFormParentPerson.php] on line 53 | |||
*Type: protected integer $id | *Type: protected integer $id | ||
===$parent_id=== | ===$parent_id=== | ||
The recored if number of the parent of the object being edited | The recored if number of the parent of the object being edited | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/lib/iHRIS_PageFormParentPerson.php#L57 common/modules/Person/lib/iHRIS_PageFormParentPerson.php] on line 57 | |||
*Type: protected integer $parent_id | *Type: protected integer $parent_id | ||
===$form_name=== | ===$form_name=== | ||
The form name being edited by this page. | The form name being edited by this page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/lib/iHRIS_PageFormParentPerson.php#L62 common/modules/Person/lib/iHRIS_PageFormParentPerson.php] on line 62 | |||
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $form_name | *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $form_name | ||
===$form_link=== | ===$form_link=== | ||
The link used to access this form $var protected string $form_link | The link used to access this form $var protected string $form_link | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/lib/iHRIS_PageFormParentPerson.php#L68 common/modules/Person/lib/iHRIS_PageFormParentPerson.php] on line 68 | |||
*Type: protected $form_link | *Type: protected $form_link | ||
Line 31: | Line 35: | ||
===__construct()=== | ===__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. | 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. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/lib/iHRIS_PageFormParentPerson.php#L91 common/modules/Person/lib/iHRIS_PageFormParentPerson.php] on line 91 | |||
*Signature: public function __construct($args,$request_remainder) | *Signature: public function __construct($args,$request_remainder) | ||
*Parameters: | *Parameters: | ||
Line 37: | Line 42: | ||
===getForm()=== | ===getForm()=== | ||
Return the form name for this page. It will be used for the default form template and php page for the form submission. | Return the form name for this page. It will be used for the default form template and php page for the form submission. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/lib/iHRIS_PageFormParentPerson.php#L48 common/modules/Person/lib/iHRIS_PageFormParentPerson.php] on line 48 | |||
*Signature: protected function getForm($html) | *Signature: protected function getForm($html) | ||
*Parameters: | *Parameters: | ||
Line 44: | Line 50: | ||
===loadHTMLTemplates()=== | ===loadHTMLTemplates()=== | ||
Load the HTML template files for editing. | Load the HTML template files for editing. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/lib/iHRIS_PageFormParentPerson.php#L158 common/modules/Person/lib/iHRIS_PageFormParentPerson.php] on line 158 | |||
*Signature: protected function loadHTMLTemplates() | *Signature: protected function loadHTMLTemplates() | ||
===loadObjects()=== | ===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. | 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. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/lib/iHRIS_PageFormParentPerson.php#L108 common/modules/Person/lib/iHRIS_PageFormParentPerson.php] on line 108 | |||
*Signature: protected function loadObjects() | *Signature: protected function loadObjects() | ||
===save()=== | ===save()=== | ||
Save the objects to the database. Save the default object being edited and return to the view page. @global array | Save the objects to the database. Save the default object being edited and return to the view page. @global array | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/lib/iHRIS_PageFormParentPerson.php#L181 common/modules/Person/lib/iHRIS_PageFormParentPerson.php] on line 181 | |||
*Signature: protected function save() | *Signature: protected function save() | ||
===setDisplayData()=== | ===setDisplayData()=== | ||
Set the data to be displayed for the page. | Set the data to be displayed for the page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/lib/iHRIS_PageFormParentPerson.php#L168 common/modules/Person/lib/iHRIS_PageFormParentPerson.php] on line 168 | |||
*Signature: protected function setDisplayData() | *Signature: protected function setDisplayData() | ||
===setFormLink()=== | ===setFormLink()=== | ||
Sets the form link | Sets the form link | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/ihris-common/4.0.2-release/annotate/head:/modules/Person/lib/iHRIS_PageFormParentPerson.php#L74 common/modules/Person/lib/iHRIS_PageFormParentPerson.php] on line 74 | |||
*Signature: public function setFormLink($link) | *Signature: public function setFormLink($link) | ||
*Parameters: | *Parameters: |
Revision as of 09:21, 10 November 2009
This article describes the class iHRIS_PageFormParentPerson.
- Extends the class: I2CE_PageForm.
- Child Classes:
- Location: Part of the module Person in the package iHRIS Common
- Source: Defined in the file modules/Person/lib/iHRIS_PageFormParentPerson.php on line 39
- Author: Luke Duncan <lduncan@intrahealth.org>
- Since: v2.0.0
Manage adding or editing forms associated with a person to the database. @copyright Copyright © 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.
- Defined in common/modules/Person/lib/iHRIS_PageFormParentPerson.php on line 53
- Type: protected integer $id
$parent_id
The recored if number of the parent of the object being edited
- Defined in common/modules/Person/lib/iHRIS_PageFormParentPerson.php on line 57
- Type: protected integer $parent_id
$form_name
The form name being edited by this page.
- Defined in common/modules/Person/lib/iHRIS_PageFormParentPerson.php on line 62
- Type: protected string $form_name
$form_link
The link used to access this form $var protected string $form_link
- Defined in common/modules/Person/lib/iHRIS_PageFormParentPerson.php on line 68
- 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 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.
- Defined in common/modules/Person/lib/iHRIS_PageFormParentPerson.php on line 91
- 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.
- Defined in common/modules/Person/lib/iHRIS_PageFormParentPerson.php on line 48
- 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.
- Defined in common/modules/Person/lib/iHRIS_PageFormParentPerson.php on line 158
- 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.
- Defined in common/modules/Person/lib/iHRIS_PageFormParentPerson.php on line 108
- 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
- Defined in common/modules/Person/lib/iHRIS_PageFormParentPerson.php on line 181
- Signature: protected function save()
setDisplayData()
Set the data to be displayed for the page.
- Defined in common/modules/Person/lib/iHRIS_PageFormParentPerson.php on line 168
- Signature: protected function setDisplayData()
setFormLink()
Sets the form link
- Defined in common/modules/Person/lib/iHRIS_PageFormParentPerson.php on line 74
- Signature: public function setFormLink($link)
- Parameters:
- string $link
Inherited Methods
hasInvalid()
This public method is inherited from I2CE_PageForm->hasInvalid()
invalidMessage()
This public method is inherited from I2CE_PageForm->invalidMessage()
setFormAttributes()
This public method is inherited from I2CE_PageForm->setFormAttributes()
usesConfirmPage()
This public method is inherited from I2CE_PageForm->usesConfirmPage()
action()
This protected method is inherited from I2CE_PageForm->action()
displayControls()
This protected method is inherited from I2CE_PageForm->displayControls()
getParent()
This protected method is inherited from I2CE_PageForm->getParent()
getPrimary()
This protected method is inherited from I2CE_PageForm->getPrimary()
isConfirm()
This protected method is inherited from I2CE_PageForm->isConfirm()
isEdit()
This protected method is inherited from I2CE_PageForm->isEdit()
isEditing()
This protected method is inherited from I2CE_PageForm->isEditing()
isSave()
This protected method is inherited from I2CE_PageForm->isSave()
setEditing()
This protected method is inherited from I2CE_PageForm->setEditing()
setForm()
This protected method is inherited from I2CE_PageForm->setForm()
setObject()
This protected method is inherited from I2CE_PageForm->setObject()
validate()
This protected method is inherited from I2CE_PageForm->validate()
_flattenRequestVars()
This public method is inherited from I2CE_Page->_flattenRequestVars()
display()
This public method is inherited from I2CE_Page->display()
fixupRequestVariables()
This public method is inherited from I2CE_Page->fixupRequestVariables()
flattenRequestVars()
This public method is inherited from I2CE_Page->flattenRequestVars()
get()
This public method is inherited from I2CE_Page->get()
getAccessedBaseURL()
This public method is inherited from I2CE_Page->getAccessedBaseURL()
getTemplate()
This public method is inherited from I2CE_Page->getTemplate()
getUser()
This public method is inherited from I2CE_Page->getUser()
get_exists()
This public method is inherited from I2CE_Page->get_exists()
hasPermission()
This public method is inherited from I2CE_Page->hasPermission()
isGet()
This public method is inherited from I2CE_Page->isGet()
isPost()
This public method is inherited from I2CE_Page->isPost()
module()
This public method is inherited from I2CE_Page->module()
page()
This public method is inherited from I2CE_Page->page()
pageRemainder()
This public method is inherited from I2CE_Page->pageRemainder()
pageRoot()
This public method is inherited from I2CE_Page->pageRoot()
post()
This public method is inherited from I2CE_Page->post()
post_exists()
This public method is inherited from I2CE_Page->post_exists()
redirect()
This public method is inherited from I2CE_Page->redirect()
request()
This public method is inherited from I2CE_Page->request()
request_exists()
This public method is inherited from I2CE_Page->request_exists()
rewrittenURLs()
This public method is inherited from I2CE_Page->rewrittenURLs()
session_req()
This public method is inherited from I2CE_Page->session_req()
session_req_exists()
This public method is inherited from I2CE_Page->session_req_exists()
setAccess()
This public method is inherited from I2CE_Page->setAccess()
setIsPost()
This public method is inherited from I2CE_Page->setIsPost()
setRedirect()
This public method is inherited from I2CE_Page->setRedirect()
_display()
This protected method is inherited from I2CE_Page->_display()
actionCommandLine()
This protected method is inherited from I2CE_Page->actionCommandLine()
getAccess()
This protected method is inherited from I2CE_Page->getAccess()
getTitle()
This protected method is inherited from I2CE_Page->getTitle()
initializeTemplate()
This protected method is inherited from I2CE_Page->initializeTemplate()
setupGetPost()
This protected method is inherited from I2CE_Page->setupGetPost()
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
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()
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()