Class: I2CE MagicDataStorageMemcached (Development): Difference between revisions

From IHRIS Wiki
(Created page with '{{otherversions|Class: I2CE_MagicDataStorageMemcached}} This article describes the class ''I2CE_MagicDataStorageMemcached'' . *Extends the class: [[Class: I2CE_MagicDataStorage (…')
 
No edit summary
Line 20: Line 20:
===clear()===
===clear()===
Delete all APC keys associated with this storage object.
Delete all APC keys associated with this storage object.
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_MagicDataStorageMemcached.php#L137 i2ce/lib/I2CE_MagicDataStorageMemcached.php] on line 137
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_MagicDataStorageMemcached.php#L155 i2ce/lib/I2CE_MagicDataStorageMemcached.php] on line 155
*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
Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_MagicDataStorageMemcached.php#L129 i2ce/lib/I2CE_MagicDataStorageMemcached.php] on line 129
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_MagicDataStorageMemcached.php#L135 i2ce/lib/I2CE_MagicDataStorageMemcached.php] on line 135
*Signature: public function destroy($node)
*Signature: public function destroy($node)
*Parameters:
*Parameters:
Line 31: Line 31:
===getKey()===
===getKey()===
Return the APC prefix for storing variables. @param string $type The variable type (path/type/value/children)
Return the APC prefix for storing variables. @param string $type The variable type (path/type/value/children)
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_MagicDataStorageMemcached.php#L79 i2ce/lib/I2CE_MagicDataStorageMemcached.php] on line 79
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_MagicDataStorageMemcached.php#L82 i2ce/lib/I2CE_MagicDataStorageMemcached.php] on line 82
*Signature: public function getKey($node)
*Signature: public function getKey($node)
*Parameters:
*Parameters:
Line 42: Line 42:
===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_MagicDataStorageMemcached.php#L117 i2ce/lib/I2CE_MagicDataStorageMemcached.php] on line 117
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_MagicDataStorageMemcached.php#L123 i2ce/lib/I2CE_MagicDataStorageMemcached.php] on line 123
*Signature: public function retrieve($node)
*Signature: public function retrieve($node)
*Parameters:
*Parameters:
Line 49: Line 49:
===store()===
===store()===
Store the given I2CE_MagicDataNode into APC
Store the given I2CE_MagicDataNode into APC
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_MagicDataStorageMemcached.php#L88 i2ce/lib/I2CE_MagicDataStorageMemcached.php] on line 88
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_MagicDataStorageMemcached.php#L91 i2ce/lib/I2CE_MagicDataStorageMemcached.php] on line 91
*Signature: public function store($node)
*Signature: public function store($node)
*Parameters:
*Parameters:

Revision as of 07:53, 27 May 2010


This article describes the class I2CE_MagicDataStorageMemcached .

Configuration class to lookup and save configuration options.

Variables

$memcached

@protected var Memcached $memcached. The memcached instance

Methods

__construct()

Create a new instance for magic data storage.

clear()

Delete all APC keys associated with this storage object.

destroy()

Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode

getKey()

Return the APC prefix for storing variables. @param string $type The variable type (path/type/value/children)

isAvailable()

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

retrieve()

Retrieve the given I2CE_MagicDataNode value and type.

store()

Store the given I2CE_MagicDataNode into APC

Inherited Methods

getHash()

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

Inherited Variables

$name

Theis protected variable is inherited from I2CE_MagicDataStorage->$name