Class: I2CE MagicDataStorage: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 6: | Line 6: | ||
** [[Class: I2CE_MagicDataStorageSysV | I2CE_MagicDataStorageSysV]] | ** [[Class: I2CE_MagicDataStorageSysV | I2CE_MagicDataStorageSysV]] | ||
*Location: Part of the module [[I2CE Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] | *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. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorage.php#L30 lib/I2CE_MagicDataStorage.php] on line 30 | ||
Configuration class to lookup and save configuration options. | Configuration class to lookup and save configuration options. | ||
==Variables== | ==Variables== | ||
===$name=== | ===$name=== | ||
The name associated with this storage object. | The name associated with this storage object. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorage.php#L35 i2ce/lib/I2CE_MagicDataStorage.php] on line 35 | |||
*Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $name | *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $name | ||
| Line 16: | Line 17: | ||
===__construct()=== | ===__construct()=== | ||
Create a new instance for magic data storage. | Create a new instance for magic data storage. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorage.php#L40 i2ce/lib/I2CE_MagicDataStorage.php] on line 40 | |||
*Signature: public function __construct($name) | *Signature: public function __construct($name) | ||
*Parameters: | *Parameters: | ||
| Line 21: | Line 23: | ||
===clear()=== | ===clear()=== | ||
Clear the all keys/values associated with this storage | Clear the all keys/values associated with this storage | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorage.php#L76 i2ce/lib/I2CE_MagicDataStorage.php] on line 76 | |||
*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 @param I2CE_MagicDataNode @param boolean. True on sucess | Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode @param boolean. True on sucess | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorage.php#L61 i2ce/lib/I2CE_MagicDataStorage.php] on line 61 | |||
*Signature: abstract public function destroy($node) | *Signature: abstract public function destroy($node) | ||
*Parameters: | *Parameters: | ||
| Line 30: | Line 34: | ||
===getHash()=== | ===getHash()=== | ||
Return the md5 Hash of the path of this object. | Return the md5 Hash of the path of this object. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorage.php#L68 i2ce/lib/I2CE_MagicDataStorage.php] on line 68 | |||
*Signature: public function getHash($node) | *Signature: public function getHash($node) | ||
*Parameters: | *Parameters: | ||
| Line 36: | Line 41: | ||
===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. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorage.php#L82 i2ce/lib/I2CE_MagicDataStorage.php] on line 82 | |||
*Signature: abstract public function isAvailable() | *Signature: abstract public function isAvailable() | ||
===retrieve()=== | ===retrieve()=== | ||
Retrieve the given I2CE_MagicDataNode value and type. | 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_MagicDataStorage.php#L54 i2ce/lib/I2CE_MagicDataStorage.php] on line 54 | |||
*Signature: abstract public function retrieve($node) | *Signature: abstract public function retrieve($node) | ||
*Parameters: | *Parameters: | ||
| Line 45: | Line 52: | ||
===store()=== | ===store()=== | ||
Store the given I2CE_MagicDataNode into the database. | Store the given I2CE_MagicDataNode into the database. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorage.php#L48 i2ce/lib/I2CE_MagicDataStorage.php] on line 48 | |||
*Signature: abstract public function store($node) | *Signature: abstract public function store($node) | ||
*Parameters: | *Parameters: | ||
Revision as of 08:51, 10 November 2009
This article describes the abstract class I2CE_MagicDataStorage.
- Child Classes:
- Location: Part of the module I2CE in the package I2CE
- Source: Defined in the file lib/I2CE_MagicDataStorage.php on line 30
Configuration class to lookup and save configuration options.
Variables
$name
The name associated with this storage object.
- Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 35
- Type: protected string $name
Methods
__construct()
Create a new instance for magic data storage.
- Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 40
- 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
- Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 76
- 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
- Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 61
- Signature: abstract public function destroy($node)
- Parameters:
- $node
getHash()
Return the md5 Hash of the path of this object.
- Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 68
- 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.
- Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 82
- Signature: abstract public function isAvailable()
retrieve()
Retrieve the given I2CE_MagicDataNode value and type.
- Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 54
- Signature: abstract public function retrieve($node)
- Parameters:
- I2CE_MagicDataNode $node
- Returns: array
store()
Store the given I2CE_MagicDataNode into the database.
- Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 48
- Signature: abstract public function store($node)
- Parameters:
- I2CE_MagicDataNode $node
- Returns: boolean.
True on sucess
