| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Part of the Joomla Framework Registry Package
| Copyright: | Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved. |
| License: | GNU General Public License version 2 or later; see LICENSE |
| File Size: | 861 lines (18 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Registry:: (29 methods):
__construct()
__clone()
__toString()
count()
jsonSerialize()
def()
exists()
get()
getIterator()
loadArray()
loadObject()
loadFile()
loadString()
merge()
extract()
offsetExists()
offsetGet()
offsetSet()
offsetUnset()
set()
append()
remove()
toArray()
toObject()
toString()
bindData()
asArray()
flatten()
toFlatten()
| __construct($data = null) X-Ref |
| Constructor param: mixed $data The data to bind to the new Registry object. |
| __clone() X-Ref |
| Magic function to clone the registry object. return: void |
| __toString() X-Ref |
| Magic function to render this object as a string using default args of toString method. return: string |
| count() X-Ref |
| Count elements of the data object return: integer The custom count as an integer. |
| jsonSerialize() X-Ref |
| Implementation for the JsonSerializable interface. Allows us to pass Registry objects to json_encode. return: object |
| def($key, $default = '') X-Ref |
| Sets a default value if not already assigned. param: string $key The name of the parameter. param: mixed $default An optional value for the parameter. return: mixed The value set, or the default if the value was not previously set (or null). |
| exists($path) X-Ref |
| Check if a registry path exists. param: string $path Registry path (e.g. joomla.content.showauthor) return: boolean |
| get($path, $default = null) X-Ref |
| Get a registry value. param: string $path Registry path (e.g. joomla.content.showauthor) param: mixed $default Optional default value, returned if the internal value is null. return: mixed Value of entry or null |
| getIterator() X-Ref |
| Gets this object represented as an ArrayIterator. This allows the data properties to be accessed via a foreach statement. return: \ArrayIterator This object represented as an ArrayIterator. |
| loadArray(array $array, $flattened = false, $separator = null) X-Ref |
| Load an associative array of values into the default namespace param: array $array Associative array of value to load param: boolean $flattened Load from a one-dimensional array param: string $separator The key separator return: $this |
| loadObject($object) X-Ref |
| Load the public variables of the object into the default namespace. param: object $object The object holding the publics to load return: $this |
| loadFile($file, $format = 'JSON', array $options = []) X-Ref |
| Load the contents of a file into the registry param: string $file Path to file to load param: string $format Format of the file [optional: defaults to JSON] param: array $options Options used by the formatter return: $this |
| loadString($data, $format = 'JSON', array $options = []) X-Ref |
| Load a string into the registry param: string $data String to load into the registry param: string $format Format of the string param: array $options Options used by the formatter return: $this |
| merge(Registry $source, $recursive = false) X-Ref |
| Merge a Registry object into this one param: Registry $source Source Registry object to merge. param: boolean $recursive True to support recursive merge the children values. return: $this |
| extract($path) X-Ref |
| Method to extract a sub-registry from path param: string $path Registry path (e.g. joomla.content.showauthor) return: Registry Registry object (empty if no data is present) |
| offsetExists($offset) X-Ref |
| Checks whether an offset exists in the iterator. param: mixed $offset The array offset. return: boolean True if the offset exists, false otherwise. |
| offsetGet($offset) X-Ref |
| Gets an offset in the iterator. param: mixed $offset The array offset. return: mixed The array value if it exists, null otherwise. |
| offsetSet($offset, $value) X-Ref |
| Sets an offset in the iterator. param: mixed $offset The array offset. param: mixed $value The array value. return: void |
| offsetUnset($offset) X-Ref |
| Unsets an offset in the iterator. param: mixed $offset The array offset. return: void |
| set($path, $value, $separator = null) X-Ref |
| Set a registry value. param: string $path Registry Path (e.g. joomla.content.showauthor) param: mixed $value Value of entry param: string $separator The key separator return: mixed The value of the that has been set. |
| append($path, $value) X-Ref |
| Append value to a path in registry param: string $path Parent registry Path (e.g. joomla.content.showauthor) param: mixed $value Value of entry return: mixed The value of the that has been set. |
| remove($path) X-Ref |
| Delete a registry value param: string $path Registry Path (e.g. joomla.content.showauthor) return: mixed The value of the removed node or null if not set |
| toArray() X-Ref |
| Transforms a namespace to an array return: array An associative array holding the namespace data |
| toObject() X-Ref |
| Transforms a namespace to an object return: object An an object holding the namespace data |
| toString($format = 'JSON', array $options = []) X-Ref |
| Get a namespace in a given string format param: string $format Format to return the string in param: array $options Parameters used by the formatter, see formatters for more info return: string Namespace in string format |
| bindData($parent, $data, $recursive = true, $allowNull = true) X-Ref |
| Method to recursively bind data to a parent object. param: object $parent The parent object on which to attach the data values. param: mixed $data An array or object of data to bind to the parent object. param: boolean $recursive True to support recursive bindData. param: boolean $allowNull True to allow null values. return: void |
| asArray($data) X-Ref |
| Method to recursively convert an object of data to an array. param: object $data An object of data to return as an array. return: array Array representation of the input object. |
| flatten($separator = null) X-Ref |
| Dump to one dimension array. param: string $separator The key separator. return: string[] Dumped array. |
| toFlatten($separator = null, $data = null, array &$array = [], $prefix = '') X-Ref |
| Method to recursively convert data to one dimension array. param: string $separator The key separator. param: array|object $data Data source of this scope. param: array $array The result array, it is passed by reference. param: string $prefix Last level key prefix. return: void |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |