Class: I2CE MagicDataStorageMem: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
This article desrcibes the class '''I2CE_MagicDataStorageMem''' | This article desrcibes the class '''I2CE_MagicDataStorageMem'''. | ||
*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 15: | Line 16: | ||
Clear the all keys/values associated with this storage | Clear the all keys/values associated with this storage | ||
*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 30: | Line 31: | ||
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_MagicDataStorageMem.
- 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_MagicDataStorageMem.php
Variables
$data
An array of the data saved in memory.
- Type: private y $data
Methods
__construct()
- Signature: public function __construct()
clear()
Clear the all keys/values associated with this storage
- Signature: public function clear()
- Returns: boolean
destroy()
Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode @param boolean. True on sucess
- Signature: public function destroy($node)
Parameters:
- $node
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 memory.
- Signature: public function store($node)
Parameters:
- I2CE_MagicDataNode $node
Inherited Variables
$name
Theis protected variable is inherited from I2CE_MagicDataStorage->$name
