Class: I2CE MagicDataStorageMem: 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_MagicDataStorageMem.php#L35 lib/I2CE_MagicDataStorageMem.php] on line 35 | ||
==Variables== | ==Variables== | ||
===$data=== | ===$data=== | ||
An array of the data saved in memory. | 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 | *Type: private [http://www.php.net/manual/en/language.types.array.php array ] $data | ||
==Methods== | ==Methods== | ||
===__construct()=== | ===__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() | *Signature: public function __construct() | ||
===clear()=== | ===clear()=== | ||
Clear the all keys/values associated with this storage | 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() | *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 @param boolean. True on sucess | 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) | *Signature: public function destroy($node) | ||
*Parameters: | *Parameters: | ||
| Line 22: | Line 26: | ||
===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_MagicDataStorageMem.php#L51 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 51 | |||
*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_MagicDataStorageMem.php#L103 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 103 | |||
*Signature: public function retrieve($node) | *Signature: public function retrieve($node) | ||
*Parameters: | *Parameters: | ||
| Line 31: | Line 37: | ||
===store()=== | ===store()=== | ||
Store the given I2CE_MagicDataNode into memory. | 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) | *Signature: public function store($node) | ||
*Parameters: | *Parameters: | ||
Revision as of 09:51, 10 November 2009
This article describes the class I2CE_MagicDataStorageMem.
- Extends the class: I2CE_MagicDataStorage.
- Location: Part of the module I2CE in the package I2CE
- Source: Defined in the file lib/I2CE_MagicDataStorageMem.php on line 35
Variables
$data
An array of the data saved in memory.
- Defined in i2ce/lib/I2CE_MagicDataStorageMem.php on line 44
- Type: private array $data
Methods
__construct()
- Defined in i2ce/lib/I2CE_MagicDataStorageMem.php on line 56
- Signature: public function __construct()
clear()
Clear the all keys/values associated with this storage
- Defined in i2ce/lib/I2CE_MagicDataStorageMem.php on line 78
- Signature: public function clear()
- Returns: boolean
destroy()
Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode @param boolean. True on sucess
- Defined in 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 i2ce/lib/I2CE_MagicDataStorageMem.php on line 51
- Signature: public function isAvailable()
retrieve()
Retrieve the given I2CE_MagicDataNode value and type.
- Defined in i2ce/lib/I2CE_MagicDataStorageMem.php on line 103
- Signature: public function retrieve($node)
- Parameters:
- I2CE_MagicDataNode $node
- Returns: array
store()
Store the given I2CE_MagicDataNode into memory.
- Defined in i2ce/lib/I2CE_MagicDataStorageMem.php on line 87
- Signature: public function store($node)
- Parameters:
- I2CE_MagicDataNode $node
Inherited Methods
getHash()
This public method is inherited from I2CE_MagicDataStorage->getHash()
Inherited Variables
$name
Theis protected variable is inherited from I2CE_MagicDataStorage->$name
