Class: I2CE MagicDataStorageAPC (4.1.4)

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

This article describes the class I2CE_MagicDataStorageAPC .

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

Configuration class to lookup and save configuration options.

Methods

clear()

Delete all APC keys associated with this storage object.

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

destroy()

Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode

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

getKeys()

Return a list of all APC keys associated with this storage object.

• Defined in i2ce/lib/I2CE_MagicDataStorageAPC.php on line 199
• Signature: public function getKeys()
• Returns: array

getPrefix()

Return the APC prefix for storing variables.

• Defined in i2ce/lib/I2CE_MagicDataStorageAPC.php on line 67
• Signature: public function getPrefix($type)
• Parameters:
  • string $type
    The variable type (path/type/value/children)
• Returns: string

isAvailable()

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

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

renameChild()

Renames a child node

• Defined in i2ce/lib/I2CE_MagicDataStorageAPC.php on line 132
• 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_MagicDataStorageAPC.php on line 166
• 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_MagicDataStorageAPC.php on line 106
• Signature: public function retrieve($node)
• Parameters:
  • I2CE_MagicDataNode $node
• Returns: array

store()

Store the given I2CE_MagicDataNode into APC

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

Inherited Methods

__construct()

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

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