Class: I2CE Module Core (Development): Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
 
Line 2: Line 2:
This article describes the class ''I2CE_Module_Core'' .
This article describes the class ''I2CE_Module_Core'' .
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]].
*Extends the class: [[Class: I2CE_Module (Development) | I2CE_Module]].
*Location: Part of the module [[I2CE Module List (Development)#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev
*Location: Part of the module [[I2CE Module List (Development)#I2CE|I2CE]] 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:/lib/I2CE_Module_Core.php#L31 lib/I2CE_Module_Core.php] on line 31
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L31 lib/I2CE_Module_Core.php] on line 31
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_Module_Core  @todo Better Documentation
I2CE_Module_Core  @todo Better Documentation
==Methods==
==Methods==
===_runStatementList()===
===_runStatementList()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php#L293 i2ce/lib/I2CE_Module_Core.php] on line 293
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L439 i2ce/lib/I2CE_Module_Core.php] on line 439
*Signature: static private function _runStatementList($statements)
*Signature: static private function _runStatementList($statements)
*Parameters:
*Parameters:
Line 15: Line 15:
===action_initialize()===
===action_initialize()===
Method called when the module is enabled for the first time. @param boolean -- returns true on success. false on error.
Method called when the module is enabled for the first time. @param boolean -- returns true on success. false on error.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php#L52 i2ce/lib/I2CE_Module_Core.php] on line 52
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L52 i2ce/lib/I2CE_Module_Core.php] on line 52
*Signature: public function action_initialize()
*Signature: public function action_initialize()
===addConfigPathIndex()===
===addConfigPathIndex()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php#L246 i2ce/lib/I2CE_Module_Core.php] on line 246
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L392 i2ce/lib/I2CE_Module_Core.php] on line 392
*Signature: protected function addConfigPathIndex()
*Signature: protected function addConfigPathIndex()
===createAltConfig()===
===createAltConfig()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php#L138 i2ce/lib/I2CE_Module_Core.php] on line 138
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L284 i2ce/lib/I2CE_Module_Core.php] on line 284
*Signature: protected function createAltConfig($update_from_config)
*Signature: protected function createAltConfig($update_from_config)
*Parameters:
*Parameters:
**$update_from_config  
**$update_from_config  
===createMongoDBConfig()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L163 i2ce/lib/I2CE_Module_Core.php] on line 163
*Signature: protected function createMongoDBConfig($update_from_config_alt)
*Parameters:
**$update_from_config_alt
===dropOldCaches()===
===dropOldCaches()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php#L307 i2ce/lib/I2CE_Module_Core.php] on line 307
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L453 i2ce/lib/I2CE_Module_Core.php] on line 453
*Signature: protected function dropOldCaches()
*Signature: protected function dropOldCaches()
===getHooks()===
===getHooks()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php#L33 i2ce/lib/I2CE_Module_Core.php] on line 33
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L33 i2ce/lib/I2CE_Module_Core.php] on line 33
*Signature: static public function getHooks()
*Signature: static public function getHooks()
===post_update()===
===post_update()===
Post Update this module if necessar
Post Update this module if necessar
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php#L236 i2ce/lib/I2CE_Module_Core.php] on line 236
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L382 i2ce/lib/I2CE_Module_Core.php] on line 382
*Signature: public function post_update($old_vers,$new_vers)
*Signature: public function post_update($old_vers,$new_vers)
*Parameters:
*Parameters:
Line 41: Line 46:
===setupMagicDataStorage()===
===setupMagicDataStorage()===
Setup the magic data storage
Setup the magic data storage
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php#L70 i2ce/lib/I2CE_Module_Core.php] on line 70
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L82 i2ce/lib/I2CE_Module_Core.php] on line 82
*Signature: public function setupMagicDataStorage($old_config_values)
*Signature: public function setupMagicDataStorage($old_config_values)
*Parameters:
*Parameters:
Line 47: Line 52:
***Default Value: null
***Default Value: null
*Returns: boolean.<br/>True on success
*Returns: boolean.<br/>True on success
===updateConfigAltToLong()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L273 i2ce/lib/I2CE_Module_Core.php] on line 273
*Signature: protected function updateConfigAltToLong()
===updateConfigProcessed()===
===updateConfigProcessed()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php#L276 i2ce/lib/I2CE_Module_Core.php] on line 276
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L422 i2ce/lib/I2CE_Module_Core.php] on line 422
*Signature: protected function updateConfigProcessed()
*Signature: protected function updateConfigProcessed()
===updateConfigStatus()===
===updateConfigStatus()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php#L329 i2ce/lib/I2CE_Module_Core.php] on line 329
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L475 i2ce/lib/I2CE_Module_Core.php] on line 475
*Signature: protected function updateConfigStatus()
*Signature: protected function updateConfigStatus()
===updateLocales()===
===updateLocales()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php#L40 i2ce/lib/I2CE_Module_Core.php] on line 40
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L40 i2ce/lib/I2CE_Module_Core.php] on line 40
*Signature: public function updateLocales($args)
*Signature: public function updateLocales($args)
*Parameters:
*Parameters:
**$args  
**$args  
===updateToInnoDB()===
===updateToInnoDB()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php#L318 i2ce/lib/I2CE_Module_Core.php] on line 318
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L464 i2ce/lib/I2CE_Module_Core.php] on line 464
*Signature: protected function updateToInnoDB()
*Signature: protected function updateToInnoDB()
===upgrade()===
===upgrade()===
Upgrades the modules
Upgrades the modules
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php#L97 i2ce/lib/I2CE_Module_Core.php] on line 97
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_Module_Core.php#L109 i2ce/lib/I2CE_Module_Core.php] on line 109
*Signature: public function upgrade($old_vers,$new_vers)
*Signature: public function upgrade($old_vers,$new_vers)
*Parameters:
*Parameters:
Line 81: Line 89:
===action_enable()===
===action_enable()===
This public method is inherited from [[Class: I2CE_Module (Development)#action_enable() | I2CE_Module->action_enable()]]
This public method is inherited from [[Class: I2CE_Module (Development)#action_enable() | I2CE_Module->action_enable()]]
===getCLIHooks()===
This public method is inherited from [[Class: I2CE_Module (Development)#getCLIHooks() | I2CE_Module->getCLIHooks()]]


===getCLIMethods()===
===getCLIMethods()===

Latest revision as of 08:15, 6 May 2015


This article describes the class I2CE_Module_Core .

I2CE_Module_Core @todo Better Documentation

Methods

_runStatementList()

  • Defined in i2ce/lib/I2CE_Module_Core.php on line 439
  • Signature: static private function _runStatementList($statements)
  • Parameters:
    • $statements
      • Default Value: null

action_initialize()

Method called when the module is enabled for the first time. @param boolean -- returns true on success. false on error.

addConfigPathIndex()

createAltConfig()

  • Defined in i2ce/lib/I2CE_Module_Core.php on line 284
  • Signature: protected function createAltConfig($update_from_config)
  • Parameters:
    • $update_from_config

createMongoDBConfig()

  • Defined in i2ce/lib/I2CE_Module_Core.php on line 163
  • Signature: protected function createMongoDBConfig($update_from_config_alt)
  • Parameters:
    • $update_from_config_alt

dropOldCaches()

getHooks()

post_update()

Post Update this module if necessar

setupMagicDataStorage()

Setup the magic data storage

  • Defined in i2ce/lib/I2CE_Module_Core.php on line 82
  • Signature: public function setupMagicDataStorage($old_config_values)
  • Parameters:
    • array $old_config_values
      If non-null set the new storage to have these magic data values
      • Default Value: null
  • Returns: boolean.
    True on success

updateConfigAltToLong()

updateConfigProcessed()

updateConfigStatus()

updateLocales()

updateToInnoDB()

upgrade()

Upgrades the modules

Inherited Methods

__construct()

This public method is inherited from I2CE_Module->__construct()

action_configure()

This public method is inherited from I2CE_Module->action_configure()

action_disable()

This public method is inherited from I2CE_Module->action_disable()

action_enable()

This public method is inherited from I2CE_Module->action_enable()

getCLIMethods()

This public method is inherited from I2CE_Module->getCLIMethods()

getConfig()

This public method is inherited from I2CE_Module->getConfig()

getMethods()

This public method is inherited from I2CE_Module->getMethods()

pre_upgrade()

This public method is inherited from I2CE_Module->pre_upgrade()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Fuzzy Methods

launchBackgroundProcess()

This method is inherited from I2CE_Module->launchBackgroundProcess()

launchBackgroundPHPScript()

This method is inherited from I2CE_Module->launchBackgroundPHPScript()

launchBackgroundPage()

This method is inherited from I2CE_Module->launchBackgroundPage()

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()