|
|
| (12 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_MagicDataStorageAPC''.
| | #REDIRECT [[Class: I2CE_MagicDataStorageAPC (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_MagicDataStorageAPC.php#L34 lib/I2CE_MagicDataStorageAPC.php] on line 34
| |
| Configuration class to lookup and save configuration options.
| |
| ==Methods==
| |
| ===clear()===
| |
| Delete all APC keys associated with this storage object.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageAPC.php#L140 i2ce/lib/I2CE_MagicDataStorageAPC.php] on line 140
| |
| *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
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageAPC.php#L130 i2ce/lib/I2CE_MagicDataStorageAPC.php] on line 130
| |
| *Signature: public function destroy($node)
| |
| *Parameters:
| |
| **$node
| |
| ===getKeys()===
| |
| Return a list of all APC keys associated with this storage object.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageAPC.php#L114 i2ce/lib/I2CE_MagicDataStorageAPC.php] on line 114
| |
| *Signature: public function getKeys()
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]
| |
| ===getPrefix()===
| |
| Return the APC prefix for storing variables.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageAPC.php#L55 i2ce/lib/I2CE_MagicDataStorageAPC.php] on line 55
| |
| *Signature: public function getPrefix($type)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $type <br/>The variable type (path/type/value/children)
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===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_MagicDataStorageAPC.php#L41 i2ce/lib/I2CE_MagicDataStorageAPC.php] on line 41
| |
| *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_MagicDataStorageAPC.php#L92 i2ce/lib/I2CE_MagicDataStorageAPC.php] on line 92
| |
| *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 APC
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageAPC.php#L64 i2ce/lib/I2CE_MagicDataStorageAPC.php] on line 64
| |
| *Signature: public function store($node)
| |
| *Parameters:
| |
| ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node
| |
| *Returns: boolean.<br/>True on sucess
| |
| ==Inherited Methods==
| |
| ===__construct()===
| |
| This public method is inherited from [[Class: I2CE_MagicDataStorage#__construct() | I2CE_MagicDataStorage->__construct()]]
| |
| | |
| ===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]]
| |
