Class: I2CE MagicDataStorage: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 1: Line 1:
This article desrcibes the1 class '''I2CE_MagicDataStorage'''.
This article desrcibes the1 class ''I2CE_MagicDataStorage''.
*Location: Part of the module [[iHRIS Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE]
*Location: Part of the module [[iHRIS 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.0-release/annotate/head:/lib/I2CE_MagicDataStorage.php lib/I2CE_MagicDataStorage.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/lib/I2CE_MagicDataStorage.php lib/I2CE_MagicDataStorage.php]
Configuration class to lookup and save configuration options.
Configuration class to lookup and save configuration options.
==Variables==
==Variables==

Revision as of 22:12, 16 October 2009

This article desrcibes the1 class I2CE_MagicDataStorage.

Configuration class to lookup and save configuration options.

Variables

$name

The name associated with this storage object.

  • Type: protected ng $name

Methods

__construct()

Create a new instance for magic data storage.

  • Signature: public function __construct($name)

Parameters:

  • string $name
    The name assigned to this storage object

clear()

Clear the all keys/values associated with this storage

  • Signature: abstract public function clear()
  • Returns: boolean

destroy()

Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode @param boolean. True on sucess

  • Signature: abstract public function destroy($node)

Parameters:

  • $node

getHash()

Return the md5 Hash of the path of this object.

  • Signature: public function getHash($node)
  • Returns: string

Parameters:

isAvailable()

Returns true if this storage mechanism is ready to be used. false otherwise.

  • Signature: abstract public function isAvailable()

retrieve()

Retrieve the given I2CE_MagicDataNode value and type.

  • Signature: abstract public function retrieve($node)
  • Returns: array

Parameters:

store()

Store the given I2CE_MagicDataNode into the database.

  • Signature: abstract public function store($node)
  • Returns: boolean. True on sucess

Parameters: