Class: I2CE MagicDataStorageMem: Difference between revisions

From IHRIS Wiki
No edit summary
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
This article describes the class ''I2CE_MagicDataStorageMem''.
#REDIRECT [[Class: I2CE_MagicDataStorageMem (4.1.7)]]
*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]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L35 lib/I2CE_MagicDataStorageMem.php] on line 35
==Variables==
===$data===
An array of the data saved in memory.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L44 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 44
*Type: private [http://www.php.net/manual/en/language.types.array.php array ] $data
 
==Methods==
===__construct()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L56 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 56
*Signature: public function __construct()
===clear()===
Clear the all keys/values associated with this storage
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L78 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 78
*Signature: public function clear()
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
===destroy()===
Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode @param boolean.  True on sucess
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L65 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 65
*Signature: public function destroy($node)
*Parameters:
**$node
===isAvailable()===
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_MagicDataStorageMem.php#L51 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 51
*Signature: public function isAvailable()
===retrieve()===
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_MagicDataStorageMem.php#L103 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 103
*Signature: public function retrieve($node)
*Parameters:
** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]
===store()===
Store the given I2CE_MagicDataNode into memory.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L87 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 87
*Signature: public function store($node)
*Parameters:
** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node
==Inherited Methods==
===getHash()===
This public method is inherited from [[Class: I2CE_MagicDataStorage#getHash() | I2CE_MagicDataStorage->getHash()]]
==Inherited Variables==
===$name===
Theis protected variable is inherited from [[Class: I2CE_MagicDataStorage#$name | I2CE_MagicDataStorage->$name]]
 
 
[[Category:Class Documentation]]

Latest revision as of 09:42, 23 August 2013