Class: I2CE PageViewList (Development): Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
 
Line 5: Line 5:
** [[Class: iHRIS_PageViewList (Development) | iHRIS_PageViewList]]
** [[Class: iHRIS_PageViewList (Development) | iHRIS_PageViewList]]
*** [[Class: iHRIS_PageViewListQualify (Development) | iHRIS_PageViewListQualify]]
*** [[Class: iHRIS_PageViewListQualify (Development) | iHRIS_PageViewListQualify]]
*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_PageViewList.php#L35 modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 35
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L35 modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 35
*Author: Luke Duncan <lduncan@intrahealth.org>
*Author: Luke Duncan <lduncan@intrahealth.org>
*Since: v2.0.0
*Since: v2.0.0
Line 13: Line 13:
===$type===
===$type===
The type of list object being edited.
The type of list object being edited.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L40 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 40
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L40 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 40
*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


===$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-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L44 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 44
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L44 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 44
*Type: protected integer $id
*Type: protected integer $id


===$list===
===$list===
The list object being viewed.
The list object being viewed.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L48 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 48
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L48 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 48
*Type: protected [[Class: I2CE_List (Development) | I2CE_List]] $list
*Type: protected [[Class: I2CE_List (Development) | I2CE_List]] $list


Line 29: Line 29:
===__construct()===
===__construct()===
Create a new instance of this page. This will call the parent constructor and then setup the base template pages for the 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 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-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L61 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 61
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L61 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 61
*Signature: public function __construct($args,$request_remainder)
*Signature: public function __construct($args,$request_remainder,$get,$post)
*Parameters:
*Parameters:
**$args  
**$args  
**$request_remainder  
**$request_remainder  
**$get
***Default Value: null
**$post
***Default Value: null
===action()===
===action()===
Perform the main actions of the page.
Perform the main actions of the page.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L85 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 85
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L125 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 125
*Signature: protected function action()
*Signature: protected function action()
===getChildHTMLTemplate()===
===getChildHTMLTemplate()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L78 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 78
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L78 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 78
*Signature: protected function getChildHTMLTemplate($child_form)
*Signature: protected function getChildHTMLTemplate($child_form)
*Parameters:
*Parameters:
**$child_form  
**$child_form  
===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_PageViewList.php#L87 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 87
*Signature: protected function initPage()
*Returns: boolean.<br/>True on sucess. False on failture
===loadHTMLTemplates()===
Load the  template (HTML or XML) files to the template object.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L117 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 117
*Signature: protected function loadHTMLTemplates()
===showChildren()===
===showChildren()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L173 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 173
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L213 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 213
*Signature: protected function showChildren()
*Signature: protected function showChildren()
===showMapped()===
===showMapped()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L125 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 125
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L165 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 165
*Signature: protected function showMapped()
*Signature: protected function showMapped()
==Inherited Methods==
==Inherited Methods==
Line 70: Line 83:
===getTemplate()===
===getTemplate()===
This public method is inherited from [[Class: I2CE_Page (Development)#getTemplate() | I2CE_Page->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()===
===getUser()===
Line 136: Line 155:
===actionCommandLine()===
===actionCommandLine()===
This protected method is inherited from [[Class: I2CE_Page (Development)#actionCommandLine() | I2CE_Page->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()===
===getAccess()===
This protected method is inherited from [[Class: I2CE_Page (Development)#getAccess() | I2CE_Page->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()===
===initializeTemplate()===
This protected method is inherited from [[Class: I2CE_Page (Development)#initializeTemplate() | I2CE_Page->initializeTemplate()]]
This protected method is inherited from [[Class: I2CE_Page (Development)#initializeTemplate() | I2CE_Page->initializeTemplate()]]


===loadHTMLTemplates()===
===setActiveMenu()===
This protected method is inherited from [[Class: I2CE_Page (Development)#loadHTMLTemplates() | I2CE_Page->loadHTMLTemplates()]]
This protected method is inherited from [[Class: I2CE_Page (Development)#setActiveMenu() | I2CE_Page->setActiveMenu()]]


===setupGetPost()===
===setupGetPost()===
Line 166: Line 188:
===$user===
===$user===
Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$user | I2CE_Page->$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===
===$post===
Line 187: Line 212:
===$permissionParser===
===$permissionParser===
Theis protected variable is inherited from [[Class: I2CE_Page (Development)#$permissionParser | I2CE_Page->$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===
===$page===
Line 211: Line 239:
===addColorPickerTriple()===
===addColorPickerTriple()===
This method is inherited from [[Class: I2CE_Page (Development)#addColorPickerTriple() | I2CE_Page->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()===
===addDatePicker()===
Line 238: Line 269:
===setClassValues()===
===setClassValues()===
This method is inherited from [[Class: I2CE_Page (Development)#setClassValues() | I2CE_Page->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()===
===addOption()===
Line 253: Line 287:
===setForm()===
===setForm()===
This method is inherited from [[Class: I2CE_Page (Development)#setForm() | I2CE_Page->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()===
===getField()===
Line 262: Line 299:
===isReview()===
===isReview()===
This method is inherited from [[Class: I2CE_Page (Development)#isReview() | I2CE_Page->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()===
===makeJumper()===
This method is inherited from [[Class: I2CE_Page (Development)#makeJumper() | I2CE_Page->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()===
===menuSelect()===
Line 280: Line 314:
===addAjaxUpdate()===
===addAjaxUpdate()===
This method is inherited from [[Class: I2CE_Page (Development)#addAjaxUpdate() | I2CE_Page->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()===
===addAjaxToggle()===

Latest revision as of 09:17, 6 May 2015

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


This article describes the class I2CE_PageViewList .

View the details for then given record that is an instance of a I2CE_List. The page class for displaying a I2CE_List record.

Variables

$type

The type of list object being edited.

$id

The record id number of the object being edited.

$list

The list object being viewed.

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 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 main actions of the page.

getChildHTMLTemplate()

initPage()

Initializes any data for the page.

loadHTMLTemplates()

Load the template (HTML or XML) files to the template object.

showChildren()

showMapped()

Inherited Methods

_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

$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

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

setDisplayData()

This method is inherited from I2CE_Page->setDisplayData()

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

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_PageViewList_(Development)&oldid=53932"