Class: I2CE PageFormLists (4.1.6)
This article describes the class I2CE_PageFormLists .
- Extends the class: I2CE_PageForm.
- Child Classes:
- Location: Part of the module Lists in the package I2CE 4.1.6-release
- 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
. Whether or not to show hidden elements
- Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 114
- Type: protected booelan $show_hidden
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.
- 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 551
- 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 377
- Signature: protected function actionAllLists()
actionDisplayList_row()
- Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 512
- 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 370
- Signature: protected function actionExtra($select_obj)
- Parameters:
- $select_obj
actionSelectList()
- Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 386
- Signature: protected function actionSelectList()
actionSelectMapped()
- Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 433
- Signature: protected function actionSelectMapped()
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 107
- 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 491
- 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 483
- 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 196
- 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 318
- 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 226
- Signature: protected function loadObjects()
paginateList()
- Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 398
- 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 351
- 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 136
- Signature: protected function setDisplayData()
setMenus()
Set the attributes for the left hand navigation menu to highlight the proper location.
- Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 576
- Signature: protected function setMenus()
showHidden()
Wether or not we show a hidden list member
- Defined in i2ce/modules/Forms/modules/Lists/lib/I2CE_PageFormLists.php on line 120
- Signature: protected function showHidden()
- Returns: boolean
Inherited Methods
hasInvalid()
This public method is inherited from I2CE_PageForm->hasInvalid()
invalidMessage()
This public method is inherited from I2CE_PageForm->invalidMessage()
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()
setObject()
This protected method is inherited from I2CE_PageForm->setObject()
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()
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()
getTitle()
This protected method is inherited from I2CE_Page->getTitle()
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
$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()
addReportSelector()
This method is inherited from I2CE_Page->addReportSelector()
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()
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()
