Class: I2CE PageViewList: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 5: Line 5:
*** [[Class: iHRIS_PageViewListQualify | iHRIS_PageViewListQualify]]
*** [[Class: iHRIS_PageViewListQualify | iHRIS_PageViewListQualify]]
*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_PageViewList.php modules/Forms/modules/Lists/lib/I2CE_PageViewList.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_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 12: Line 12:
===$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.2-release/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.2-release/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.2-release/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 | I2CE_List]] $list
*Type: protected [[Class: I2CE_List | I2CE_List]] $list


Line 25: Line 28:
===__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.2-release/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)
*Parameters:
*Parameters:
Line 31: Line 35:
===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.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L85 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 85
*Signature: protected function action()
*Signature: protected function action()
===getChildHTMLTemplate()===
===getChildHTMLTemplate()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/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  
===showChildren()===
===showChildren()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L161 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 161
*Signature: protected function showChildren()
*Signature: protected function showChildren()
===showMapped()===
===showMapped()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php#L113 i2ce/modules/Forms/modules/Lists/lib/I2CE_PageViewList.php] on line 113
*Signature: protected function showMapped()
*Signature: protected function showMapped()
==Inherited Methods==
==Inherited Methods==

Revision as of 09:52, 10 November 2009

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

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

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

loadHTMLTemplates()

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

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

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

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

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