Class: I2CE MagicDataStorage: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 12: | Line 12: | ||
Create a new instance for magic data storage. | Create a new instance for magic data storage. | ||
*Signature: public function __construct($name) | *Signature: public function __construct($name) | ||
Parameters: | *Parameters: | ||
* [http://www.php.net/manual/en/language.types.string.php string ] $name<br/>The name assigned to this storage object | ** [http://www.php.net/manual/en/language.types.string.php string ] $name <br/>The name assigned to this storage object | ||
===clear()=== | ===clear()=== | ||
Clear the all keys/values associated with this storage | Clear the all keys/values associated with this storage | ||
| Line 19: | Line 19: | ||
*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 boolean. True on sucess | ||
@param I2CE_MagicDataNode | |||
@param boolean. True on sucess | |||
*Signature: abstract public function destroy($node) | *Signature: abstract public function destroy($node) | ||
Parameters: | *Parameters: | ||
*$node | *$node | ||
===getHash()=== | ===getHash()=== | ||
Return the md5 Hash of the path of this object. | Return the md5 Hash of the path of this object. | ||
*Signature: public function getHash($node) | *Signature: public function getHash($node) | ||
*Parameters: | |||
** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | |||
*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 37: | Line 35: | ||
Retrieve the given I2CE_MagicDataNode value and type. | Retrieve the given I2CE_MagicDataNode value and type. | ||
*Signature: abstract public function retrieve($node) | *Signature: abstract 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 the database. | Store the given I2CE_MagicDataNode into the database. | ||
*Signature: abstract public function store($node) | *Signature: abstract public function store($node) | ||
* | *Parameters: | ||
Parameters: | ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | ||
* [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | *Returns: boolean.<br/>True on sucess | ||
[[Category:Class Documentation]] | [[Category:Class Documentation]] | ||
Revision as of 22:40, 16 October 2009
This article desrcibes the1 class I2CE_MagicDataStorage.
- Location: Part of the module I2CE in the package I2CE
- Source: Defined in the file lib/I2CE_MagicDataStorage.php
Configuration class to lookup and save configuration options.
Variables
$name
The name associated with this storage object.
- Type: protected ng $name
Methods
__construct()
Create a new instance for magic data storage.
- Signature: public function __construct($name)
- Parameters:
- string $name
The name assigned to this storage object
- string $name
clear()
Clear the all keys/values associated with this storage
- Signature: abstract public function clear()
- Returns: boolean
destroy()
Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode @param boolean. True on sucess
- Signature: abstract public function destroy($node)
- Parameters:
- $node
getHash()
Return the md5 Hash of the path of this object.
- Signature: public function getHash($node)
- Parameters:
- I2CE_MagicDataNode $node
- Returns: string
isAvailable()
Returns true if this storage mechanism is ready to be used. false otherwise.
- Signature: abstract public function isAvailable()
retrieve()
Retrieve the given I2CE_MagicDataNode value and type.
- Signature: abstract public function retrieve($node)
- Parameters:
- I2CE_MagicDataNode $node
- Returns: array
store()
Store the given I2CE_MagicDataNode into the database.
- Signature: abstract public function store($node)
- Parameters:
- I2CE_MagicDataNode $node
- Returns: boolean.
True on sucess
