Class: I2CE MagicDataStorage (4.1.7)

For other versions, see Class: I2CE_MagicDataStorage (versions) .

This article describes the abstract class I2CE_MagicDataStorage .

• Child Classes:
  • I2CE_MagicDataStorageAPC
  • I2CE_MagicDataStorageDB
  • I2CE_MagicDataStorageDBAlt
  • I2CE_MagicDataStorageMem
  • I2CE_MagicDataStorageMemcached
  • I2CE_MagicDataStorageMongoDB
• Location: Part of the module I2CE in the package I2CE 4.1.7-release
• Source: Defined in the file lib/I2CE_MagicDataStorage.php on line 30

Configuration class to lookup and save configuration options.

Variables

$name

The name associated with this storage object.

• Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 35
• Type: protected string $name

Methods

__construct()

Create a new instance for magic data storage.

• Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 40
• 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

• Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 103
• 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

• Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 61
• Signature: abstract public function destroy($node)
• Parameters:
  • $node

getChildPath()

Return the md5 Hash of the path of this object.

• Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 83
• Signature: public function getChildPath($node,$childPath,$show_top)
• Parameters:
  • I2CE_MagicDataNode $node
  • string $childPath
  • boolean $show_top
    defaults to true if we are to show the parent
    • Default Value: true
• Returns: string

getHash()

Return the md5 Hash of the path of this object.

• Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 69
• Signature: public function getHash($node,$childPath)
• Parameters:
  • I2CE_MagicDataNode $node
  • string $childPath
    Defaults to null
    • Default Value: null
• Returns: string

isAvailable()

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

• Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 109
• Signature: abstract public function isAvailable()

renameChild()

Renames a child node. This is slow

• Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 117
• Signature: abstract public function renameChild($node,$old,$new)
• Parameters:
  • $node
  • string $old
  • string $new
• Returns: boolean.
  True on success, false on failure

retrieve()

Retrieve the given I2CE_MagicDataNode value and type.

• Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 54
• Signature: abstract public function retrieve($node)
• Parameters:
  • I2CE_MagicDataNode $node
• Returns: array

store()

Store the given I2CE_MagicDataNode into the database.

• Defined in i2ce/lib/I2CE_MagicDataStorage.php on line 48
• Signature: abstract public function store($node)
• Parameters:
  • I2CE_MagicDataNode $node
• Returns: boolean.
  True on sucess