Class: I2CE PageFormLists: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 4: Line 4:
** [[Class: iHRIS_PageFormLists | iHRIS_PageFormLists]]
** [[Class: iHRIS_PageFormLists | iHRIS_PageFormLists]]
*Location: Part of the module [[I2CE Module List#Lists|Lists]] in the package [https://launchpad.net/i2ce I2CE]
*Location: Part of the module [[I2CE Module List#Lists|Lists]] in the package [https://launchpad.net/i2ce I2CE]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.1-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L46 modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 46
*Author: Luke Duncan <lduncan@intrahealth.org> / Carl leitner <litlfred@ibiblio.org>
*Author: Luke Duncan <lduncan@intrahealth.org> / Carl leitner <litlfred@ibiblio.org>
*Since: v2.0.0
*Since: v2.0.0
Line 11: Line 11:
===$type===
===$type===
The type of list object being edited. e.g. the form name
The type of list object being edited. e.g. the form name
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L51 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 51
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $type
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $type


===$select_field===
===$select_field===
The field, if any, for which we wish to select the list for.
The field, if any, for which we wish to select the list for.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L55 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 55
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $select_field
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $select_field


===$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/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L59 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 59
*Type: protected integer $id
*Type: protected integer $id


Line 24: Line 27:
===__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 $defaultHTMLFile The default HTML file for this page. @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 $defaultHTMLFile The default HTML file for this page. @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/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L72 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 72
*Signature: public function __construct($args,$request_remainder,$get,$post)
*Signature: public function __construct($args,$request_remainder,$get,$post)
*Parameters:
*Parameters:
Line 34: Line 38:
===action()===
===action()===
Perform the actions of the page. This handles some special actions because there are three versions of this page: - The list page of all objects that can be edited. - The add/update page for each list object. - The edit form for each list object. Only in the third case is the parent object action method called since that is the default setup for editing objects used in most other PageForm  objects.
Perform the actions of the page. This handles some special actions because there are three versions of this page: - The list page of all objects that can be edited. - The add/update page for each list object. - The edit form for each list object. Only in the third case is the parent object action method called since that is the default setup for editing objects used in most other PageForm  objects.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L513 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 513
*Signature: protected function action()
*Signature: protected function action()
===actionAllLists()===
===actionAllLists()===
Perform the action of the page to show all lists.
Perform the action of the page to show all lists.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L302 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 302
*Signature: protected function actionAllLists()
*Signature: protected function actionAllLists()
===actionDisplayList_row()===
===actionDisplayList_row()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L460 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 460
*Signature: protected function actionDisplayList_row($list)
*Signature: protected function actionDisplayList_row($list)
*Parameters:
*Parameters:
Line 44: Line 51:
===actionExtra()===
===actionExtra()===
Perform the action of the page with a select object
Perform the action of the page with a select object
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L295 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 295
*Signature: protected function actionExtra($select_obj)
*Signature: protected function actionExtra($select_obj)
*Parameters:
*Parameters:
**$select_obj  
**$select_obj  
===actionSelectList()===
===actionSelectList()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L311 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 311
*Signature: protected function actionSelectList()
*Signature: protected function actionSelectList()
===actionSelectMapped()===
===actionSelectMapped()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L367 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 367
*Signature: protected function actionSelectMapped()
*Signature: protected function actionSelectMapped()
===displayControls()===
===displayControls()===
Display the save or confirm button templates as needed.
Display the save or confirm button templates as needed.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L248 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 248
*Signature: protected function displayControls($save,$show_edit)
*Signature: protected function displayControls($save,$show_edit)
*Parameters:
*Parameters:
Line 61: Line 72:
===getChildHTMLTemplate()===
===getChildHTMLTemplate()===
Get the HTML templat for any child forms @var string $child_form
Get the HTML templat for any child forms @var string $child_form
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L103 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 103
*Signature: protected function getChildHTMLTemplate($child_form)
*Signature: protected function getChildHTMLTemplate($child_form)
*Parameters:
*Parameters:
Line 67: Line 79:
===getPrimaryHTMLTemplate()===
===getPrimaryHTMLTemplate()===
Get the HTML template for the primary form
Get the HTML template for the primary form
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L94 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 94
*Signature: protected function getPrimaryHTMLTemplate()
*Signature: protected function getPrimaryHTMLTemplate()
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
*Returns: [http://www.php.net/manual/en/language.types.string.php string ]
===getViewPage()===
===getViewPage()===
Return the view list page for this type of form. If the page exists for view_$type it returns that, otherwise it uses view_list.
Return the view list page for this type of form. If the page exists for view_$type it returns that, otherwise it uses view_list.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L451 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 451
*Signature: protected function getViewPage($type)
*Signature: protected function getViewPage($type)
*Parameters:
*Parameters:
Line 77: Line 91:
===loadHTMLTemplates()===
===loadHTMLTemplates()===
Load the HTML template files for editing and confirming the list information. Since this page has special versions, this method is only called when a particular list object is being added or edited.  All other pages are loaded within the action  
Load the HTML template files for editing and confirming the list information. Since this page has special versions, this method is only called when a particular list object is being added or edited.  All other pages are loaded within the action  
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L223 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 223
*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 [[#$type | $type]] 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 [[#$type | $type]] member variable.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L154 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 154
*Signature: protected function loadObjects()
*Signature: protected function loadObjects()
===save()===
===save()===
Save the objects to the database. Save the list object being edited and return to the appropriate admin page.
Save the objects to the database. Save the list object being edited and return to the appropriate admin page.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L261 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 261
*Signature: protected function save()
*Signature: protected function save()
===setDisplayData()===
===setDisplayData()===
Set the data to be displayed for the outside of the form field elements. Set up the static data to be displayed in the template.  The default method doesn't do anything, but sub-classes may need to override this method. *
Set the data to be displayed for the outside of the form field elements. Set up the static data to be displayed in the template.  The default method doesn't do anything, but sub-classes may need to override this method. *
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L114 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 114
*Signature: protected function setDisplayData()
*Signature: protected function setDisplayData()
===setMenus()===
===setMenus()===
Set the attributes for the left hand navigation menu to highlight the proper location.
Set the attributes for the left hand navigation menu to highlight the proper location.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L553 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 553
*Signature: protected function setMenus()
*Signature: protected function setMenus()
==Inherited Methods==
==Inherited Methods==

Revision as of 09:51, 10 November 2009

This article describes the class I2CE_PageFormLists.

Manage editing of all the list databases used for drop down menus. This page has the code for the ListsPage object and then it creates an instance of this page object and calls the ListsPage ::display() display method. Page object to handle the management of all the list databases used for drop down menus. This page handles all the editing of the list database tables using the relevant interface objects. The base page lists all the types of data that can be edited. From there you can add a new entry or edit an existing one. This object overrides the default save () and action () methods since there are many database objects to be edited.

Variables

$type

The type of list object being edited. e.g. the form name

$select_field

The field, if any, for which we wish to select the list for.

$id

The record id number of the object being edited.

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 $defaultHTMLFile The default HTML file for this page. @param mixed $access The role required to access this page. @param array $files The list of template files to load for this page.

action()

Perform the actions of the page. This handles some special actions because there are three versions of this page: - The list page of all objects that can be edited. - The add/update page for each list object. - The edit form for each list object. Only in the third case is the parent object action method called since that is the default setup for editing objects used in most other PageForm objects.

actionAllLists()

Perform the action of the page to show all lists.

actionDisplayList_row()

actionExtra()

Perform the action of the page with a select object

actionSelectList()

actionSelectMapped()

displayControls()

Display the save or confirm button templates as needed.

getChildHTMLTemplate()

Get the HTML templat for any child forms @var string $child_form

getPrimaryHTMLTemplate()

Get the HTML template for the primary form

getViewPage()

Return the view list page for this type of form. If the page exists for view_$type it returns that, otherwise it uses view_list.

loadHTMLTemplates()

Load the HTML template files for editing and confirming the list information. Since this page has special versions, this method is only called when a particular list object is being added or edited. All other pages are loaded within the action

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 $type member variable.

save()

Save the objects to the database. Save the list object being edited and return to the appropriate admin page.

setDisplayData()

Set the data to be displayed for the outside of the form field elements. Set up the static data to be displayed in the template. The default method doesn't do anything, but sub-classes may need to override this method. *

setMenus()

Set the attributes for the left hand navigation menu to highlight the proper location.

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()

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()

menuSelect()

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()