Class: I2CE MagicDataStorageAPC: Difference between revisions
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
This article desrcibes the class ''I2CE_MagicDataStorageAPC''. | This article desrcibes the class ''I2CE_MagicDataStorageAPC''. | ||
*Extends the class: [[Class: I2CE_MagicDataStorage | I2CE_MagicDataStorage]]. | *Extends the class: [[Class: I2CE_MagicDataStorage | I2CE_MagicDataStorage]]. | ||
*Parent Classses: [[Class: I2CE_MagicDataStorage | I2CE_MagicDataStorage]] | |||
*Location: Part of the module [[iHRIS Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] | *Location: Part of the module [[iHRIS Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/lib/I2CE_MagicDataStorageAPC.php lib/I2CE_MagicDataStorageAPC.php] | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/lib/I2CE_MagicDataStorageAPC.php lib/I2CE_MagicDataStorageAPC.php] |
Revision as of 14:01, 17 October 2009
This article desrcibes the class I2CE_MagicDataStorageAPC.
- Extends the class: I2CE_MagicDataStorage.
- Parent Classses: I2CE_MagicDataStorage
- Location: Part of the module I2CE in the package I2CE
- Source: Defined in the file lib/I2CE_MagicDataStorageAPC.php
Configuration class to lookup and save configuration options.
Methods
clear()
Delete all APC keys associated with this storage object.
- Signature: public function clear()
- Returns: boolean
destroy()
Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode
- Signature: public function destroy($node)
- Parameters:
- $node
getKeys()
Return a list of all APC keys associated with this storage object.
- Signature: public function getKeys()
- Returns: array
getPrefix()
Return the APC prefix for storing variables.
- Signature: public function getPrefix($type)
- Parameters:
- string $type
The variable type (path/type/value/children)
- string $type
- Returns: string
isAvailable()
Returns true if this storage mechanism is ready to be used. false otherwise.
- Signature: public function isAvailable()
retrieve()
Retrieve the given I2CE_MagicDataNode value and type.
- Signature: public function retrieve($node)
- Parameters:
- I2CE_MagicDataNode $node
- Returns: array
store()
Store the given I2CE_MagicDataNode into APC
- Signature: public function store($node)
- Parameters:
- I2CE_MagicDataNode $node
- Returns: boolean.
True on sucess
Inherited Methods
__construct()
This public method is inherited from I2CE_MagicDataStorage->__construct()
getHash()
This public method is inherited from I2CE_MagicDataStorage->getHash()
Inherited Variables
$name
Theis protected variable is inherited from I2CE_MagicDataStorage->$name