Class: I2CE Page MagicDataBrowser (Development): Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
 
Line 2: Line 2:
This article describes the class ''I2CE_Page_MagicDataBrowser'' .
This article describes the class ''I2CE_Page_MagicDataBrowser'' .
*Extends the class: [[Class: I2CE_Page (Development) | I2CE_Page]].
*Extends the class: [[Class: I2CE_Page (Development) | I2CE_Page]].
*Location: Part of the module [[I2CE Module List (Development)#magicDataBrowser|magicDataBrowser]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev
*Location: Part of the module [[I2CE Module List (Development)#magicDataBrowser|magicDataBrowser]] 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/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L29 modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 29
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L29 modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 29
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
Default Admin Page
Default Admin Page
Line 9: Line 9:
===$config_path===
===$config_path===
array of strings.  the configuration path requested for this page.
array of strings.  the configuration path requested for this page.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L36 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 36
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L36 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 36
*Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $config_path
*Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $config_path


===$config===
===$config===
protected The magic data pointed to by the config path
protected The magic data pointed to by the config path
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L41 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 41
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L41 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 41
*Type: protected [[Class: I2CE_MagicData (Development) | I2CE_MagicData]] $config
*Type: protected [[Class: I2CE_MagicData (Development) | I2CE_MagicData]] $config


Line 20: Line 20:
===__construct()===
===__construct()===
Constructor -- called from page wrangler for URL of form admin/(module_name)/action/arg1/arg2 @param string $shortname A module name to show the admin page for. Defaults to null to mean no module. @param string $action The action this pages is to perform @param string $message. A message to display on the page.  Defaults to null
Constructor -- called from page wrangler for URL of form admin/(module_name)/action/arg1/arg2 @param string $shortname A module name to show the admin page for. Defaults to null to mean no module. @param string $action The action this pages is to perform @param string $message. A message to display on the page.  Defaults to null
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L50 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 50
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L50 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 50
*Signature: public function __construct($args,$request_remainder)
*Signature: public function __construct($args,$request_remainder)
*Parameters:
*Parameters:
Line 26: Line 26:
**$request_remainder  
**$request_remainder  
===action()===
===action()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L77 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 77
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L84 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 84
*Signature: protected function action()
*Signature: protected function action()
===actionDisplayConfig()===
===actionDisplayConfig()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L290 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 290
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L823 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 823
*Signature: protected function actionDisplayConfig()
*Signature: protected function actionDisplayConfig()
===actionLoad()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L393 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 393
*Signature: protected function actionLoad($transform)
*Parameters:
**$transform
***Default Value: false
===displayConfig()===
===displayConfig()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L148 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 148
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L629 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 629
*Signature: protected function displayConfig($config,$magicNode,$full)
*Signature: protected function displayConfig($config,$magicNode,$full)
*Parameters:
*Parameters:
Line 38: Line 44:
**$magicNode  
**$magicNode  
**$full  
**$full  
===loadCSVIntoListsDoc()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L347 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 347
*Signature: protected function loadCSVIntoListsDoc($file,$doc)
*Parameters:
**$file
**$doc
===loadMDTemplate()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L482 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 482
*Signature: protected function loadMDTemplate($doc,$transform,$erase)
*Parameters:
**$doc
**$transform
***Default Value: false
**$erase
***Default Value: false
===reshow()===
===reshow()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L57 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 57
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php#L58 i2ce/modules/Pages/modules/MagicDataBrowser/I2CE_Page_MagicDataBrowser.php] on line 58
*Signature: protected function reshow($parent)
*Signature: protected function reshow($parent)
*Parameters:
*Parameters:
Line 65: Line 86:
===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 131: Line 158:
===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()===
===initPage()===
This protected method is inherited from [[Class: I2CE_Page (Development)#getTitle() | I2CE_Page->getTitle()]]
This protected method is inherited from [[Class: I2CE_Page (Development)#initPage() | I2CE_Page->initPage()]]


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


===setupGetPost()===
===setupGetPost()===
Line 161: Line 197:
===$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 182: Line 221:
===$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 206: Line 248:
===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 233: Line 278:
===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 248: Line 296:
===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 257: Line 308:
===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 275: Line 323:
===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 08:17, 6 May 2015


This article describes the class I2CE_Page_MagicDataBrowser .

Default Admin Page

Variables

$config_path

array of strings. the configuration path requested for this page.

$config

protected The magic data pointed to by the config path

Methods

__construct()

Constructor -- called from page wrangler for URL of form admin/(module_name)/action/arg1/arg2 @param string $shortname A module name to show the admin page for. Defaults to null to mean no module. @param string $action The action this pages is to perform @param string $message. A message to display on the page. Defaults to null

action()

actionDisplayConfig()

actionLoad()

displayConfig()

loadCSVIntoListsDoc()

loadMDTemplate()

reshow()

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

initPage()

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

initializeTemplate()

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

loadHTMLTemplates()

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

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