Class: I2CE MagicDataStorageMem (Development): Difference between revisions

From IHRIS Wiki
(Created page with '{{otherversions|Class: I2CE_MagicDataStorageMem}} This article describes the class ''I2CE_MagicDataStorageMem'' . *Extends the class: [[Class: I2CE_MagicDataStorage (Development)…')
 
No edit summary
 
Line 2: Line 2:
This article describes the class ''I2CE_MagicDataStorageMem'' .
This article describes the class ''I2CE_MagicDataStorageMem'' .
*Extends the class: [[Class: I2CE_MagicDataStorage (Development) | I2CE_MagicDataStorage]].
*Extends the class: [[Class: I2CE_MagicDataStorage (Development) | I2CE_MagicDataStorage]].
*Location: Part of the module [[I2CE Module List (Development)#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev
*Location: Part of the module [[I2CE Module List (Development)#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] 4.1-dev
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L35 lib/I2CE_MagicDataStorageMem.php] on line 35
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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-dev/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L44 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 44
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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-dev/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L56 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 56
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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-dev/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L78 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 78
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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-dev/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L65 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 65
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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 27: Line 27:
===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-dev/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L51 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 51
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L51 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 51
*Signature: public function isAvailable()
*Signature: public function isAvailable()
===renameChild()===
Renames a child node
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L121 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 121
*Signature: public function renameChild($node,$old,$new)
*Parameters:
** [[Class: I2CE_MagicDataNode (Development) | I2CE_MagicDataNode]] $node
** [http://www.php.net/manual/en/language.types.string.php string ] $old
** [http://www.php.net/manual/en/language.types.string.php string ] $new
*Returns: boolean.<br/>True on success, false on failure
===renameDecendents()===
Rename the descenedent children for which we need to rename  its paths
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L143 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 143
*Signature: protected function renameDecendents($node,$children)
*Parameters:
** [[Class: I2CE_MagicDataNode (Development) | I2CE_MagicDataNode]] $node
** [http://www.php.net/manual/en/language.types.array.php array ] $children <br/>an array of child paths we need to rename its path
===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-dev/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L103 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 103
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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 38: Line 54:
===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-dev/annotate/head:/lib/I2CE_MagicDataStorageMem.php#L87 i2ce/lib/I2CE_MagicDataStorageMem.php] on line 87
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.1-dev/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:
** [[Class: I2CE_MagicDataNode (Development) | I2CE_MagicDataNode]] $node
** [[Class: I2CE_MagicDataNode (Development) | I2CE_MagicDataNode]] $node
==Inherited Methods==
==Inherited Methods==
===getChildPath()===
This public method is inherited from [[Class: I2CE_MagicDataStorage (Development)#getChildPath() | I2CE_MagicDataStorage->getChildPath()]]
===getHash()===
===getHash()===
This public method is inherited from [[Class: I2CE_MagicDataStorage (Development)#getHash() | I2CE_MagicDataStorage->getHash()]]
This public method is inherited from [[Class: I2CE_MagicDataStorage (Development)#getHash() | I2CE_MagicDataStorage->getHash()]]

Latest revision as of 08:15, 6 May 2015


This article describes the class I2CE_MagicDataStorageMem .

Variables

$data

An array of the data saved in memory.

Methods

__construct()

clear()

Clear the all keys/values associated with this storage

destroy()

Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode @param boolean. True on sucess

isAvailable()

Returns true if this storage mechanism is ready to be used. false otherwise.

renameChild()

Renames a child node

renameDecendents()

Rename the descenedent children for which we need to rename its paths

retrieve()

Retrieve the given I2CE_MagicDataNode value and type.

store()

Store the given I2CE_MagicDataNode into memory.

Inherited Methods

getChildPath()

This public method is inherited from I2CE_MagicDataStorage->getChildPath()

getHash()

This public method is inherited from I2CE_MagicDataStorage->getHash()

Inherited Variables

$name

Theis protected variable is inherited from I2CE_MagicDataStorage->$name