Class: I2CE MagicDataStorageDB: Difference between revisions
No edit summary |
No edit summary |
||
Line 40: | Line 40: | ||
*Parameters: | *Parameters: | ||
** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | ||
==Inherited Methods== | |||
===__construct()=== | |||
This public method is inherited from [[Class: I2CE_MagicDataStorage#__construct() | I2CE_MagicDataStorage->__construct()]] | |||
===clear()=== | |||
This public method is inherited from [[Class: I2CE_MagicDataStorage#clear() | I2CE_MagicDataStorage->clear()]] | |||
===destroy()=== | |||
This public method is inherited from [[Class: I2CE_MagicDataStorage#destroy() | I2CE_MagicDataStorage->destroy()]] | |||
===getHash()=== | |||
This public method is inherited from [[Class: I2CE_MagicDataStorage#getHash() | I2CE_MagicDataStorage->getHash()]] | |||
===isAvailable()=== | |||
This public method is inherited from [[Class: I2CE_MagicDataStorage#isAvailable() | I2CE_MagicDataStorage->isAvailable()]] | |||
===retrieve()=== | |||
This public method is inherited from [[Class: I2CE_MagicDataStorage#retrieve() | I2CE_MagicDataStorage->retrieve()]] | |||
===store()=== | |||
This public method is inherited from [[Class: I2CE_MagicDataStorage#store() | I2CE_MagicDataStorage->store()]] | |||
==Inherited Variables== | ==Inherited Variables== | ||
===$name=== | ===$name=== |
Revision as of 13:01, 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 Methods
__construct()
This public method is inherited from I2CE_MagicDataStorage->__construct()
clear()
This public method is inherited from I2CE_MagicDataStorage->clear()
destroy()
This public method is inherited from I2CE_MagicDataStorage->destroy()
getHash()
This public method is inherited from I2CE_MagicDataStorage->getHash()
isAvailable()
This public method is inherited from I2CE_MagicDataStorage->isAvailable()
retrieve()
This public method is inherited from I2CE_MagicDataStorage->retrieve()
store()
This public method is inherited from I2CE_MagicDataStorage->store()
Inherited Variables
$name
Theis protected variable is inherited from I2CE_MagicDataStorage->$name