Class: I2CE MagicDataStorage: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
This article desrcibes the1 class '''I2CE_MagicDataStorage''' | This article desrcibes the1 class '''I2CE_MagicDataStorage'''. | ||
It is contained in the module [[iHRIS Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] | It is contained in the module [[iHRIS Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] | ||
| Line 15: | Line 15: | ||
*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 | ||
*Signature: abstract public function clear() | *Signature: abstract 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 | Erases the given I2CE_MagicDataNode from the storage mechanism | ||
| Line 30: | Line 30: | ||
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) | ||
*Returns: [http://www.php.net/manual/en/language.types.string.php string] | *Returns: [http://www.php.net/manual/en/language.types.string.php string ] | ||
Parameters: | Parameters: | ||
* [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | * [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | ||
| Line 39: | Line 39: | ||
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) | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array] | *Returns: [http://www.php.net/manual/en/language.types.array.php array ] | ||
Parameters: | Parameters: | ||
* [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | * [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | ||
Revision as of 21:25, 16 October 2009
This article desrcibes the1 class I2CE_MagicDataStorage. It is contained in the module I2CE in the package I2CE
The class is 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
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)
- Returns: string
Parameters:
- I2CE_MagicDataNode $node
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)
- Returns: array
Parameters:
- I2CE_MagicDataNode $node
store()
Store the given I2CE_MagicDataNode into the database.
- Signature: abstract public function store($node)
- Returns: boolean. True on sucess
Parameters:
- I2CE_MagicDataNode $node
