|
|
| (12 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article describes the ''abstract'' class ''I2CE_MagicDataStorage''.
| | #REDIRECT [[Class: I2CE_MagicDataStorage (4.1.7)]] |
| *Child Classes:
| |
| ** [[Class: I2CE_MagicDataStorageAPC | I2CE_MagicDataStorageAPC]]
| |
| ** [[Class: I2CE_MagicDataStorageDB | I2CE_MagicDataStorageDB]]
| |
| ** [[Class: I2CE_MagicDataStorageMem | I2CE_MagicDataStorageMem]]
| |
| ** [[Class: I2CE_MagicDataStorageSysV | I2CE_MagicDataStorageSysV]]
| |
| *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.2-release/annotate/head:/lib/I2CE_MagicDataStorage.php#L30 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 [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
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| 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)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $name <br/>The name assigned to this storage object
| |
| ===clear()===
| |
| 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()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===destroy()===
| |
| 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)
| |
| *Parameters:
| |
| **$node
| |
| ===getHash()===
| |
| 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)
| |
| *Parameters:
| |
| ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===isAvailable()===
| |
| 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()
| |
| ===retrieve()===
| |
| 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)
| |
| *Parameters:
| |
| ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]
| |
| ===store()===
| |
| 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)
| |
| *Parameters:
| |
| ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node
| |
| *Returns: boolean.<br/>True on sucess
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
