Class: I2CE MagicDataStorageAPC: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 10: | Line 10: | ||
*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 | Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode | ||
@param I2CE_MagicDataNode | |||
*Signature: public function destroy($node) | *Signature: public function destroy($node) | ||
Parameters: | *Parameters: | ||
*$node | *$node | ||
===getKeys()=== | ===getKeys()=== | ||
| Line 22: | Line 21: | ||
Return the APC prefix for storing variables. | Return the APC prefix for storing variables. | ||
*Signature: public function getPrefix($type) | *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 ] | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] | ||
===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. | ||
| Line 31: | Line 30: | ||
Retrieve the given I2CE_MagicDataNode value and type. | Retrieve the given I2CE_MagicDataNode value and type. | ||
*Signature: public function retrieve($node) | *Signature: public function retrieve($node) | ||
*Parameters: | |||
** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | |||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ] | *Returns: [http://www.php.net/manual/en/language.types.array.php array ] | ||
===store()=== | ===store()=== | ||
Store the given I2CE_MagicDataNode into APC | Store the given I2CE_MagicDataNode into APC | ||
*Signature: public function store($node) | *Signature: public function store($node) | ||
* | *Parameters: | ||
Parameters: | ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | ||
* [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | *Returns: boolean.<br/>True on sucess | ||
==Inherited Variables== | ==Inherited Variables== | ||
===$name=== | ===$name=== | ||
Revision as of 22:40, 16 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 Variables
$name
Theis protected variable is inherited from I2CE_MagicDataStorage->$name
