Class: I2CE Page MagicDataExport (Development): Difference between revisions
No edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
*Child Classes: | *Child Classes: | ||
** [[Class: I2CE_Page_Report_MagicDataExport (Development) | I2CE_Page_Report_MagicDataExport]] | ** [[Class: I2CE_Page_Report_MagicDataExport (Development) | I2CE_Page_Report_MagicDataExport]] | ||
*Location: Part of the module [[I2CE Module List (Development)#magicDataExport|magicDataExport]] in the package [https://launchpad.net/i2ce I2CE] 4. | *Location: Part of the module [[I2CE Module List (Development)#magicDataExport|magicDataExport]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/MagicDataExport/I2CE_Page_MagicDataExport.php#L29 modules/MagicDataExport/I2CE_Page_MagicDataExport.php] on line 29 | ||
*Author: Carl Leitner <litlfred@ibiblio.org> | *Author: Carl Leitner <litlfred@ibiblio.org> | ||
Export Magic Data Page | Export Magic Data Page | ||
| Line 11: | Line 11: | ||
===$config_path=== | ===$config_path=== | ||
the configuration path requested for this page. | the configuration path requested for this page. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/MagicDataExport/I2CE_Page_MagicDataExport.php#L37 i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php] on line 37 | ||
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $config_path | *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $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. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/MagicDataExport/I2CE_Page_MagicDataExport.php#L42 i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php] on line 42 | ||
*Type: protected [[Class: I2CE_MagicData (Development) | I2CE_MagicData]] $config | *Type: protected [[Class: I2CE_MagicData (Development) | I2CE_MagicData]] $config | ||
| Line 22: | Line 22: | ||
===action()=== | ===action()=== | ||
Perform the actions for this page | Perform the actions for this page | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/MagicDataExport/I2CE_Page_MagicDataExport.php#L62 i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php] on line 62 | ||
*Signature: protected function action() | *Signature: protected function action() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===actionCommandLine()=== | ===actionCommandLine()=== | ||
Call the action method for this page from the command line. | Call the action method for this page from the command line. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/MagicDataExport/I2CE_Page_MagicDataExport.php#L76 i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php] on line 76 | ||
*Signature: protected function actionCommandLine($args,$request_remainder) | *Signature: protected function actionCommandLine($args,$request_remainder) | ||
*Parameters: | *Parameters: | ||
| Line 34: | Line 34: | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===actionExport()=== | ===actionExport()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/MagicDataExport/I2CE_Page_MagicDataExport.php#L114 i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php] on line 114 | ||
*Signature: protected function actionExport() | *Signature: protected function actionExport() | ||
===getMetaDataOptions()=== | ===getMetaDataOptions()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/MagicDataExport/I2CE_Page_MagicDataExport.php#L86 i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php] on line 86 | ||
*Signature: protected function getMetaDataOptions() | *Signature: protected function getMetaDataOptions() | ||
===getModuleName()=== | ===getModuleName()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/MagicDataExport/I2CE_Page_MagicDataExport.php#L103 i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php] on line 103 | ||
*Signature: protected function getModuleName() | *Signature: protected function getModuleName() | ||
===noConfig()=== | ===noConfig()=== | ||
Method called when there is no magic data to export | Method called when there is no magic data to export | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/MagicDataExport/I2CE_Page_MagicDataExport.php#L166 i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php] on line 166 | ||
*Signature: protected function noConfig($configNode) | *Signature: protected function noConfig($configNode) | ||
*Parameters: | *Parameters: | ||
| Line 50: | Line 50: | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success | ||
===setConfig()=== | ===setConfig()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4. | *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/modules/MagicDataExport/I2CE_Page_MagicDataExport.php#L46 i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php] on line 46 | ||
*Signature: protected function setConfig() | *Signature: protected function setConfig() | ||
==Inherited Methods== | ==Inherited Methods== | ||
| Line 76: | Line 76: | ||
===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 139: | Line 145: | ||
===_display()=== | ===_display()=== | ||
This protected method is inherited from [[Class: I2CE_Page (Development)#_display() | I2CE_Page->_display()]] | This protected method is inherited from [[Class: I2CE_Page (Development)#_display() | I2CE_Page->_display()]] | ||
===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()]] | ||
=== | ===initPage()=== | ||
This protected method is inherited from [[Class: I2CE_Page (Development)# | This protected method is inherited from [[Class: I2CE_Page (Development)#initPage() | I2CE_Page->initPage()]] | ||
===initializeTemplate()=== | ===initializeTemplate()=== | ||
| Line 151: | Line 163: | ||
===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 169: | Line 184: | ||
===$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 190: | Line 208: | ||
===$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 214: | Line 235: | ||
===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 241: | Line 265: | ||
===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 256: | Line 283: | ||
===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 265: | Line 295: | ||
===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()]] | ||
===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 283: | Line 310: | ||
===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_MagicDataExport .
- Extends the class: I2CE_Page.
- Child Classes:
- Location: Part of the module magicDataExport in the package I2CE 4.1-dev
- Source: Defined in the file modules/MagicDataExport/I2CE_Page_MagicDataExport.php on line 29
- Author: Carl Leitner <litlfred@ibiblio.org>
Export Magic Data Page
Variables
$config_path
the configuration path requested for this page.
- Defined in i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php on line 37
- Type: protected string $config_path
$config
protected The magic data pointed to by the config path
- Defined in i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php on line 42
- Type: protected I2CE_MagicData $config
Methods
action()
Perform the actions for this page
- Defined in i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php on line 62
- Signature: protected function action()
- Returns: boolean
actionCommandLine()
Call the action method for this page from the command line.
- Defined in i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php on line 76
- Signature: protected function actionCommandLine($args,$request_remainder)
- Parameters:
- $args
- $request_remainder
- Returns: boolean
actionExport()
- Defined in i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php on line 114
- Signature: protected function actionExport()
getMetaDataOptions()
- Defined in i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php on line 86
- Signature: protected function getMetaDataOptions()
getModuleName()
- Defined in i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php on line 103
- Signature: protected function getModuleName()
noConfig()
Method called when there is no magic data to export
- Defined in i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php on line 166
- Signature: protected function noConfig($configNode)
- Parameters:
- DOMNode $configNode
The I2CEConfiguration/configurationGroup node
- DOMNode $configNode
- Returns: boolean
true on success
setConfig()
- Defined in i2ce/modules/MagicDataExport/I2CE_Page_MagicDataExport.php on line 46
- Signature: protected function setConfig()
Inherited Methods
__construct()
This public method is inherited from I2CE_Page->__construct()
_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()
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()
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()
