|
|
| (20 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class ''I2CE_MagicDataStorageDB''.
| | #REDIRECT [[Class: I2CE_MagicDataStorageDB (4.1.7)]] |
| *Extends the class: [[Class: I2CE_MagicDataStorage | I2CE_MagicDataStorage]].
| |
| *Location: Part of the module [[iHRIS 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.0-release/annotate/head:/lib/I2CE_MagicDataStorageDB.php lib/I2CE_MagicDataStorageDB.php]
| |
| Configuration class to lookup and save configuration options.
| |
| ==Variables==
| |
| ===$db_statements===
| |
| An array of prepared statements for looking up stored magic data.
| |
| *Type: private [http://www.php.net/manual/en/language.types.array.php array ] $db_statements
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| *Signature: public function __construct($name)
| |
| *Parameters:
| |
| **$name
| |
| ===clear()===
| |
| Clear the all keys/values associated with this storage
| |
| *Signature: public function clear()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===destroy()===
| |
| *Signature: public function destroy($node)
| |
| *Parameters:
| |
| **$node
| |
| ===isAvailable()===
| |
| Returns true if this storage mechanism is ready to be used. false otherwise.
| |
| *Signature: public function isAvailable()
| |
| ===retrieve()===
| |
| Retrieve the given I2CE_MagicDataNode value and type.
| |
| *Signature: public function retrieve($node)
| |
| *Parameters:
| |
| ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]
| |
| ===setUpStatements()===
| |
| Set up a cache of prepared statements.
| |
| *Signature: protected function setUpStatements()
| |
| *Returns: MDB2_Statement_Common
| |
| ===store()===
| |
| Store the given I2CE_MagicDataNode into the database.
| |
| *Signature: public function store($node)
| |
| *Parameters:
| |
| ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node
| |
| ==Inherited Variables==
| |
| ===$name===
| |
| Theis protected variable is inherited from [[Class: I2CE_MagicDataStorage#$name | I2CE_MagicDataStorage->$name]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
