|
|
| (26 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class '''I2CE_MagicData''' which extends the class [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]]
| | #REDIRECT [[Class: I2CE_MagicData (4.1.7)]] |
| It is contained in the module [[iHRIS Module List#I2CE|I2CE]] in the package [https://launchpad.net/i2ce I2CE]
| |
| | |
| The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/lib/I2CE_MagicData.php lib/I2CE_MagicData.php]
| |
| | |
| Configuration class to lookup and save configuration options.
| |
| ==Variables==
| |
| ===$instances===
| |
| A list of named instances of this class.
| |
| *Type: static protected y $instances
| |
| | |
| ===$last_instance===
| |
| The index of the last accessed stored instance of this class
| |
| *Type: static protected ng $last_instance
| |
| | |
| ===$instance===
| |
| The instance index for this configuration grouping.
| |
| *Type: protected ng $instance
| |
| | |
| ===$storage===
| |
| A list of storage objects to use to store and retrieve values.
| |
| Values will be saved using all storage objects and retrieved
| |
| until a match is found in the order the objects are assigned.
| |
| *Type: protected y $storage
| |
| | |
| ===$num_storage===
| |
| *Type: protected $num_storage
| |
| | |
| ===$locales===
| |
| *Type: protected $locales
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| Construct a new configuration value or grouping.
| |
| *Signature: protected function __construct($name,$parent,$check_key)
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $name<br/>The name of this configuration setting.
| |
| **Default Value: null
| |
| * [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $parent<br/>The parent of this configuration setting.
| |
| **Default Value: null
| |
| * [http://www.php.net/manual/en/language.types.boolean.php boolean] $check_key<br/>Defaults to true in which case we check that the key is valid.
| |
| **Default Value: true
| |
| ===addStorage()===
| |
| Add the given storage object to this instance.
| |
| The last one added is considered to be the "definitive" one -- the one whose contents
| |
| should be considered correct. The first one added should be the one which has quickest
| |
| access
| |
| *Signature: public function addStorage($storage)
| |
| Parameters:
| |
| * [[Class: I2CE_MagicDataStorage | I2CE_MagicDataStorage]] $storage
| |
| ===clearCache()===
| |
| Clear caching for each of the storage mechanisms
| |
| @param I2CE_MagicDataNode $node. The node we wish to remove from the cache. If null ( default) we call the clear() method
| |
| for all but the last added storage mecahnism. If non-null, we call the destory() method for the node on all but the last
| |
| storage mechanism.
| |
| *Signature: public function clearCache()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean]
| |
| ===destroy()===
| |
| Destroy the specified node from each of the storage mechanisms
| |
| *Signature: public function destroy($node)
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] true on success
| |
| Parameters:
| |
| *$node
| |
| ===getPath()===
| |
| Return the full path to this configuration setting.
| |
| *Signature: public function getPath($show_top)
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string]
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.boolean.php boolean] $show_top<br/>defaults to true if we are to show the parent
| |
| **Default Value: true
| |
| ===getPermanentStorageClass()===
| |
| Gets the class of the permanent storage object (the last one added)
| |
| *Signature: public function getPermanentStorageClass()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string]
| |
| ===instance()===
| |
| Return an instance of this class based on the index given.
| |
| This will create the instance if it doesn't exist.
| |
| | |
| $index is non null, then we create a new instance at $index.
| |
| *Signature: static public function instance($index,$replace)
| |
| *Returns: [[Class: I2CE_MagicData | I2CE_MagicData]]
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.string.php string] $index
| |
| **Default Value: NULL
| |
| * [http://www.php.net/manual/en/language.types.boolean.php boolean] $replace<br/>Defaults to false. If true and
| |
| **Default Value: FALSE
| |
| ===pathDivider()===
| |
| Return the path divider for this MagicDataNode object
| |
| *Signature: protected function pathDivider()
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string]
| |
| ===retrieve()===
| |
| Retrieve the given magic data node (which should be a
| |
| descendent of this instance.)
| |
| *Signature: public function retrieve($node)
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array]
| |
| Parameters:
| |
| * [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node
| |
| ===setLocales()===
| |
| *Signature: public function setLocales($locales)
| |
| Parameters:
| |
| *$locales
| |
| ===store()===
| |
| Store the given magic data node (which should be a descendent
| |
| of this instance.) Starts storing at the last added storage
| |
| mechanism until it reaches the first storage mechanism. If it
| |
| fails saving at any storage mechanis, it will call the destroy
| |
| method on that storage mechanism and any remaining one.
| |
| | |
| Defaults to -1 meaning we store on all
| |
| mechanisms
| |
| *Signature: public function store($node,$max)
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] true on success.
| |
| Parameters:
| |
| * [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $node
| |
| * integer $max<br/>The max index of storage objects to save.
| |
| **Default Value: -1
| |
| ===tearDown()===
| |
| Clean up all MagicData instances. Normally, this should not be
| |
| used. Primarily for unit testing.
| |
| *Signature: static public function tearDown()
| |
| ==Inherited Variables==
| |
| ===$type===
| |
| Theis protected variable is inherited from [[Class: I2CE_MagicDataNode#$type | I2CE_MagicDataNode->$type]]
| |
| | |
| ===$name===
| |
| Theis protected variable is inherited from [[Class: I2CE_MagicDataNode#$name | I2CE_MagicDataNode->$name]]
| |
| | |
| ===$value===
| |
| Theis protected variable is inherited from [[Class: I2CE_MagicDataNode#$value | I2CE_MagicDataNode->$value]]
| |
| | |
| ===$children===
| |
| Theis protected variable is inherited from [[Class: I2CE_MagicDataNode#$children | I2CE_MagicDataNode->$children]]
| |
| | |
| ===$parent===
| |
| Theis protected variable is inherited from [[Class: I2CE_MagicDataNode#$parent | I2CE_MagicDataNode->$parent]]
| |
| | |
| ===$parentPath===
| |
| Theis protected variable is inherited from [[Class: I2CE_MagicDataNode#$parentPath | I2CE_MagicDataNode->$parentPath]]
| |
| | |
| ===$parentPathTop===
| |
| Theis protected variable is inherited from [[Class: I2CE_MagicDataNode#$parentPathTop | I2CE_MagicDataNode->$parentPathTop]]
| |
| | |
| ===$top===
| |
| Theis protected variable is inherited from [[Class: I2CE_MagicDataNode#$top | I2CE_MagicDataNode->$top]]
| |
| | |
| ===$volatile===
| |
| Theis protected variable is inherited from [[Class: I2CE_MagicDataNode#$volatile | I2CE_MagicDataNode->$volatile]]
| |
| | |
| ===$attributes===
| |
| Theis protected variable is inherited from [[Class: I2CE_MagicDataNode#$attributes | I2CE_MagicDataNode->$attributes]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
