Class: I2CE MagicDataStorageDB: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
Line 13: | Line 13: | ||
*Signature: public function __construct($name) | *Signature: public function __construct($name) | ||
*Parameters: | *Parameters: | ||
*$name | **$name | ||
===clear()=== | ===clear()=== | ||
Clear the all keys/values associated with this storage | Clear the all keys/values associated with this storage | ||
Line 21: | Line 21: | ||
*Signature: public function destroy($node) | *Signature: public function destroy($node) | ||
*Parameters: | *Parameters: | ||
*$node | **$node | ||
===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. |
Revision as of 12:08, 17 October 2009
This article desrcibes the class I2CE_MagicDataStorageDB.
- Extends the class: I2CE_MagicDataStorage.
- Location: Part of the module I2CE in the package I2CE
- Source: Defined in the file 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 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: 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:
- I2CE_MagicDataNode $node
- Returns: 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:
- I2CE_MagicDataNode $node
Inherited Variables
$name
Theis protected variable is inherited from I2CE_MagicDataStorage->$name