Class: I2CE MagicDataStorageDB

From IHRIS Wiki
Revision as of 21:25, 16 October 2009 by Litlfred (talk | contribs)

This article desrcibes the class I2CE_MagicDataStorageDB.

It is contained in the module I2CE in the package I2CE

The class is 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)
  • Returns: array

Parameters:

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:

Inherited Variables

$name

Theis protected variable is inherited from I2CE_MagicDataStorage->$name