Class: I2CE MagicDataStorageDB: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 12: | Line 12: | ||
===__construct()=== | ===__construct()=== | ||
*Signature: public function __construct($name) | *Signature: public function __construct($name) | ||
Parameters: | *Parameters: | ||
*$name | *$name | ||
===clear()=== | ===clear()=== | ||
| Line 20: | Line 20: | ||
===destroy()=== | ===destroy()=== | ||
*Signature: public function destroy($node) | *Signature: public function destroy($node) | ||
Parameters: | *Parameters: | ||
*$node | *$node | ||
===isAvailable()=== | ===isAvailable()=== | ||
| Line 28: | Line 28: | ||
Retrieve the given I2CE_MagicDataNode value and type. | Retrieve the given I2CE_MagicDataNode value and type. | ||
*Signature: public function retrieve($node) | *Signature: public function retrieve($node) | ||
*Parameters: | |||
** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | |||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ] | *Returns: [http://www.php.net/manual/en/language.types.array.php array ] | ||
===setUpStatements()=== | ===setUpStatements()=== | ||
Set up a cache of prepared statements. | Set up a cache of prepared statements. | ||
| Line 38: | Line 38: | ||
Store the given I2CE_MagicDataNode into the database. | Store the given I2CE_MagicDataNode into the database. | ||
*Signature: public function store($node) | *Signature: public function store($node) | ||
Parameters: | *Parameters: | ||
* [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node | ||
==Inherited Variables== | ==Inherited Variables== | ||
===$name=== | ===$name=== | ||
Revision as of 22:40, 16 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 y $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
