Class: I2CE MagicDataStorageMongoDB (4.1.7)

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

This article describes the class I2CE_MagicDataStorageMongoDB .

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

Variables

$m

, mongodb connection

• Defined in i2ce/lib/I2CE_MagicDataStorageMongoDB.php on line 39
• Type: protected $m

$mdb

@var protected $m, mongodb

• Defined in i2ce/lib/I2CE_MagicDataStorageMongoDB.php on line 43
• Type: protected $mdb

Methods

__construct()

Create a new instance for magic data storage.

• Defined in i2ce/lib/I2CE_MagicDataStorageMongoDB.php on line 50
• 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_MagicDataStorageMongoDB.php on line 125
• Signature: 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_MagicDataStorageMongoDB.php on line 202
• Signature: public function destroy($node)
• Parameters:
  • $node

isAvailable()

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

renameChild()

Renames a child node

• Defined in i2ce/lib/I2CE_MagicDataStorageMongoDB.php on line 238
• 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_MagicDataStorageMongoDB.php on line 263
• 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_MagicDataStorageMongoDB.php on line 217
• Signature: public function retrieve($node)
• Parameters:
  • I2CE_MagicDataNode $node
• Returns: array

setupIndices()

Setup the indices of a config collection @param MongoCollection

• Defined in i2ce/lib/I2CE_MagicDataStorageMongoDB.php on line 144
• Signature: static public function setupIndices($mcoll)
• Parameters:
  • $mcoll

store()

Store the given I2CE_MagicDataNode into mongodb

• Defined in i2ce/lib/I2CE_MagicDataStorageMongoDB.php on line 163
• Signature: public function store($node)
• Parameters:
  • I2CE_MagicDataNode $node

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