Joomla! API

since	1.0
package	Joomla Framework

Magic function to clone the registry object.

__clone() : void

inherited

since	1.0.0

Constructor

__construct(mixed data = null, string separator = '.') : mixed

inherited

since	1.0.0

Arguments

data: mixedThe data to bind to the new Registry object.
separator: stringThe path separator, and empty string will flatten the registry.

Response

mixed

Magic method to access separator property.

__get(string name) : string|null

inherited deprecated

since
deprecated	3.0 This is a B/C proxy for deprecated read accesses

Arguments

name: stringThe name of the property.

Response

string|nullA value if the property name is valid, null otherwise.

Magic method to access separator property.

__set(string name, mixed value) : void

inherited deprecated

since
deprecated	3.0 This is a B/C proxy for deprecated read accesses

Arguments

name: stringThe name of the property.
value: mixedThe value of the property.

Magic function to render this object as a string using default args of toString method.

__toString() : string

inherited

since	1.0.0

Response

string

Append value to a path in registry

append(string path, mixed value) : mixed

inherited

since	1.4.0

Arguments

path: stringParent registry Path (e.g. joomla.content.showauthor)
value: mixedValue of entry

Response

mixedThe value of the that has been set.

Method to recursively convert an object of data to an array.

asArray(object data) : array

inherited

since	1.0.0

Arguments

data: objectAn object of data to return as an array.

Response

arrayArray representation of the input object.

Method to recursively bind data to a parent object.

bindData(object parent, mixed data, bool recursive = true, bool allowNull = true) : void

inherited

since	1.0.0

Arguments

parent: objectThe parent object on which to attach the data values.
data: mixedAn array or object of data to bind to the parent object.
recursive: boolTrue to support recursive bindData.
allowNull: boolTrue to allow null values.

Count elements of the data object

count() : int

inherited

link
since	1.3.0

Response

intThe custom count as an integer.

Sets a default value if not already assigned.

def(string key, mixed default = '') : mixed

inherited

since	1.0.0

Arguments

key: stringThe name of the parameter.
default: mixedAn optional value for the parameter.

Response

mixedThe value set, or the default if the value was not previously set (or null).

Check if a registry path exists.

exists(string path) : bool

inherited

since	1.0.0

Arguments

path: stringRegistry path (e.g. joomla.content.showauthor)

Response

bool

Method to extract a sub-registry from path

extract(string path) : \Joomla\Registry\Registry

inherited

since	1.2.0 2.0.0

since

1.2.0

2.0.0

Arguments

path: stringRegistry path (e.g. joomla.content.showauthor)

Response

\Joomla\Registry\RegistryRegistry object (empty if no data is present)

Dump to one dimension array.

flatten(string separator = null) : string[]

inherited

since	1.3.0

Arguments

separator: stringThe key separator.

Response

string[]Dumped array.

Get a registry value.

get(string path, mixed default = null) : mixed

inherited

since	1.0.0

Arguments

path: stringRegistry path (e.g. joomla.content.showauthor)
default: mixedOptional default value, returned if the internal value is null.

Response

mixedValue of entry or null

Gets this object represented as an ArrayIterator.

getIterator() : \ArrayIterator

inherited

This allows the data properties to be accessed via a foreach statement.

see	IteratorAggregate::getIterator()
since	1.3.0

Response

\ArrayIteratorThis object represented as an ArrayIterator.

Implementation for the JsonSerializable interface.

jsonSerialize() : object

inherited

Allows us to pass Registry objects to json_encode.

since	1.0.0
note	The interface is only present in PHP 5.4 and up.

Response

object

Load an associative array of values into the default namespace

loadArray(array array, bool flattened = false, string separator = null) : $this

inherited

since	1.0.0 2.0.0

since

1.0.0

2.0.0

Arguments

array: arrayAssociative array of value to load
flattened: boolLoad from a one-dimensional array
separator: stringThe key separator

Response

$this

Load the contents of a file into the registry

loadFile(string file, string format = 'JSON', array options = []) : $this

inherited

since	1.0.0 2.0.0

since

1.0.0

2.0.0

Arguments

file: stringPath to file to load
format: stringFormat of the file [optional: defaults to JSON]
options: arrayOptions used by the formatter

Response

$this

Load a keychain file into this object.

loadKeychain(string keychainFile) : $this

since

since	1.0
throws	`\RuntimeException`if the keychain file does not exist `\Joomla\Crypt\Exception\CryptExceptionInterface`if the keychain cannot be decrypted

1.0

throws

\RuntimeExceptionif the keychain file does not exist

\Joomla\Crypt\Exception\CryptExceptionInterfaceif the keychain cannot be decrypted

Arguments

keychainFile: stringPath to the keychain file.

Response

$this

Load the public variables of the object into the default namespace.

loadObject(object object) : $this

inherited

since	1.0.0

Arguments

object: objectThe object holding the publics to load

Response

$this

Load a string into the registry

loadString(string data, string format = 'JSON', array options = []) : $this

inherited

since	1.0.0 2.0.0

since

1.0.0

2.0.0

Arguments

data: stringString to load into the registry
format: stringFormat of the string
options: arrayOptions used by the formatter

Response

$this

Merge a Registry object into this one

merge(\Joomla\Registry\Registry source, bool recursive = false) : $this

inherited

since	1.0.0 2.0.0

since

1.0.0

2.0.0

Arguments

source: \Joomla\Registry\RegistrySource Registry object to merge.
recursive: boolTrue to support recursive merge the children values.

Response

$this

Checks whether an offset exists in the iterator.

offsetExists(mixed offset) : bool

inherited

since	1.0.0

Arguments

offset: mixedThe array offset.

Response

boolTrue if the offset exists, false otherwise.

Gets an offset in the iterator.

offsetGet(mixed offset) : mixed

inherited

since	1.0.0

Arguments

offset: mixedThe array offset.

Response

mixedThe array value if it exists, null otherwise.

Sets an offset in the iterator.

offsetSet(mixed offset, mixed value) : void

inherited

since	1.0.0

Arguments

offset: mixedThe array offset.
value: mixedThe array value.

Unsets an offset in the iterator.

offsetUnset(mixed offset) : void

inherited

since	1.0.0

Arguments

offset: mixedThe array offset.

Delete a registry value

remove(string path) : mixed

inherited

since	1.6.0

Arguments

path: stringRegistry Path (e.g. joomla.content.showauthor)

Response

mixedThe value of the removed node or null if not set

Save this keychain to a file.

saveKeychain(string keychainFile) : bool

since

since	1.0
throws	`\RuntimeException`if the keychain file path is invalid `\Joomla\Crypt\Exception\CryptExceptionInterface`if the keychain cannot be encrypted

1.0

throws

\RuntimeExceptionif the keychain file path is invalid

\Joomla\Crypt\Exception\CryptExceptionInterfaceif the keychain cannot be encrypted

Arguments

keychainFile: stringThe path to the keychain file.

Response

boolResult of storing the file.

Set a registry value.

set(string path, mixed value, string separator = null) : mixed

inherited deprecated

since	1.0.0
deprecated	The $separator parameter will be removed in version 4.

Arguments

path: stringRegistry Path (e.g. joomla.content.showauthor)
value: mixedValue of entry
separator: stringThe key separator

Response

mixedThe value of the that has been set.

Transforms a namespace to an array

toArray() : array

inherited

since	1.0.0

Response

arrayAn associative array holding the namespace data

Method to recursively convert data to one dimension array.

toFlatten(string separator = null, array|object data = null, array &array = [], string prefix = '') : void

inherited

since	1.3.0 2.0.0

since

1.3.0

2.0.0

Arguments

separator: stringThe key separator.
data: array|objectData source of this scope.
array: arrayThe result array, it is passed by reference.
prefix: stringLast level key prefix.

Transforms a namespace to an object

toObject() : object

inherited

since	1.0.0

Response

objectAn an object holding the namespace data

Get a namespace in a given string format

toString(string format = 'JSON', array options = []) : string

inherited

since	1.0.0

Arguments

format: stringFormat to return the string in
options: arrayParameters used by the formatter, see formatters for more info

Response

stringNamespace in string format

The encryption handler.

since	2.0.0

Type(s)

\Joomla\Crypt\Crypt

Registry Object

inherited

since	1.0.0

Type(s)

\stdClass

Flag if the Registry data object has been initialized

inherited

since	1.5.2

Type(s)

bool

Path separator

inherited

since	1.4.0

Type(s)

string

Keychain

Methods

__clone

__construct

Arguments

Response

__get

Arguments

Response

__set

Arguments

__toString

Response

append

Arguments

Response

asArray

Arguments

Response

bindData

Arguments

count

Response

def

Arguments

Response

exists

Arguments

Response

extract

Arguments

Response

flatten

Arguments

Response

get

Arguments

Response

getIterator

Response

jsonSerialize

Response

loadArray

Arguments

Response

loadFile

Arguments

Response

loadKeychain

Arguments

Response

loadObject

Arguments

Response

loadString

Arguments

Response

merge

Arguments

Response

offsetExists

Arguments

Response

offsetGet

Arguments

Response

offsetSet

Arguments

offsetUnset

Arguments

remove

Arguments

Response

saveKeychain

Arguments

Response

set

Arguments

Response

toArray