Class: I2CE MagicDataStorageAPC: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
*Extends the class: [[Class: I2CE_MagicDataStorage | I2CE_MagicDataStorage]]. | *Extends the class: [[Class: I2CE_MagicDataStorage | I2CE_MagicDataStorage]]. | ||
*Location: Part of the module [[I2CE Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] | *Location: Part of the module [[I2CE 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. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageAPC.php#L34 lib/I2CE_MagicDataStorageAPC.php] on line 34 | ||
Configuration class to lookup and save configuration options. | Configuration class to lookup and save configuration options. | ||
==Methods== | ==Methods== | ||
===clear()=== | ===clear()=== | ||
Delete all APC keys associated with this storage object. | Delete all APC keys associated with this storage object. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageAPC.php#L140 i2ce/lib/I2CE_MagicDataStorageAPC.php] on line 140 | |||
*Signature: public function clear() | *Signature: public function clear() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===destroy()=== | ===destroy()=== | ||
Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode | Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageAPC.php#L130 i2ce/lib/I2CE_MagicDataStorageAPC.php] on line 130 | |||
*Signature: public function destroy($node) | *Signature: public function destroy($node) | ||
*Parameters: | *Parameters: | ||
| Line 16: | Line 18: | ||
===getKeys()=== | ===getKeys()=== | ||
Return a list of all APC keys associated with this storage object. | Return a list of all APC keys associated with this storage object. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageAPC.php#L114 i2ce/lib/I2CE_MagicDataStorageAPC.php] on line 114 | |||
*Signature: public function getKeys() | *Signature: public function getKeys() | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ] | *Returns: [http://www.php.net/manual/en/language.types.array.php array ] | ||
===getPrefix()=== | ===getPrefix()=== | ||
Return the APC prefix for storing variables. | Return the APC prefix for storing variables. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageAPC.php#L55 i2ce/lib/I2CE_MagicDataStorageAPC.php] on line 55 | |||
*Signature: public function getPrefix($type) | *Signature: public function getPrefix($type) | ||
*Parameters: | *Parameters: | ||
| Line 26: | Line 30: | ||
===isAvailable()=== | ===isAvailable()=== | ||
Returns true if this storage mechanism is ready to be used. false otherwise. | Returns true if this storage mechanism is ready to be used. false otherwise. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageAPC.php#L41 i2ce/lib/I2CE_MagicDataStorageAPC.php] on line 41 | |||
*Signature: public function isAvailable() | *Signature: public function isAvailable() | ||
===retrieve()=== | ===retrieve()=== | ||
Retrieve the given I2CE_MagicDataNode value and type. | Retrieve the given I2CE_MagicDataNode value and type. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageAPC.php#L92 i2ce/lib/I2CE_MagicDataStorageAPC.php] on line 92 | |||
*Signature: public function retrieve($node) | *Signature: public function retrieve($node) | ||
*Parameters: | *Parameters: | ||
| Line 35: | Line 41: | ||
===store()=== | ===store()=== | ||
Store the given I2CE_MagicDataNode into APC | Store the given I2CE_MagicDataNode into APC | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageAPC.php#L64 i2ce/lib/I2CE_MagicDataStorageAPC.php] on line 64 | |||
*Signature: public function store($node) | *Signature: public function store($node) | ||
*Parameters: | *Parameters: | ||
Revision as of 08:51, 10 November 2009
This article describes the class I2CE_MagicDataStorageAPC.
- Extends the class: I2CE_MagicDataStorage.
- Location: Part of the module I2CE in the package I2CE
- Source: Defined in the file lib/I2CE_MagicDataStorageAPC.php on line 34
Configuration class to lookup and save configuration options.
Methods
clear()
Delete all APC keys associated with this storage object.
- Defined in i2ce/lib/I2CE_MagicDataStorageAPC.php on line 140
- Signature: public function clear()
- Returns: boolean
destroy()
Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode
- Defined in i2ce/lib/I2CE_MagicDataStorageAPC.php on line 130
- Signature: public function destroy($node)
- Parameters:
- $node
getKeys()
Return a list of all APC keys associated with this storage object.
- Defined in i2ce/lib/I2CE_MagicDataStorageAPC.php on line 114
- Signature: public function getKeys()
- Returns: array
getPrefix()
Return the APC prefix for storing variables.
- Defined in i2ce/lib/I2CE_MagicDataStorageAPC.php on line 55
- 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.
- Defined in i2ce/lib/I2CE_MagicDataStorageAPC.php on line 41
- Signature: public function isAvailable()
retrieve()
Retrieve the given I2CE_MagicDataNode value and type.
- Defined in i2ce/lib/I2CE_MagicDataStorageAPC.php on line 92
- Signature: public function retrieve($node)
- Parameters:
- I2CE_MagicDataNode $node
- Returns: array
store()
Store the given I2CE_MagicDataNode into APC
- Defined in i2ce/lib/I2CE_MagicDataStorageAPC.php on line 64
- 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
