Référence de la classe Registry

Graphe d'héritage de Registry:

Fonctions membres publiques
	__construct ($data=null)
	__clone ()
	__toString ()
	count ()
	jsonSerialize ()
	def ($key, $default='')
	exists ($path)
	get ($path, $default=null)
	getIterator ()
	loadArray (array $array, $flattened=false, $separator=null)
	loadObject ($object)
	loadFile ($file, $format='JSON', array $options=[])
	loadString ($data, $format='JSON', array $options=[])
	merge (Registry $source, $recursive=false)
	extract ($path)
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	set ($path, $value, $separator=null)
	append ($path, $value)
	remove ($path)
	toArray ()
	toObject ()
	toString ($format='JSON', array $options=[])
	flatten ($separator=null)

Champs de données
	$separator = '.'

Fonctions membres protégées
	bindData ($parent, $data, $recursive=true, $allowNull=true)
	asArray ($data)
	toFlatten ($separator=null, $data=null, array &$array=[], $prefix='')

Attributs protégés
	$data
	$initialized = false

Description détaillée

Registry class

Depuis

1.0

Documentation des constructeurs et destructeur

__construct()

__construct

(

$data = null

)

Constructor

Paramètres

mixed

$data

The data to bind to the new Registry object.

Depuis

1.0

Références Registry\$data, Registry\bindData(), elseif, Registry\loadString(), et Registry\merge().

Documentation des fonctions membres

__clone()

__clone

(

)

Magic function to clone the registry object.

Renvoie

void

Depuis

1.0

__toString()

__toString

(

)

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

Renvoie

string

Depuis

1.0

Références Registry\toString().

append()

append	(		$path,
			$value
	)

Append value to a path in registry

Paramètres

string	$path	Parent registry Path (e.g. joomla.content.showauthor)
mixed	$value	Value of entry

Renvoie

mixed The value of the that has been set.

Depuis

1.4.0

Références $data, $i, $n, $path, $result, et null.

asArray()

asArray (   $data )

protected

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

Paramètres

object

$data

An object of data to return as an array.

Renvoie

array Array representation of the input object.

Depuis

1.0

Références $data.

bindData()

bindData (   $parent,   $data,   $recursive = true,   $allowNull = true  )

protected

Method to recursively bind data to a parent object.

Paramètres

object	$parent	The parent object on which to attach the data values.
mixed	$data	An array or object of data to bind to the parent object.
boolean	$recursive	True to support recursive bindData.
boolean	$allowNull	True to allow null values.

Renvoie

void

Depuis

1.0

Références $data, et null.

Référencé par Registry\__construct(), Registry\loadArray(), Registry\loadObject(), et Registry\merge().

count()

count

(

)

Count elements of the data object

Renvoie

integer The custom count as an integer.

1.3.0

Référencé par Registry\set().

def()

def	(		$key,
			$default = ''
	)

Sets a default value if not already assigned.

Paramètres

string	$key	The name of the parameter.
mixed	$default	An optional value for the parameter.

Renvoie

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

Depuis

1.0

Références $default, $key, et $value.

exists()

exists

(

$path

)

Check if a registry path exists.

Paramètres

string

$path

Registry path (e.g. joomla.content.showauthor)

Renvoie

boolean

Depuis

1.0

Références Registry\$data, $n, et $path.

Référencé par Registry\offsetExists().

extract()

extract

(

$path

)

Method to extract a sub-registry from path

Paramètres

string

$path

Registry path (e.g. joomla.content.showauthor)

Renvoie

Registry Registry object (empty if no data is present)

Depuis

1.2.0

Références Registry\$data, et $path.

flatten()

flatten

(

$separator = null

)

Dump to one dimension array.

Paramètres

string

$separator

The key separator.

Renvoie

string[] Dumped array.

Depuis

1.3.0

Références $separator.

get()

get	(		$path,
			$default = null
	)

Get a registry value.

Paramètres

string	$path	Registry path (e.g. joomla.content.showauthor)
mixed	$default	Optional default value, returned if the internal value is null.

Renvoie

mixed Value of entry or null

Depuis

1.0

Références Registry\$data, $default, $n, $path, et null.

getIterator()

getIterator

(

)

Gets this object represented as an ArrayIterator.

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

Renvoie

This object represented as an ArrayIterator.

Voir également

IteratorAggregate::getIterator()

Depuis

1.3.0

jsonSerialize()

jsonSerialize

(

)

Implementation for the JsonSerializable interface. Allows us to pass Registry objects to json_encode.

Renvoie

object

Depuis

1.0

Note

The interface is only present in PHP 5.4 and up.

Références Registry\$data.

loadArray()

loadArray	(	array	$array,
			$flattened = false,
			$separator = null
	)

Load an associative array of values into the default namespace

Paramètres

array	$array	Associative array of value to load
boolean	$flattened	Load from a one-dimensional array
string	$separator	The key separator

Renvoie

$this

Depuis

1.0

Références Registry\$separator, $this, et Registry\bindData().

loadFile()

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

Load the contents of a file into the registry

Paramètres

string	$file	Path to file to load
string	$format	Format of the file [optional: defaults to JSON]
array	$options	Options used by the formatter

Renvoie

$this

Depuis

1.0

Références Registry\$data, $format, $options, et Registry\loadString().

loadObject()

loadObject

(

$object

)

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

Paramètres

object

$object

The object holding the publics to load

Renvoie

$this

Depuis

1.0

Références $this, et Registry\bindData().

Référencé par Registry\loadString().

loadString()

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

Load a string into the registry

Paramètres

string	$data	String to load into the registry
string	$format	Format of the string
array	$options	Options used by the formatter

Renvoie

$this

Depuis

1.0

Références Registry\$data, $format, $options, $this, Factory\getFormat(), et Registry\loadObject().

Référencé par Registry\__construct(), et Registry\loadFile().

merge()

merge	(	Registry	$source,
			$recursive = false
	)

Merge a Registry object into this one

Paramètres

Registry	$source	Source Registry object to merge.
boolean	$recursive	True to support recursive merge the children values.

Renvoie

$this

Depuis

1.0

Références $this, Registry\bindData(), et Registry\toArray().

Référencé par Registry\__construct().

offsetExists()

offsetExists

(

$offset

)

Checks whether an offset exists in the iterator.

Paramètres

mixed

$offset

The array offset.

Renvoie

boolean True if the offset exists, false otherwise.

Depuis

1.0

Références Joomla\Database\Query\$offset, et Registry\exists().

offsetGet()

offsetGet

(

$offset

)

Gets an offset in the iterator.

Paramètres

mixed

$offset

The array offset.

Renvoie

mixed The array value if it exists, null otherwise.

Depuis

1.0

Références Joomla\Database\Query\$offset.

offsetSet()

offsetSet	(		$offset,
			$value
	)

Sets an offset in the iterator.

Paramètres

mixed	$offset	The array offset.
mixed	$value	The array value.

Renvoie

void

Depuis

1.0

Références Joomla\Database\Query\$offset, et $value.

offsetUnset()

offsetUnset

(

$offset

)

Unsets an offset in the iterator.

Paramètres

mixed

$offset

The array offset.

Renvoie

void

Depuis

1.0

Références Joomla\Database\Query\$offset.

remove()

remove

(

$path

)

Delete a registry value

Paramètres

string

$path

Registry Path (e.g. joomla.content.showauthor)

Renvoie

mixed The value of the removed node or null if not set

Depuis

1.6.0

Références $data, $i, $n, $path, $result, et null.

set()

set	(		$path,
			$value,
			$separator = null
	)

Set a registry value.

Paramètres

string	$path	Registry Path (e.g. joomla.content.showauthor)
mixed	$value	Value of entry
string	$separator	The key separator

Renvoie

mixed The value of the that has been set.

Depuis

1.0

Références Registry\$data, $i, $n, $path, Registry\$separator, et Registry\count().

toArray()

toArray

(

)

Transforms a namespace to an array

Renvoie

array An associative array holding the namespace data

Depuis

1.0

Référencé par Registry\merge().

toFlatten()

toFlatten (   $separator = null,   $data = null, array &  $array = [],   $prefix = ''  )

protected

Method to recursively convert data to one dimension array.

Paramètres

string	$separator	The key separator.
array | object	$data	Data source of this scope.
array	$array	The result array, it is passed by reference.
string	$prefix	Last level key prefix.

Renvoie

void

Depuis

1.3.0

Références $data, $key, $prefix, et $separator.

toObject()

toObject

(

)

Transforms a namespace to an object

Renvoie

object An an object holding the namespace data

Depuis

1.0

Références $data.

toString()

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

Get a namespace in a given string format

Paramètres

string	$format	Format to return the string in
array	$options	Parameters used by the formatter, see formatters for more info

Renvoie

string Namespace in string format

Depuis

1.0

Références $format, et $options.

Référencé par Registry\__toString().

Documentation des champs

$data

$data

protected

Référencé par Registry\__construct(), Registry\exists(), Registry\extract(), Registry\get(), Registry\jsonSerialize(), Registry\loadFile(), Registry\loadString(), et Registry\set().

$initialized

$initialized = false

protected

$separator

$separator = '.'

Référencé par Registry\loadArray(), et Registry\set().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• vendor/joomla/registry/src/Registry.php