Class: I2CE PageViewList: Difference between revisions

From IHRIS Wiki
No edit summary
(Redirected page to Class: I2CE PageViewList (4.1.7))
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article describes the class ''I2CE_PageViewList''.
#REDIRECT [[Class: I2CE_PageViewList (4.1.7)]]
*Extends the class: [[Class: I2CE_Page | I2CE_Page]].
*Child Classes:
** [[Class: iHRIS_PageViewList | iHRIS_PageViewList]]
*** [[Class: iHRIS_PageViewListQualify | iHRIS_PageViewListQualify]]
*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.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>
*Since: v2.0.0
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.
*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
 
===$id===
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
 
===$list===
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
 
==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.
*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)
*Parameters:
**$args
**$request_remainder
===action()===
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()
===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)
*Parameters:
**$child_form
===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()
===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()
==Inherited Methods==
===_flattenRequestVars()===
This public method is inherited from [[Class: I2CE_Page#_flattenRequestVars() | I2CE_Page->_flattenRequestVars()]]
 
===display()===
This public method is inherited from [[Class: I2CE_Page#display() | I2CE_Page->display()]]
 
===fixupRequestVariables()===
This public method is inherited from [[Class: I2CE_Page#fixupRequestVariables() | I2CE_Page->fixupRequestVariables()]]
 
===flattenRequestVars()===
This public method is inherited from [[Class: I2CE_Page#flattenRequestVars() | I2CE_Page->flattenRequestVars()]]
 
===get()===
This public method is inherited from [[Class: I2CE_Page#get() | I2CE_Page->get()]]
 
===getAccessedBaseURL()===
This public method is inherited from [[Class: I2CE_Page#getAccessedBaseURL() | I2CE_Page->getAccessedBaseURL()]]
 
===getTemplate()===
This public method is inherited from [[Class: I2CE_Page#getTemplate() | I2CE_Page->getTemplate()]]
 
===getUser()===
This public method is inherited from [[Class: I2CE_Page#getUser() | I2CE_Page->getUser()]]
 
===get_exists()===
This public method is inherited from [[Class: I2CE_Page#get_exists() | I2CE_Page->get_exists()]]
 
===hasPermission()===
This public method is inherited from [[Class: I2CE_Page#hasPermission() | I2CE_Page->hasPermission()]]
 
===isGet()===
This public method is inherited from [[Class: I2CE_Page#isGet() | I2CE_Page->isGet()]]
 
===isPost()===
This public method is inherited from [[Class: I2CE_Page#isPost() | I2CE_Page->isPost()]]
 
===module()===
This public method is inherited from [[Class: I2CE_Page#module() | I2CE_Page->module()]]
 
===page()===
This public method is inherited from [[Class: I2CE_Page#page() | I2CE_Page->page()]]
 
===pageRemainder()===
This public method is inherited from [[Class: I2CE_Page#pageRemainder() | I2CE_Page->pageRemainder()]]
 
===pageRoot()===
This public method is inherited from [[Class: I2CE_Page#pageRoot() | I2CE_Page->pageRoot()]]
 
===post()===
This public method is inherited from [[Class: I2CE_Page#post() | I2CE_Page->post()]]
 
===post_exists()===
This public method is inherited from [[Class: I2CE_Page#post_exists() | I2CE_Page->post_exists()]]
 
===redirect()===
This public method is inherited from [[Class: I2CE_Page#redirect() | I2CE_Page->redirect()]]
 
===request()===
This public method is inherited from [[Class: I2CE_Page#request() | I2CE_Page->request()]]
 
===request_exists()===
This public method is inherited from [[Class: I2CE_Page#request_exists() | I2CE_Page->request_exists()]]
 
===rewrittenURLs()===
This public method is inherited from [[Class: I2CE_Page#rewrittenURLs() | I2CE_Page->rewrittenURLs()]]
 
===session_req()===
This public method is inherited from [[Class: I2CE_Page#session_req() | I2CE_Page->session_req()]]
 
===session_req_exists()===
This public method is inherited from [[Class: I2CE_Page#session_req_exists() | I2CE_Page->session_req_exists()]]
 
===setAccess()===
This public method is inherited from [[Class: I2CE_Page#setAccess() | I2CE_Page->setAccess()]]
 
===setIsPost()===
This public method is inherited from [[Class: I2CE_Page#setIsPost() | I2CE_Page->setIsPost()]]
 
===setRedirect()===
This public method is inherited from [[Class: I2CE_Page#setRedirect() | I2CE_Page->setRedirect()]]
 
===_display()===
This protected method is inherited from [[Class: I2CE_Page#_display() | I2CE_Page->_display()]]
 
===actionCommandLine()===
This protected method is inherited from [[Class: I2CE_Page#actionCommandLine() | I2CE_Page->actionCommandLine()]]
 
===getAccess()===
This protected method is inherited from [[Class: I2CE_Page#getAccess() | I2CE_Page->getAccess()]]
 
===getTitle()===
This protected method is inherited from [[Class: I2CE_Page#getTitle() | I2CE_Page->getTitle()]]
 
===initializeTemplate()===
This protected method is inherited from [[Class: I2CE_Page#initializeTemplate() | I2CE_Page->initializeTemplate()]]
 
===loadHTMLTemplates()===
This protected method is inherited from [[Class: I2CE_Page#loadHTMLTemplates() | I2CE_Page->loadHTMLTemplates()]]
 
===setupGetPost()===
This protected method is inherited from [[Class: I2CE_Page#setupGetPost() | I2CE_Page->setupGetPost()]]
 
===_hasMethod()===
This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
==Inherited Variables==
===$template===
Theis protected variable is inherited from [[Class: I2CE_Page#$template | I2CE_Page->$template]]
 
===$defaultHTMLFile===
Theis protected variable is inherited from [[Class: I2CE_Page#$defaultHTMLFile | I2CE_Page->$defaultHTMLFile]]
 
===$role===
Theis protected variable is inherited from [[Class: I2CE_Page#$role | I2CE_Page->$role]]
 
===$user===
Theis protected variable is inherited from [[Class: I2CE_Page#$user | I2CE_Page->$user]]
 
===$post===
Theis protected variable is inherited from [[Class: I2CE_Page#$post | I2CE_Page->$post]]
 
===$get===
Theis protected variable is inherited from [[Class: I2CE_Page#$get | I2CE_Page->$get]]
 
===$page_root===
Theis protected variable is inherited from [[Class: I2CE_Page#$page_root | I2CE_Page->$page_root]]
 
===$page_remainder===
Theis protected variable is inherited from [[Class: I2CE_Page#$page_remainder | I2CE_Page->$page_remainder]]
 
===$args===
Theis protected variable is inherited from [[Class: I2CE_Page#$args | I2CE_Page->$args]]
 
===$request_remainder===
Theis protected variable is inherited from [[Class: I2CE_Page#$request_remainder | I2CE_Page->$request_remainder]]
 
===$permissionParser===
Theis protected variable is inherited from [[Class: I2CE_Page#$permissionParser | I2CE_Page->$permissionParser]]
 
===$page===
Theis protected variable is inherited from [[Class: I2CE_Page#$page | I2CE_Page->$page]]
 
===$module===
Theis protected variable is inherited from [[Class: I2CE_Page#$module | I2CE_Page->$module]]
 
===$is_post===
Theis protected variable is inherited from [[Class: I2CE_Page#$is_post | I2CE_Page->$is_post]]
 
===$session_req===
Theis protected variable is inherited from [[Class: I2CE_Page#$session_req | I2CE_Page->$session_req]]
==Inherited Fuzzy Methods==
===launchBackgroundProcess()===
This method is inherited from [[Class: I2CE_Page#launchBackgroundProcess() | I2CE_Page->launchBackgroundProcess()]]
 
===launchBackgroundPHPScript()===
This method is inherited from [[Class: I2CE_Page#launchBackgroundPHPScript() | I2CE_Page->launchBackgroundPHPScript()]]
 
===launchBackgroundPage()===
This method is inherited from [[Class: I2CE_Page#launchBackgroundPage() | I2CE_Page->launchBackgroundPage()]]
 
===addColorPickerTriple()===
This method is inherited from [[Class: I2CE_Page#addColorPickerTriple() | I2CE_Page->addColorPickerTriple()]]
 
===selectOptionsImmediate()===
This method is inherited from [[Class: I2CE_Page#selectOptionsImmediate() | I2CE_Page->selectOptionsImmediate()]]
 
===setDisplayData()===
This method is inherited from [[Class: I2CE_Page#setDisplayData() | I2CE_Page->setDisplayData()]]
 
===setDisplayDataImmediate()===
This method is inherited from [[Class: I2CE_Page#setDisplayDataImmediate() | I2CE_Page->setDisplayDataImmediate()]]
 
===addFormWorm()===
This method is inherited from [[Class: I2CE_Page#addFormWorm() | I2CE_Page->addFormWorm()]]
 
===getClassValue()===
This method is inherited from [[Class: I2CE_Page#getClassValue() | I2CE_Page->getClassValue()]]
 
===loadClassValues()===
This method is inherited from [[Class: I2CE_Page#loadClassValues() | I2CE_Page->loadClassValues()]]
 
===setClassValue()===
This method is inherited from [[Class: I2CE_Page#setClassValue() | I2CE_Page->setClassValue()]]
 
===setClassValues()===
This method is inherited from [[Class: I2CE_Page#setClassValues() | I2CE_Page->setClassValues()]]
 
===addOption()===
This method is inherited from [[Class: I2CE_Page#addOption() | I2CE_Page->addOption()]]
 
===addOptions()===
This method is inherited from [[Class: I2CE_Page#addOptions() | I2CE_Page->addOptions()]]
 
===addAutoCompleteInputTreeById()===
This method is inherited from [[Class: I2CE_Page#addAutoCompleteInputTreeById() | I2CE_Page->addAutoCompleteInputTreeById()]]
 
===addAutoCompleteInputTree()===
This method is inherited from [[Class: I2CE_Page#addAutoCompleteInputTree() | I2CE_Page->addAutoCompleteInputTree()]]
 
===setForm()===
This method is inherited from [[Class: I2CE_Page#setForm() | I2CE_Page->setForm()]]
 
===getField()===
This method is inherited from [[Class: I2CE_Page#getField() | I2CE_Page->getField()]]
 
===setReview()===
This method is inherited from [[Class: I2CE_Page#setReview() | I2CE_Page->setReview()]]
 
===isReview()===
This method is inherited from [[Class: I2CE_Page#isReview() | I2CE_Page->isReview()]]
 
===setShowForm()===
This method is inherited from [[Class: I2CE_Page#setShowForm() | I2CE_Page->setShowForm()]]
 
===showForm()===
This method is inherited from [[Class: I2CE_Page#showForm() | I2CE_Page->showForm()]]
 
===makeJumper()===
This method is inherited from [[Class: I2CE_Page#makeJumper() | I2CE_Page->makeJumper()]]
 
===menuSelect()===
This method is inherited from [[Class: I2CE_Page#menuSelect() | I2CE_Page->menuSelect()]]
 
===addUpdateSelect()===
This method is inherited from [[Class: I2CE_Page#addUpdateSelect() | I2CE_Page->addUpdateSelect()]]
 
===addAjaxUpdate()===
This method is inherited from [[Class: I2CE_Page#addAjaxUpdate() | I2CE_Page->addAjaxUpdate()]]
 
===addAjaxToggle()===
This method is inherited from [[Class: I2CE_Page#addAjaxToggle() | I2CE_Page->addAjaxToggle()]]
 
===addAjaxRequestFunction()===
This method is inherited from [[Class: I2CE_Page#addAjaxRequestFunction() | I2CE_Page->addAjaxRequestFunction()]]
 
===addAjaxCompleteFunction()===
This method is inherited from [[Class: I2CE_Page#addAjaxCompleteFunction() | I2CE_Page->addAjaxCompleteFunction()]]
 
===addAjaxToggleOnFunction()===
This method is inherited from [[Class: I2CE_Page#addAjaxToggleOnFunction() | I2CE_Page->addAjaxToggleOnFunction()]]
 
===addAjaxToggleOffFunction()===
This method is inherited from [[Class: I2CE_Page#addAjaxToggleOffFunction() | I2CE_Page->addAjaxToggleOffFunction()]]
 
===hasAjax()===
This method is inherited from [[Class: I2CE_Page#hasAjax() | I2CE_Page->hasAjax()]]
 
===setDataTypePriority()===
This method is inherited from [[Class: I2CE_Page#setDataTypePriority() | I2CE_Page->setDataTypePriority()]]
 
===setData()===
This method is inherited from [[Class: I2CE_Page#setData() | I2CE_Page->setData()]]
 
===getData()===
This method is inherited from [[Class: I2CE_Page#getData() | I2CE_Page->getData()]]
 
===getDefaultData()===
This method is inherited from [[Class: I2CE_Page#getDefaultData() | I2CE_Page->getDefaultData()]]
 
===removeData()===
This method is inherited from [[Class: I2CE_Page#removeData() | I2CE_Page->removeData()]]
 
===getDataNames()===
This method is inherited from [[Class: I2CE_Page#getDataNames() | I2CE_Page->getDataNames()]]
 
===ensureNode()===
This method is inherited from [[Class: I2CE_Page#ensureNode() | I2CE_Page->ensureNode()]]
 
===userMessage()===
This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
 
 
[[Category:Class Documentation]]

Latest revision as of 09:47, 23 August 2013