Class: I2CE MagicDataStorage (Development): Difference between revisions
From IHRIS Wiki
(Created page with '{{otherversions|Class: I2CE_MagicDataStorage}} This article describes the ''abstract'' class ''I2CE_MagicDataStorage'' . *Child Classes: ** [[Class: I2CE_MagicDataStorageAPC (Dev…') |
No edit summary |
||
| Line 7: | Line 7: | ||
** [[Class: I2CE_MagicDataStorageMem (Development) | I2CE_MagicDataStorageMem]] | ** [[Class: I2CE_MagicDataStorageMem (Development) | I2CE_MagicDataStorageMem]] | ||
** [[Class: I2CE_MagicDataStorageMemcached (Development) | I2CE_MagicDataStorageMemcached]] | ** [[Class: I2CE_MagicDataStorageMemcached (Development) | I2CE_MagicDataStorageMemcached]] | ||
** [[Class: | ** [[Class: I2CE_MagicDataStorageMongoDB (Development) | I2CE_MagicDataStorageMongoDB]] | ||
*Location: Part of the module [[I2CE Module List (Development)#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev | *Location: Part of the module [[I2CE Module List (Development)#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] 4.0-dev | ||
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_MagicDataStorage.php#L30 lib/I2CE_MagicDataStorage.php] on line 30 | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0-dev/annotate/head:/lib/I2CE_MagicDataStorage.php#L30 lib/I2CE_MagicDataStorage.php] on line 30 | ||
Revision as of 07:53, 27 May 2010
For other versions, see Class: I2CE_MagicDataStorage (versions) .
This article describes the abstract class I2CE_MagicDataStorage .
- Child Classes:
- Location: Part of the module I2CE in the package I2CE 4.0-dev
- 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
