Class: iHRIS PageFormParentPerson: Difference between revisions

From IHRIS Wiki
No edit summary
 
(12 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]].
*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.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>
*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.
*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
 
===$parent_id===
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
 
===$form_name===
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
 
===$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
 
==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.
*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)
*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 [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)
*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.
*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()
===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 [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()
===save()===
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()
===setDisplayData()===
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()
===setFormLink()===
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)
*Parameters:
** [http://www.php.net/manual/en/language.types.string.php string ] $link
==Inherited Methods==
===hasInvalid()===
This public method is inherited from [[Class: I2CE_PageForm#hasInvalid() | I2CE_PageForm->hasInvalid()]]
 
===invalidMessage()===
This public method is inherited from [[Class: I2CE_PageForm#invalidMessage() | I2CE_PageForm->invalidMessage()]]
 
===setFormAttributes()===
This public method is inherited from [[Class: I2CE_PageForm#setFormAttributes() | I2CE_PageForm->setFormAttributes()]]
 
===usesConfirmPage()===
This public method is inherited from [[Class: I2CE_PageForm#usesConfirmPage() | I2CE_PageForm->usesConfirmPage()]]
 
===action()===
This protected method is inherited from [[Class: I2CE_PageForm#action() | I2CE_PageForm->action()]]
 
===displayControls()===
This protected method is inherited from [[Class: I2CE_PageForm#displayControls() | I2CE_PageForm->displayControls()]]
 
===getParent()===
This protected method is inherited from [[Class: I2CE_PageForm#getParent() | I2CE_PageForm->getParent()]]
 
===getPrimary()===
This protected method is inherited from [[Class: I2CE_PageForm#getPrimary() | I2CE_PageForm->getPrimary()]]
 
===isConfirm()===
This protected method is inherited from [[Class: I2CE_PageForm#isConfirm() | I2CE_PageForm->isConfirm()]]
 
===isEdit()===
This protected method is inherited from [[Class: I2CE_PageForm#isEdit() | I2CE_PageForm->isEdit()]]
 
===isEditing()===
This protected method is inherited from [[Class: I2CE_PageForm#isEditing() | I2CE_PageForm->isEditing()]]
 
===isSave()===
This protected method is inherited from [[Class: I2CE_PageForm#isSave() | I2CE_PageForm->isSave()]]
 
===setEditing()===
This protected method is inherited from [[Class: I2CE_PageForm#setEditing() | I2CE_PageForm->setEditing()]]
 
===setForm()===
This protected method is inherited from [[Class: I2CE_PageForm#setForm() | I2CE_PageForm->setForm()]]
 
===setObject()===
This protected method is inherited from [[Class: I2CE_PageForm#setObject() | I2CE_PageForm->setObject()]]
 
===validate()===
This protected method is inherited from [[Class: I2CE_PageForm#validate() | I2CE_PageForm->validate()]]
 
===_flattenRequestVars()===
This public method is inherited from [[Class: I2CE_Page#_flattenRequestVars() | I2CE_Page->_flattenRequestVars()]]
 
===display()===
This public method is inherited from [[Class: I2CE_Page#display() | I2CE_Page->display()]]
 
===fixupRequestVariables()===
This public method is inherited from [[Class: I2CE_Page#fixupRequestVariables() | I2CE_Page->fixupRequestVariables()]]
 
===flattenRequestVars()===
This public method is inherited from [[Class: I2CE_Page#flattenRequestVars() | I2CE_Page->flattenRequestVars()]]
 
===get()===
This public method is inherited from [[Class: I2CE_Page#get() | I2CE_Page->get()]]
 
===getAccessedBaseURL()===
This public method is inherited from [[Class: I2CE_Page#getAccessedBaseURL() | I2CE_Page->getAccessedBaseURL()]]
 
===getTemplate()===
This public method is inherited from [[Class: I2CE_Page#getTemplate() | I2CE_Page->getTemplate()]]
 
===getUser()===
This public method is inherited from [[Class: I2CE_Page#getUser() | I2CE_Page->getUser()]]
 
===get_exists()===
This public method is inherited from [[Class: I2CE_Page#get_exists() | I2CE_Page->get_exists()]]
 
===hasPermission()===
This public method is inherited from [[Class: I2CE_Page#hasPermission() | I2CE_Page->hasPermission()]]
 
===isGet()===
This public method is inherited from [[Class: I2CE_Page#isGet() | I2CE_Page->isGet()]]
 
===isPost()===
This public method is inherited from [[Class: I2CE_Page#isPost() | I2CE_Page->isPost()]]
 
===module()===
This public method is inherited from [[Class: I2CE_Page#module() | I2CE_Page->module()]]
 
===page()===
This public method is inherited from [[Class: I2CE_Page#page() | I2CE_Page->page()]]
 
===pageRemainder()===
This public method is inherited from [[Class: I2CE_Page#pageRemainder() | I2CE_Page->pageRemainder()]]
 
===pageRoot()===
This public method is inherited from [[Class: I2CE_Page#pageRoot() | I2CE_Page->pageRoot()]]
 
===post()===
This public method is inherited from [[Class: I2CE_Page#post() | I2CE_Page->post()]]
 
===post_exists()===
This public method is inherited from [[Class: I2CE_Page#post_exists() | I2CE_Page->post_exists()]]
 
===redirect()===
This public method is inherited from [[Class: I2CE_Page#redirect() | I2CE_Page->redirect()]]
 
===request()===
This public method is inherited from [[Class: I2CE_Page#request() | I2CE_Page->request()]]
 
===request_exists()===
This public method is inherited from [[Class: I2CE_Page#request_exists() | I2CE_Page->request_exists()]]
 
===rewrittenURLs()===
This public method is inherited from [[Class: I2CE_Page#rewrittenURLs() | I2CE_Page->rewrittenURLs()]]
 
===session_req()===
This public method is inherited from [[Class: I2CE_Page#session_req() | I2CE_Page->session_req()]]
 
===session_req_exists()===
This public method is inherited from [[Class: I2CE_Page#session_req_exists() | I2CE_Page->session_req_exists()]]
 
===setAccess()===
This public method is inherited from [[Class: I2CE_Page#setAccess() | I2CE_Page->setAccess()]]
 
===setIsPost()===
This public method is inherited from [[Class: I2CE_Page#setIsPost() | I2CE_Page->setIsPost()]]
 
===setRedirect()===
This public method is inherited from [[Class: I2CE_Page#setRedirect() | I2CE_Page->setRedirect()]]
 
===_display()===
This protected method is inherited from [[Class: I2CE_Page#_display() | I2CE_Page->_display()]]
 
===actionCommandLine()===
This protected method is inherited from [[Class: I2CE_Page#actionCommandLine() | I2CE_Page->actionCommandLine()]]
 
===getAccess()===
This protected method is inherited from [[Class: I2CE_Page#getAccess() | I2CE_Page->getAccess()]]
 
===getTitle()===
This protected method is inherited from [[Class: I2CE_Page#getTitle() | I2CE_Page->getTitle()]]
 
===initializeTemplate()===
This protected method is inherited from [[Class: I2CE_Page#initializeTemplate() | I2CE_Page->initializeTemplate()]]
 
===setupGetPost()===
This protected method is inherited from [[Class: I2CE_Page#setupGetPost() | I2CE_Page->setupGetPost()]]
 
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==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]]
 
===$template===
Theis protected variable is inherited from [[Class: I2CE_Page#$template | I2CE_Page->$template]]
 
===$defaultHTMLFile===
Theis protected variable is inherited from [[Class: I2CE_Page#$defaultHTMLFile | I2CE_Page->$defaultHTMLFile]]
 
===$role===
Theis protected variable is inherited from [[Class: I2CE_Page#$role | I2CE_Page->$role]]
 
===$user===
Theis protected variable is inherited from [[Class: I2CE_Page#$user | I2CE_Page->$user]]
 
===$post===
Theis protected variable is inherited from [[Class: I2CE_Page#$post | I2CE_Page->$post]]
 
===$get===
Theis protected variable is inherited from [[Class: I2CE_Page#$get | I2CE_Page->$get]]
 
===$page_root===
Theis protected variable is inherited from [[Class: I2CE_Page#$page_root | I2CE_Page->$page_root]]
 
===$page_remainder===
Theis protected variable is inherited from [[Class: I2CE_Page#$page_remainder | I2CE_Page->$page_remainder]]
 
===$args===
Theis protected variable is inherited from [[Class: I2CE_Page#$args | I2CE_Page->$args]]
 
===$request_remainder===
Theis protected variable is inherited from [[Class: I2CE_Page#$request_remainder | I2CE_Page->$request_remainder]]
 
===$permissionParser===
Theis protected variable is inherited from [[Class: I2CE_Page#$permissionParser | I2CE_Page->$permissionParser]]
 
===$page===
Theis protected variable is inherited from [[Class: I2CE_Page#$page | I2CE_Page->$page]]
 
===$module===
Theis protected variable is inherited from [[Class: I2CE_Page#$module | I2CE_Page->$module]]
 
===$is_post===
Theis protected variable is inherited from [[Class: I2CE_Page#$is_post | I2CE_Page->$is_post]]
 
===$session_req===
Theis protected variable is inherited from [[Class: I2CE_Page#$session_req | I2CE_Page->$session_req]]
==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()]]
 
===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()]]
 
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
 
 
[[Category:Class Documentation]]

Latest revision as of 09:05, 23 August 2013