Class: I2CE MagicDataStorage

This article desrcibes the1 class I2CE_MagicDataStorage.

• Location: Part of the module I2CE in the package I2CE
• Source: Defined in the file lib/I2CE_MagicDataStorage.php

Configuration class to lookup and save configuration options.

Variables

$name

The name associated with this storage object.

• Type: protected string $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)
• Parameters:
  • I2CE_MagicDataNode $node
• Returns: string

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)
• Parameters:
  • I2CE_MagicDataNode $node
• Returns: array

store()

Store the given I2CE_MagicDataNode into the database.

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