Class: I2CE MagicDataStorageDB: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
*Extends the class: [[Class: I2CE_MagicDataStorage | I2CE_MagicDataStorage]]. | *Extends the class: [[Class: I2CE_MagicDataStorage | I2CE_MagicDataStorage]]. | ||
*Location: Part of the module [[I2CE Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE] | *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. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageDB.php#L37 lib/I2CE_MagicDataStorageDB.php] on line 37 | ||
Configuration class to lookup and save configuration options. | Configuration class to lookup and save configuration options. | ||
==Variables== | ==Variables== | ||
===$db_statements=== | ===$db_statements=== | ||
An array of prepared statements for looking up stored magic data. | An array of prepared statements for looking up stored magic data. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageDB.php#L42 i2ce/lib/I2CE_MagicDataStorageDB.php] on line 42 | |||
*Type: private [http://www.php.net/manual/en/language.types.array.php array ] $db_statements | *Type: private [http://www.php.net/manual/en/language.types.array.php array ] $db_statements | ||
==Methods== | ==Methods== | ||
===__construct()=== | ===__construct()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageDB.php#L45 i2ce/lib/I2CE_MagicDataStorageDB.php] on line 45 | |||
*Signature: public function __construct($name) | *Signature: public function __construct($name) | ||
*Parameters: | *Parameters: | ||
| Line 16: | Line 18: | ||
===clear()=== | ===clear()=== | ||
Clear the all keys/values associated with this storage | 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_MagicDataStorageDB.php#L151 i2ce/lib/I2CE_MagicDataStorageDB.php] on line 151 | |||
*Signature: public function clear() | *Signature: public function clear() | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ] | ||
===destroy()=== | ===destroy()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageDB.php#L140 i2ce/lib/I2CE_MagicDataStorageDB.php] on line 140 | |||
*Signature: public function destroy($node) | *Signature: public function destroy($node) | ||
*Parameters: | *Parameters: | ||
| Line 24: | Line 28: | ||
===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. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageDB.php#L124 i2ce/lib/I2CE_MagicDataStorageDB.php] on line 124 | |||
*Signature: public function isAvailable() | *Signature: public function isAvailable() | ||
===retrieve()=== | ===retrieve()=== | ||
Retrieve the given I2CE_MagicDataNode value and type. | 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_MagicDataStorageDB.php#L106 i2ce/lib/I2CE_MagicDataStorageDB.php] on line 106 | |||
*Signature: public function retrieve($node) | *Signature: public function retrieve($node) | ||
*Parameters: | *Parameters: | ||
| Line 33: | Line 39: | ||
===setUpStatements()=== | ===setUpStatements()=== | ||
Set up a cache of prepared statements. | Set up a cache of prepared statements. | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/lib/I2CE_MagicDataStorageDB.php#L54 i2ce/lib/I2CE_MagicDataStorageDB.php] on line 54 | |||
*Signature: protected function setUpStatements() | *Signature: protected function setUpStatements() | ||
*Returns: MDB2_Statement_Common | *Returns: MDB2_Statement_Common | ||
===store()=== | ===store()=== | ||
Store the given I2CE_MagicDataNode into the database. | 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_MagicDataStorageDB.php#L79 i2ce/lib/I2CE_MagicDataStorageDB.php] on line 79 | |||
*Signature: public function store($node) | *Signature: public function store($node) | ||
*Parameters: | *Parameters: | ||
Revision as of 08:51, 10 November 2009
This article describes 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 on line 37
Configuration class to lookup and save configuration options.
Variables
$db_statements
An array of prepared statements for looking up stored magic data.
- Defined in i2ce/lib/I2CE_MagicDataStorageDB.php on line 42
- Type: private array $db_statements
Methods
__construct()
- Defined in i2ce/lib/I2CE_MagicDataStorageDB.php on line 45
- Signature: public function __construct($name)
- Parameters:
- $name
clear()
Clear the all keys/values associated with this storage
- Defined in i2ce/lib/I2CE_MagicDataStorageDB.php on line 151
- Signature: public function clear()
- Returns: boolean
destroy()
- Defined in i2ce/lib/I2CE_MagicDataStorageDB.php on line 140
- Signature: public function destroy($node)
- Parameters:
- $node
isAvailable()
Returns true if this storage mechanism is ready to be used. false otherwise.
- Defined in i2ce/lib/I2CE_MagicDataStorageDB.php on line 124
- Signature: public function isAvailable()
retrieve()
Retrieve the given I2CE_MagicDataNode value and type.
- Defined in i2ce/lib/I2CE_MagicDataStorageDB.php on line 106
- Signature: public function retrieve($node)
- Parameters:
- I2CE_MagicDataNode $node
- Returns: array
setUpStatements()
Set up a cache of prepared statements.
- Defined in i2ce/lib/I2CE_MagicDataStorageDB.php on line 54
- Signature: protected function setUpStatements()
- Returns: MDB2_Statement_Common
store()
Store the given I2CE_MagicDataNode into the database.
- Defined in i2ce/lib/I2CE_MagicDataStorageDB.php on line 79
- Signature: public function store($node)
- Parameters:
- I2CE_MagicDataNode $node
Inherited Methods
getHash()
This public method is inherited from I2CE_MagicDataStorage->getHash()
Inherited Variables
$name
Theis protected variable is inherited from I2CE_MagicDataStorage->$name
