Class: I2CE Module Core (Development): Difference between revisions
(Created page with '{{otherversions|Class: I2CE_Module_Core}} This article describes the class ''I2CE_Module_Core'' . *Extends the class: I2CE_Module. *Locatio…') |
No edit summary |
||
Line 8: | Line 8: | ||
==Methods== | ==Methods== | ||
===_runStatementList()=== | ===_runStatementList()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php# | *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 | ||
*Signature: static private function _runStatementList($statements) | *Signature: static private function _runStatementList($statements) | ||
*Parameters: | *Parameters: | ||
Line 18: | Line 18: | ||
*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# | *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 | ||
*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# | *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 | ||
*Signature: protected function createAltConfig($update_from_config) | *Signature: protected function createAltConfig($update_from_config) | ||
*Parameters: | *Parameters: | ||
**$update_from_config | **$update_from_config | ||
===dropOldCaches()=== | ===dropOldCaches()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php# | *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 | ||
*Signature: protected function dropOldCaches() | *Signature: protected function dropOldCaches() | ||
===getHooks()=== | ===getHooks()=== | ||
Line 33: | Line 33: | ||
===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# | *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 | ||
*Signature: public function post_update($old_vers,$new_vers) | *Signature: public function post_update($old_vers,$new_vers) | ||
*Parameters: | *Parameters: | ||
Line 39: | Line 39: | ||
** [http://www.php.net/manual/en/language.types.string.php string ] $new_vers | ** [http://www.php.net/manual/en/language.types.string.php string ] $new_vers | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===setupMagicDataStorage()=== | |||
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 | |||
*Signature: public function setupMagicDataStorage($old_config_values) | |||
*Parameters: | |||
** [http://www.php.net/manual/en/language.types.array.php array ] $old_config_values <br/>If non-null set the new storage to have these magic data values | |||
***Default Value: null | |||
*Returns: boolean.<br/>True on success | |||
===updateConfigProcessed()=== | ===updateConfigProcessed()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php# | *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 | ||
*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# | *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 | ||
*Signature: protected function updateConfigStatus() | *Signature: protected function updateConfigStatus() | ||
===updateLocales()=== | ===updateLocales()=== | ||
Line 51: | Line 59: | ||
**$args | **$args | ||
===updateToInnoDB()=== | ===updateToInnoDB()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_Module_Core.php# | *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 | ||
*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# | *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 | ||
*Signature: public function upgrade($old_vers,$new_vers) | *Signature: public function upgrade($old_vers,$new_vers) | ||
*Parameters: | *Parameters: |
Revision as of 07:54, 27 May 2010
This article describes the class I2CE_Module_Core .
- Extends the class: I2CE_Module.
- Location: Part of the module I2CE in the package I2CE 4.0-dev
- Source: Defined in the file lib/I2CE_Module_Core.php on line 31
- Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_Module_Core @todo Better Documentation
Methods
_runStatementList()
- Defined in i2ce/lib/I2CE_Module_Core.php on line 293
- Signature: static private function _runStatementList($statements)
- Parameters:
- $statements
- Default Value: null
- $statements
action_initialize()
Method called when the module is enabled for the first time. @param boolean -- returns true on success. false on error.
- Defined in i2ce/lib/I2CE_Module_Core.php on line 52
- Signature: public function action_initialize()
addConfigPathIndex()
- Defined in i2ce/lib/I2CE_Module_Core.php on line 246
- Signature: protected function addConfigPathIndex()
createAltConfig()
- Defined in i2ce/lib/I2CE_Module_Core.php on line 138
- Signature: protected function createAltConfig($update_from_config)
- Parameters:
- $update_from_config
dropOldCaches()
- Defined in i2ce/lib/I2CE_Module_Core.php on line 307
- Signature: protected function dropOldCaches()
getHooks()
- Defined in i2ce/lib/I2CE_Module_Core.php on line 33
- Signature: static public function getHooks()
post_update()
Post Update this module if necessar
- Defined in i2ce/lib/I2CE_Module_Core.php on line 236
- Signature: public function post_update($old_vers,$new_vers)
- Parameters:
- Returns: boolean
setupMagicDataStorage()
Setup the magic data storage
- Defined in i2ce/lib/I2CE_Module_Core.php on line 70
- 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
- array $old_config_values
- Returns: boolean.
True on success
updateConfigProcessed()
- Defined in i2ce/lib/I2CE_Module_Core.php on line 276
- Signature: protected function updateConfigProcessed()
updateConfigStatus()
- Defined in i2ce/lib/I2CE_Module_Core.php on line 329
- Signature: protected function updateConfigStatus()
updateLocales()
- Defined in i2ce/lib/I2CE_Module_Core.php on line 40
- Signature: public function updateLocales($args)
- Parameters:
- $args
updateToInnoDB()
- Defined in i2ce/lib/I2CE_Module_Core.php on line 318
- Signature: protected function updateToInnoDB()
upgrade()
Upgrades the modules
- Defined in i2ce/lib/I2CE_Module_Core.php on line 97
- Signature: public function upgrade($old_vers,$new_vers)
- Parameters:
- Returns: boolean
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()
getCLIHooks()
This public method is inherited from I2CE_Module->getCLIHooks()
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()