Class: I2CE MagicDataStorageMemcached (Development)

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

This article describes the class I2CE_MagicDataStorageMemcached .

• Extends the class: I2CE_MagicDataStorage.
• Location: Part of the module I2CE in the package I2CE 4.1-dev
• Source: Defined in the file lib/I2CE_MagicDataStorageMemcached.php on line 34

Configuration class to lookup and save configuration options.

Variables

$memcached

@protected var Memcached $memcached. The memcached instance

• Defined in i2ce/lib/I2CE_MagicDataStorageMemcached.php on line 41
• Type: protected $memcached

Methods

__construct()

Create a new instance for magic data storage.

• Defined in i2ce/lib/I2CE_MagicDataStorageMemcached.php on line 47
• Signature: public function __construct($name)
• Parameters:
  • string $name
    The name assigned to this storage object

clear()

Delete all APC keys associated with this storage object.

• Defined in i2ce/lib/I2CE_MagicDataStorageMemcached.php on line 224
• Signature: public function clear()
• Returns: boolean

destroy()

Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode

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

getKey()

Return the APC prefix for storing variables. @param string $type The variable type (path/type/value/children)

• Defined in i2ce/lib/I2CE_MagicDataStorageMemcached.php on line 82
• Signature: public function getKey($node,$childPath)
• Parameters:
  • $node
  • $childPath
    • Default Value: null
• Returns: string

isAvailable()

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

• Defined in i2ce/lib/I2CE_MagicDataStorageMemcached.php on line 60
• Signature: public function isAvailable()

renameChild()

Renames a child node

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

renameDecendents()

Rename the descenedent children for which we need to rename its paths

• Defined in i2ce/lib/I2CE_MagicDataStorageMemcached.php on line 160
• Signature: protected function renameDecendents($node,$children)
• Parameters:
  • I2CE_MagicDataNode $node
  • array $children
    an array of child paths we need to rename its path

retrieve()

Retrieve the given I2CE_MagicDataNode value and type.

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

store()

Store the given I2CE_MagicDataNode into APC

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

Inherited Methods

getChildPath()

This public method is inherited from I2CE_MagicDataStorage->getChildPath()

getHash()

This public method is inherited from I2CE_MagicDataStorage->getHash()

Inherited Variables

$name

Theis protected variable is inherited from I2CE_MagicDataStorage->$name