Class: I2CE MagicDataStorageAPC: Difference between revisions
No edit summary |
No edit summary |
||
| Line 39: | Line 39: | ||
** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | ||
*Returns: boolean.<br/>True on sucess | *Returns: boolean.<br/>True on sucess | ||
==Inherited Methods== | |||
===__construct()=== | |||
This public method is inherited from [[Class: I2CE_MagicDataStorage#__construct() | I2CE_MagicDataStorage->__construct()]] | |||
===clear()=== | |||
This public method is inherited from [[Class: I2CE_MagicDataStorage#clear() | I2CE_MagicDataStorage->clear()]] | |||
===destroy()=== | |||
This public method is inherited from [[Class: I2CE_MagicDataStorage#destroy() | I2CE_MagicDataStorage->destroy()]] | |||
===getHash()=== | |||
This public method is inherited from [[Class: I2CE_MagicDataStorage#getHash() | I2CE_MagicDataStorage->getHash()]] | |||
===isAvailable()=== | |||
This public method is inherited from [[Class: I2CE_MagicDataStorage#isAvailable() | I2CE_MagicDataStorage->isAvailable()]] | |||
===retrieve()=== | |||
This public method is inherited from [[Class: I2CE_MagicDataStorage#retrieve() | I2CE_MagicDataStorage->retrieve()]] | |||
===store()=== | |||
This public method is inherited from [[Class: I2CE_MagicDataStorage#store() | I2CE_MagicDataStorage->store()]] | |||
==Inherited Variables== | ==Inherited Variables== | ||
===$name=== | ===$name=== | ||
Revision as of 13:00, 17 October 2009
This article desrcibes the class I2CE_MagicDataStorageAPC.
- Extends the class: I2CE_MagicDataStorage.
- Location: Part of the module I2CE in the package I2CE
- Source: Defined in the file lib/I2CE_MagicDataStorageAPC.php
Configuration class to lookup and save configuration options.
Methods
clear()
Delete all APC keys associated with this storage object.
- Signature: public function clear()
- Returns: boolean
destroy()
Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode
- Signature: public function destroy($node)
- Parameters:
- $node
getKeys()
Return a list of all APC keys associated with this storage object.
- Signature: public function getKeys()
- Returns: array
getPrefix()
Return the APC prefix for storing variables.
- Signature: public function getPrefix($type)
- Parameters:
- string $type
The variable type (path/type/value/children)
- string $type
- Returns: string
isAvailable()
Returns true if this storage mechanism is ready to be used. false otherwise.
- Signature: public function isAvailable()
retrieve()
Retrieve the given I2CE_MagicDataNode value and type.
- Signature: public function retrieve($node)
- Parameters:
- I2CE_MagicDataNode $node
- Returns: array
store()
Store the given I2CE_MagicDataNode into APC
- Signature: public function store($node)
- Parameters:
- I2CE_MagicDataNode $node
- Returns: boolean.
True on sucess
Inherited Methods
__construct()
This public method is inherited from I2CE_MagicDataStorage->__construct()
clear()
This public method is inherited from I2CE_MagicDataStorage->clear()
destroy()
This public method is inherited from I2CE_MagicDataStorage->destroy()
getHash()
This public method is inherited from I2CE_MagicDataStorage->getHash()
isAvailable()
This public method is inherited from I2CE_MagicDataStorage->isAvailable()
retrieve()
This public method is inherited from I2CE_MagicDataStorage->retrieve()
store()
This public method is inherited from I2CE_MagicDataStorage->store()
Inherited Variables
$name
Theis protected variable is inherited from I2CE_MagicDataStorage->$name
