Class: I2CE MagicDataStorageAPC: Difference between revisions
From IHRIS Wiki
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]]. | |||
It is contained in the module [[iHRIS Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] | It is contained in the module [[iHRIS Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] | ||
| Line 9: | Line 10: | ||
Delete all APC keys associated with this storage object. | Delete all APC keys associated with this storage object. | ||
*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 | Erases the given I2CE_MagicDataNode from the storage mechanism | ||
| Line 19: | Line 20: | ||
Return a list of all APC keys associated with this storage object. | Return a list of all APC keys associated with this storage object. | ||
*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. | ||
*Signature: public function getPrefix($type) | *Signature: public function getPrefix($type) | ||
*Returns: [http://www.php.net/manual/en/language.types.string.php string] | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] | ||
Parameters: | Parameters: | ||
* [http://www.php.net/manual/en/language.types.string.php string] $type<br/>The variable type (path/type/value/children) | * [http://www.php.net/manual/en/language.types.string.php string ] $type<br/>The variable type (path/type/value/children) | ||
===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. | ||
| Line 32: | Line 33: | ||
Retrieve the given I2CE_MagicDataNode value and type. | Retrieve the given I2CE_MagicDataNode value and type. | ||
*Signature: public function retrieve($node) | *Signature: public function retrieve($node) | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array] | *Returns: [http://www.php.net/manual/en/language.types.array.php array ] | ||
Parameters: | Parameters: | ||
* [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | * [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | ||
Revision as of 21:25, 16 October 2009
This article desrcibes the class I2CE_MagicDataStorageAPC.
- Extends the class: I2CE_MagicDataStorage.
It is contained in the module I2CE in the package I2CE
The class is 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)
- Returns: string
Parameters:
- string $type
The variable type (path/type/value/children)
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)
- Returns: array
Parameters:
- I2CE_MagicDataNode $node
store()
Store the given I2CE_MagicDataNode into APC
- Signature: public function store($node)
- Returns: boolean. True on sucess
Parameters:
- I2CE_MagicDataNode $node
Inherited Variables
$name
Theis protected variable is inherited from I2CE_MagicDataStorage->$name
