Class: I2CE MagicDataStorageAPC: Difference between revisions

From IHRIS Wiki
(Created page with 'This article desrcibes the class '''I2CE_MagicDataStorageAPC'''which extends the class I2CE_MagicDataStorage It is contained in the module [[iH…')
 
No edit summary
Line 42: Line 42:
* [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node
* [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node
==Inherited Variables==
==Inherited Variables==
===$$name===
===$name===
Theis protected variable is inherited from [[Class: I2CE_MagicDataStorage#$$name | I2CE_MagicDataStorage->$$name]]
Theis protected variable is inherited from [[Class: I2CE_MagicDataStorage#$name | I2CE_MagicDataStorage->$name]]




[[Category:Class Documentation]]
[[Category:Class Documentation]]

Revision as of 15:15, 16 October 2009

This article desrcibes the class I2CE_MagicDataStorageAPCwhich extends the class I2CE_MagicDataStorage It is contained in the module I2CE in the package I2CE The class is defined in the file: lib/I2CE_MagicDataStorageAPC.php Configuration class to lookup and save configuration options. @package I2CE @access public

Methods

clear()

Delete all APC keys associated with this storage object.

  • Signature: public function clear()
  • Returns: boolean

destroy()

Erases the given I2CE_MagicDataNode from the storage mechanism @param I2CE_MagicDataNode

  • Signature: public function destroy($node)

Parameters:

  • $node

getKeys()

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

  • Signature: public function getKeys()
  • Returns: array

getPrefix()

Return the APC prefix for storing variables.

  • Signature: public function getPrefix($type)
  • Returns: string

Parameters:

  • string $type
    The variable type (path/type/value/children)

isAvailable()

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

  • Signature: public function isAvailable()

retrieve()

Retrieve the given I2CE_MagicDataNode value and type.

  • Signature: public function retrieve($node)
  • Returns: array

Parameters:

store()

Store the given I2CE_MagicDataNode into APC

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

Parameters:

Inherited Variables

$name

Theis protected variable is inherited from I2CE_MagicDataStorage->$name