Class: I2CE PageFormLists (Development): Difference between revisions

Latest revision as of 08:17, 6 May 2015

For other versions, see Class: I2CE_PageFormLists (versions) .

This article describes the class I2CE_PageFormLists .

Extends the class: I2CE_PageForm.
Child Classes:
- I2CE_Page_CustomReport_ArchiveMenu
Location: Part of the module Lists in the package I2CE 4.1-dev
Source: Defined in the file modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 46
Author: Luke Duncan <lduncan@intrahealth.org> / Carl leitner <litlfred@ibiblio.org>
Since: v2.0.0

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

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 51
Type: protected string $type

$select_field

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

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 55
Type: protected string $select_field

$id

The record id number of the object being edited.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 59
Type: protected integer $id

Methods

__call()

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 443
Signature: public function __call($func,$args)
Parameters:
- $func
- $args

__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.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 72
Signature: public function __construct($args,$request_remainder,$get,$post)
Parameters:
- $args
- $request_remainder
- $get
  - Default Value: null
- $post
  - Default Value: null

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.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 615
Signature: protected function action()

actionAllLists()

Perform the action of the page to show all lists.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 385
Signature: protected function actionAllLists()

actionDisplayList_row()

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 576
Signature: protected function actionDisplayList_row($list)
Parameters:
- $list

actionExtra()

Perform the action of the page with a select object

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 378
Signature: protected function actionExtra($select_obj)
Parameters:
- $select_obj

actionSelectList()

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 425
Signature: protected function actionSelectList()

actionSelectMapped()

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 493
Signature: protected function actionSelectMapped()

addAlphabet()

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 391
Signature: protected function addAlphabet()

getChildHTMLTemplate()

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

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 112
Signature: protected function getChildHTMLTemplate($child_form)
Parameters:
- $child_form
Returns: string

getPrimaryHTMLTemplate()

Get the HTML template for the primary form

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 94
Signature: protected function getPrimaryHTMLTemplate()
Returns: string

getRowBaseLink()

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 555
Signature: protected function getRowBaseLink()

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.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 547
Signature: protected function getViewPage($type)
Parameters:
- $type
Returns: string

initPage()

Initializes any data for the page

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 204
Signature: protected function initPage()
Returns: boolean.
True on sucess. False on failture

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

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 326
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 $type member variable.

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 234
Signature: protected function loadObjects()

paginateList()

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 458
Signature: protected function paginateList($list)
Parameters:
- $list

save()

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

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 359
Signature: protected function save()

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. *

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 138
Signature: protected function setDisplayData()

showHidden()

Wether or not we show a hidden list member

Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 121
Signature: protected function showHidden()
Returns: boolean

Inherited Methods

getChildObjects()

This public method is inherited from I2CE_PageForm->getChildObjects()

getSecondaryObjects()

This public method is inherited from I2CE_PageForm->getSecondaryObjects()

hasInvalid()

This public method is inherited from I2CE_PageForm->hasInvalid()

invalidMessage()

This public method is inherited from I2CE_PageForm->invalidMessage()

setObject()

This public method is inherited from I2CE_PageForm->setObject()

getParent()

This protected method is inherited from I2CE_PageForm->getParent()

getPrimary()

This protected method is inherited from I2CE_PageForm->getPrimary()

setForm()

This protected method is inherited from I2CE_PageForm->setForm()

validate()

This protected method is inherited from I2CE_PageForm->validate()

usesConfirmPage()

This public method is inherited from I2CE_PageFormBase->usesConfirmPage()

action_display()

This protected method is inherited from I2CE_PageFormBase->action_display()

action_save()

This protected method is inherited from I2CE_PageFormBase->action_save()

canSave()

This protected method is inherited from I2CE_PageFormBase->canSave()

checkActionPermission()

This protected method is inherited from I2CE_PageFormBase->checkActionPermission()

displayControls()

This protected method is inherited from I2CE_PageFormBase->displayControls()

isConfirm()

This protected method is inherited from I2CE_PageFormBase->isConfirm()

isEdit()

This protected method is inherited from I2CE_PageFormBase->isEdit()

isEditing()

This protected method is inherited from I2CE_PageFormBase->isEditing()

isSave()

This protected method is inherited from I2CE_PageFormBase->isSave()

setEditing()

This protected method is inherited from I2CE_PageFormBase->setEditing()

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

getTitle()

This public method is inherited from I2CE_Page->getTitle()

getURLRoot()

This public method is inherited from I2CE_Page->getURLRoot()

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

displayCommandLine()

This protected method is inherited from I2CE_Page->displayCommandLine()

displayWeb()

This protected method is inherited from I2CE_Page->displayWeb()

getAccess()

This protected method is inherited from I2CE_Page->getAccess()

initializeTemplate()

This protected method is inherited from I2CE_Page->initializeTemplate()

setActiveMenu()

This protected method is inherited from I2CE_Page->setActiveMenu()

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

$editing

Theis protected variable is inherited from I2CE_PageFormBase->$editing

$factory

Theis protected variable is inherited from I2CE_PageFormBase->$factory

$button_templates

Theis protected variable is inherited from I2CE_PageFormBase->$button_templates

$checked_validation

Theis protected variable is inherited from I2CE_PageFormBase->$checked_validation

$usesConfimPage

Theis protected variable is inherited from I2CE_PageFormBase->$usesConfimPage

$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

$redirect

Theis protected variable is inherited from I2CE_Page->$redirect

$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

$root_url

Theis protected variable is inherited from I2CE_Page->$root_url

$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

addDatePicker()

This method is inherited from I2CE_Page->addDatePicker()

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

useDropDown()

This method is inherited from I2CE_Page->useDropDown()

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

getForm()

This method is inherited from I2CE_Page->getForm()

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

makeJumper()

This method is inherited from I2CE_Page->makeJumper()

makeScalingJumper()

This method is inherited from I2CE_Page->makeScalingJumper()

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

addAjaxLoad()

This method is inherited from I2CE_Page->addAjaxLoad()

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

@@ Line 3: / Line 3: @@
 *Extends the class: [[Class: I2CE_PageForm (Development) | I2CE_PageForm]].
 *Child Classes:
-** [[Class: iHRIS_PageFormLists (Development) | iHRIS_PageFormLists]]
+** [[Class: I2CE_Page_CustomReport_ArchiveMenu (Development) | I2CE_Page_CustomReport_ArchiveMenu]]
-*Location: Part of the module [[I2CE Module List (Development)#Lists|Lists]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev
+*Location: Part of the module [[I2CE Module List (Development)#Lists|Lists]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev
-*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L46 modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 46
+*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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>
 *Since: v2.0.0
@@ Line 12: / Line 12: @@
 ===$type===
 The type of list object being edited. e.g. the form name
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L51 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 51
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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
 ===$select_field===
 The field, if any, for which we wish to select the list for.
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L55 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 55
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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
 ===$id===
 The record id number of the object being edited.
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L59 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 59
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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
-===$show_hidden===
-.  Whether or not to show hidden elements
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L110 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 110
-*Type: protected booelan $show_hidden
 ==Methods==
+===__call()===
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L443 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 443
+*Signature: public function __call($func,$args)
+*Parameters:
+**$func
+**$args
 ===__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 (Development) | 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-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L72 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 72
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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)
 *Parameters:
@@ Line 44: / Line 45: @@
 ===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.
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L488 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 488
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L615 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 615
 *Signature: protected function action()
 ===actionAllLists()===
 Perform the action of the page to show all lists.
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L318 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 318
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L385 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 385
 *Signature: protected function actionAllLists()
 ===actionDisplayList_row()===
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L435 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 435
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L576 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 576
 *Signature: protected function actionDisplayList_row($list)
 *Parameters:
@@ Line 57: / Line 58: @@
 ===actionExtra()===
 Perform the action of the page with a select object
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L311 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 311
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L378 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 378
 *Signature: protected function actionExtra($select_obj)
 *Parameters:
 **$select_obj
 ===actionSelectList()===
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L327 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 327
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L425 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 425
 *Signature: protected function actionSelectList()
 ===actionSelectMapped()===
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L374 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 374
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L493 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 493
 *Signature: protected function actionSelectMapped()
-===displayControls()===
+===addAlphabet()===
-Display the save or confirm button templates as needed.
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L391 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 391
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L279 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 279
+*Signature: protected function addAlphabet()
-*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
 ===getChildHTMLTemplate()===
 Get the HTML templat for any child forms @var string $child_form
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L103 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 103
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L112 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 112
 *Signature: protected function getChildHTMLTemplate($child_form)
 *Parameters:
@@ Line 85: / Line 80: @@
 ===getPrimaryHTMLTemplate()===
 Get the HTML template for the primary form
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L94 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 94
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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()
 *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
+===getRowBaseLink()===
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L555 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 555
+*Signature: protected function getRowBaseLink()
 ===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.
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L426 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 426
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L547 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 547
 *Signature: protected function getViewPage($type)
 *Parameters:
 **$type
 *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
+===initPage()===
+Initializes any data for the page
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L204 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 204
+*Signature: protected function initPage()
+*Returns: boolean.<br/>True on sucess. False on failture
 ===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
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L254 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 254
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L326 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 326
 *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 [[#$type | $type]] member variable.
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L185 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 185
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L234 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 234
 *Signature: protected function loadObjects()
 ===paginateList()===
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L339 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 339
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L458 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 458
 *Signature: protected function paginateList($list)
 *Parameters:
@@ Line 110: / Line 113: @@
 ===save()===
 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-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L292 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 292
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L359 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 359
 *Signature: protected function save()
 ===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. *
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L132 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 132
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L138 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 138
 *Signature: protected function setDisplayData()
-===setMenus()===
-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-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L534 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 534
-*Signature: protected function setMenus()
 ===showHidden()===
 Wether or not we show a hidden list member
-*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L116 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 116
+*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php#L121 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php] on line 121
 *Signature: protected function showHidden()
 *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
 ==Inherited Methods==
+===getChildObjects()===
+This public method is inherited from [[Class: I2CE_PageForm (Development)#getChildObjects() | I2CE_PageForm->getChildObjects()]]
+===getSecondaryObjects()===
+This public method is inherited from [[Class: I2CE_PageForm (Development)#getSecondaryObjects() | I2CE_PageForm->getSecondaryObjects()]]
 ===hasInvalid()===
 This public method is inherited from [[Class: I2CE_PageForm (Development)#hasInvalid() | I2CE_PageForm->hasInvalid()]]
@@ Line 132: / Line 137: @@
 This public method is inherited from [[Class: I2CE_PageForm (Development)#invalidMessage() | I2CE_PageForm->invalidMessage()]]
-===setFormAttributes()===
+===setObject()===
-This public method is inherited from [[Class: I2CE_PageForm (Development)#setFormAttributes() | I2CE_PageForm->setFormAttributes()]]
+This public method is inherited from [[Class: I2CE_PageForm (Development)#setObject() | I2CE_PageForm->setObject()]]
-===usesConfirmPage()===
-This public method is inherited from [[Class: I2CE_PageForm (Development)#usesConfirmPage() | I2CE_PageForm->usesConfirmPage()]]
 ===getParent()===
@@ Line 143: / Line 145: @@
 ===getPrimary()===
 This protected method is inherited from [[Class: I2CE_PageForm (Development)#getPrimary() | I2CE_PageForm->getPrimary()]]
+===setForm()===
+This protected method is inherited from [[Class: I2CE_PageForm (Development)#setForm() | I2CE_PageForm->setForm()]]
+===validate()===
+This protected method is inherited from [[Class: I2CE_PageForm (Development)#validate() | I2CE_PageForm->validate()]]
+===usesConfirmPage()===
+This public method is inherited from [[Class: I2CE_PageFormBase (Development)#usesConfirmPage() | I2CE_PageFormBase->usesConfirmPage()]]
+===action_display()===
+This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#action_display() | I2CE_PageFormBase->action_display()]]
+===action_save()===
+This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#action_save() | I2CE_PageFormBase->action_save()]]
+===canSave()===
+This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#canSave() | I2CE_PageFormBase->canSave()]]
+===checkActionPermission()===
+This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#checkActionPermission() | I2CE_PageFormBase->checkActionPermission()]]
+===displayControls()===
+This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#displayControls() | I2CE_PageFormBase->displayControls()]]
 ===isConfirm()===
-This protected method is inherited from [[Class: I2CE_PageForm (Development)#isConfirm() | I2CE_PageForm->isConfirm()]]
+This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#isConfirm() | I2CE_PageFormBase->isConfirm()]]
 ===isEdit()===
-This protected method is inherited from [[Class: I2CE_PageForm (Development)#isEdit() | I2CE_PageForm->isEdit()]]
+This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#isEdit() | I2CE_PageFormBase->isEdit()]]
 ===isEditing()===
-This protected method is inherited from [[Class: I2CE_PageForm (Development)#isEditing() | I2CE_PageForm->isEditing()]]
+This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#isEditing() | I2CE_PageFormBase->isEditing()]]
 ===isSave()===
-This protected method is inherited from [[Class: I2CE_PageForm (Development)#isSave() | I2CE_PageForm->isSave()]]
+This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#isSave() | I2CE_PageFormBase->isSave()]]
 ===setEditing()===
-This protected method is inherited from [[Class: I2CE_PageForm (Development)#setEditing() | I2CE_PageForm->setEditing()]]
+This protected method is inherited from [[Class: I2CE_PageFormBase (Development)#setEditing() | I2CE_PageFormBase->setEditing()]]
-===setForm()===
-This protected method is inherited from [[Class: I2CE_PageForm (Development)#setForm() | I2CE_PageForm->setForm()]]
-===setObject()===
-This protected method is inherited from [[Class: I2CE_PageForm (Development)#setObject() | I2CE_PageForm->setObject()]]
-===validate()===
-This protected method is inherited from [[Class: I2CE_PageForm (Development)#validate() | I2CE_PageForm->validate()]]
 ===_flattenRequestVars()===
@@ Line 188: / Line 205: @@
 ===getTemplate()===
 This public method is inherited from [[Class: I2CE_Page (Development)#getTemplate() | I2CE_Page->getTemplate()]]
+===getTitle()===
+This public method is inherited from [[Class: I2CE_Page (Development)#getTitle() | I2CE_Page->getTitle()]]
+===getURLRoot()===
+This public method is inherited from [[Class: I2CE_Page (Development)#getURLRoot() | I2CE_Page->getURLRoot()]]
 ===getUser()===
@@ Line 254: / Line 277: @@
 ===actionCommandLine()===
 This protected method is inherited from [[Class: I2CE_Page (Development)#actionCommandLine() | I2CE_Page->actionCommandLine()]]
+===displayCommandLine()===
+This protected method is inherited from [[Class: I2CE_Page (Development)#displayCommandLine() | I2CE_Page->displayCommandLine()]]
+===displayWeb()===
+This protected method is inherited from [[Class: I2CE_Page (Development)#displayWeb() | I2CE_Page->displayWeb()]]
 ===getAccess()===
 This protected method is inherited from [[Class: I2CE_Page (Development)#getAccess() | I2CE_Page->getAccess()]]
-===getTitle()===
-This protected method is inherited from [[Class: I2CE_Page (Development)#getTitle() | I2CE_Page->getTitle()]]
 ===initializeTemplate()===
 This protected method is inherited from [[Class: I2CE_Page (Development)#initializeTemplate() | I2CE_Page->initializeTemplate()]]
+===setActiveMenu()===
+This protected method is inherited from [[Class: I2CE_Page (Development)#setActiveMenu() | I2CE_Page->setActiveMenu()]]
 ===setupGetPost()===
@@ Line 275: / Line 304: @@
 ===$node_ids===
 Theis protected variable is inherited from [[Class: I2CE_PageForm (Development)#$node_ids | I2CE_PageForm->$node_ids]]
+===$editing===
+Theis protected variable is inherited from [[Class: I2CE_PageFormBase (Development)#$editing | I2CE_PageFormBase->$editing]]
 ===$factory===
-Theis protected variable is inherited from [[Class: I2CE_PageForm (Development)#$factory | I2CE_PageForm->$factory]]
+Theis protected variable is inherited from [[Class: I2CE_PageFormBase (Development)#$factory | I2CE_PageFormBase->$factory]]
+===$button_templates===
+Theis protected variable is inherited from [[Class: I2CE_PageFormBase (Development)#$button_templates | I2CE_PageFormBase->$button_templates]]
+===$checked_validation===
+Theis protected variable is inherited from [[Class: I2CE_PageFormBase (Development)#$checked_validation | I2CE_PageFormBase->$checked_validation]]
 ===$usesConfimPage===
-Theis protected variable is inherited from [[Class: I2CE_PageForm (Development)#$usesConfimPage | I2CE_PageForm->$usesConfimPage]]
+Theis protected variable is inherited from [[Class: I2CE_PageFormBase (Development)#$usesConfimPage | I2CE_PageFormBase->$usesConfimPage]]
-===$formAttributes===
-Theis protected variable is inherited from [[Class: I2CE_PageForm (Development)#$formAttributes | I2CE_PageForm->$formAttributes]]
 ===$template===
@@ Line 296: / Line 331: @@
 ===$user===
 Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$user | I2CE_Page->$user]]
+===$redirect===
+Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$redirect | I2CE_Page->$redirect]]
 ===$post===
@@ Line 317: / Line 355: @@
 ===$permissionParser===
 Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$permissionParser | I2CE_Page->$permissionParser]]
+===$root_url===
+Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$root_url | I2CE_Page->$root_url]]
 ===$page===
@@ Line 341: / Line 382: @@
 ===addColorPickerTriple()===
 This method is inherited from [[Class: I2CE_Page (Development)#addColorPickerTriple() | I2CE_Page->addColorPickerTriple()]]
+===addReportSelector()===
+This method is inherited from [[Class: I2CE_Page (Development)#addReportSelector() | I2CE_Page->addReportSelector()]]
 ===addDatePicker()===
@@ Line 365: / Line 409: @@
 ===setClassValues()===
 This method is inherited from [[Class: I2CE_Page (Development)#setClassValues() | I2CE_Page->setClassValues()]]
+===useDropDown()===
+This method is inherited from [[Class: I2CE_Page (Development)#useDropDown() | I2CE_Page->useDropDown()]]
 ===addOption()===
@@ Line 380: / Line 427: @@
 ===setForm()===
 This method is inherited from [[Class: I2CE_Page (Development)#setForm() | I2CE_Page->setForm()]]
+===getForm()===
+This method is inherited from [[Class: I2CE_Page (Development)#getForm() | I2CE_Page->getForm()]]
 ===getField()===
@@ Line 389: / Line 439: @@
 ===isReview()===
 This method is inherited from [[Class: I2CE_Page (Development)#isReview() | I2CE_Page->isReview()]]
-===setShowForm()===
-This method is inherited from [[Class: I2CE_Page (Development)#setShowForm() | I2CE_Page->setShowForm()]]
-===showForm()===
-This method is inherited from [[Class: I2CE_Page (Development)#showForm() | I2CE_Page->showForm()]]
 ===makeJumper()===
 This method is inherited from [[Class: I2CE_Page (Development)#makeJumper() | I2CE_Page->makeJumper()]]
+===makeScalingJumper()===
+This method is inherited from [[Class: I2CE_Page (Development)#makeScalingJumper() | I2CE_Page->makeScalingJumper()]]
 ===menuSelect()===
@@ Line 407: / Line 454: @@
 ===addAjaxUpdate()===
 This method is inherited from [[Class: I2CE_Page (Development)#addAjaxUpdate() | I2CE_Page->addAjaxUpdate()]]
+===addAjaxLoad()===
+This method is inherited from [[Class: I2CE_Page (Development)#addAjaxLoad() | I2CE_Page->addAjaxLoad()]]
 ===addAjaxToggle()===

Anonymous

Search

Class: I2CE PageFormLists (Development): Difference between revisions

Latest revision as of 08:17, 6 May 2015

Variables

$type

$select_field

$id

Methods

__call()

__construct()

action()

actionAllLists()

actionDisplayList_row()

actionExtra()

actionSelectList()

actionSelectMapped()

addAlphabet()

getChildHTMLTemplate()

getPrimaryHTMLTemplate()

getRowBaseLink()

getViewPage()

initPage()

loadHTMLTemplates()

loadObjects()

paginateList()

save()

setDisplayData()

showHidden()

Inherited Methods

getChildObjects()

getSecondaryObjects()

hasInvalid()

invalidMessage()

setObject()

getParent()

getPrimary()

setForm()

validate()

usesConfirmPage()

action_display()

action_save()

canSave()

checkActionPermission()

displayControls()

isConfirm()

isEdit()

isEditing()

isSave()

setEditing()

_flattenRequestVars()

display()

fixupRequestVariables()

flattenRequestVars()

get()

getAccessedBaseURL()

getTemplate()

getTitle()

getURLRoot()

getUser()

get_exists()

hasPermission()

isGet()

isPost()

module()

page()

pageRemainder()

pageRoot()

post()

post_exists()

redirect()

request()

request_exists()

rewrittenURLs()

session_req()

session_req_exists()

setAccess()

setIsPost()

setRedirect()

_display()