Référence de la classe JRegistry

Graphe d'héritage de JRegistry:

Liste de tous les membres

Fonctions membres publiques
	__construct ($data=null)
	__clone ()
	__toString ()
	def ($key, $default= '')
	exists ($path)
	get ($path, $default=null)
	loadArray ($array)
	loadObject ($object)
	loadFile ($file, $format= 'JSON', $options=array())
	loadString ($data, $format= 'JSON', $options=array())
	merge (&$source)
	set ($path, $value)
	toArray ()
	toObject ()
	toString ($format= 'JSON', $options=array())
	loadXML ($data, $namespace=null)
	loadINI ($data, $namespace=null, $options=array())
	loadJSON ($data)
	makeNameSpace ($namespace)
	getNameSpaces ()
	getValue ($path, $default=null)
	setValue ($path, $value)
	loadSetupFile ()

Fonctions membres publiques statiques
static	getInstance ($id)

Fonctions membres protégées
	bindData (&$parent, $data)
	asArray ($data)

Attributs protégés
	$data

Attributs protégés statiques
static	$instances = array()

---

Documentation des constructeurs et destructeur

JRegistry::__construct

(

$data = null

)

Constructor

Paramètres:

mixed

$data

The data to bind to the new JRegistry object.

Depuis:

11.1

Références $data, et elseif.

---

Documentation des fonctions membres

JRegistry::__clone

(

)

Magic function to clone the registry object.

Renvoie:

JRegistry

Depuis:

11.1

JRegistry::__toString

(

)

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

Renvoie:

string

Depuis:

11.1

JRegistry::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:

11.1

Références $data.

JRegistry::bindData ( &  $parent,   $data  )

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.

Renvoie:

void

Depuis:

11.1

Références $data, et JArrayHelper\isAssociative().

Voici le graphe d'appel pour cette fonction :

JRegistry::def	(		$key,
			$default = ''
	)

Sets a default value if not already assigned.

Paramètres:

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

Renvoie:

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

Depuis:

11.1

Références $key.

JRegistry::exists

(

$path

)

Check if a registry path exists.

Paramètres:

string

$path

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

Renvoie:

boolean

Depuis:

11.1

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

JRegistry::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:

11.1

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

static JRegistry::getInstance (   $id )

static

Returns a reference to a global JRegistry object, only creating it if it doesn't already exist.

This method must be invoked as:

$registry = JRegistry::getInstance($id);

Paramètres:

string

$id

An ID for the registry instance

Renvoie:

object The JRegistry object.

Depuis:

11.1

Références $id.

JRegistry::getNameSpaces

(

)

Get the list of namespaces

Renvoie:

array List of namespaces

Obsolète:

12.1

Note:

Namespaces are no longer supported.

Depuis:

11.1

Références JLog\add(), et JLog\WARNING.

Voici le graphe d'appel pour cette fonction :

JRegistry::getValue	(		$path,
			$default = null
	)

Get a registry value

Paramètres:

string	$path	Registry path (e.g. joomla.content.showauthor)
mixed	$default	Optional default value

Renvoie:

mixed Value of entry or null

Obsolète:

12.1

Note:

Use get instead.

Depuis:

11.1

Références $parts, $path, JLog\add(), et JLog\WARNING.

Voici le graphe d'appel pour cette fonction :

JRegistry::loadArray

(

$array

)

Load a associative array of values into the default namespace

Paramètres:

array

$array

Associative array of value to load

Renvoie:

boolean True on success

Depuis:

11.1

Référencé par FinderTableFilter\bind(), JTableMenu\bind(), JTableUpdate\bind(), JTableExtension\bind(), JTableModule\bind(), JTableContent\bind(), JTableUser\bind(), JTableCategory\bind(), ContentModelArticles\getItems(), et ContentModelArticle\save().

Voici le graphe des appelants de cette fonction :

JRegistry::loadFile	(		$file,
			$format = 'JSON',
			$options = array()
	)

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]
mixed	$options	Options used by the formatter

Renvoie:

boolean True on success

Depuis:

11.1

Références $data, $file, $options, jimport(), et JFile\read().

Voici le graphe d'appel pour cette fonction :

JRegistry::loadINI	(		$data,
			$namespace = null,
			$options = array()
	)

Load an INI string into the registry into the given namespace [or default if a namespace is not given]

Paramètres:

string	$data	INI formatted string to load into the registry
string	$namespace	Namespace to load the INI string into [optional]
mixed	$options	An array of options for the formatter, or boolean to process sections.

Renvoie:

boolean True on success

Depuis:

11.1

Obsolète:

12.1 Use loadString passing INI as the format instead.

Références $data, $options, JLog\add(), et JLog\WARNING.

Voici le graphe d'appel pour cette fonction :

JRegistry::loadJSON

(

$data

)

Load an JSON string into the registry into the given namespace [or default if a namespace is not given]

Paramètres:

string

$data

JSON formatted string to load into the registry

Renvoie:

boolean True on success

Obsolète:

12.1 Use loadString passing JSON as the format instead.

Note:

Use loadString instead.

Depuis:

11.1

Références $data, JLog\add(), et JLog\WARNING.

Voici le graphe d'appel pour cette fonction :

JRegistry::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:

boolean True on success

Depuis:

11.1

JRegistry::loadSetupFile

(

)

This method is added as an interim solution for API references in the Joomla! CMS 1.6 to the JRegistry object where in 1.5 a JParameter object existed. Because many extensions may call this method we add it here as a means of "pain relief" until the 1.8 release.

Renvoie:

boolean True.

Obsolète:

12.1

Note:

Load no longer supported.

Depuis:

11.1

Références JLog\add(), et JLog\WARNING.

Voici le graphe d'appel pour cette fonction :

JRegistry::loadString	(		$data,
			$format = 'JSON',
			$options = array()
	)

Load a string into the registry

Paramètres:

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

Renvoie:

boolean True on success

Depuis:

11.1

Références $data, $options, et JRegistryFormat\getInstance().

Référencé par JMenu\__construct(), JComponentHelper\_load(), SearchViewSearch\display(), ContactViewCategory\display(), NewsfeedsViewCategory\display(), ContactViewFeatured\display(), ContactModelContact\getContactQuery(), ContentModelForm\getItem(), PluginsModelPlugin\getItem(), WeblinksModelWeblink\getItem(), TemplatesModelStyle\getItem(), ContentModelArticle\getItem(), NewsfeedsModelNewsfeed\getItem(), ContactModelContact\getItem(), ModulesModelModule\getItem(), MenusModelItem\getItem(), JModelAdmin\getItem(), BannersModelBanners\getItems(), ContentModelArticles\getItems(), JSite\getParams(), JSite\getTemplate(), plgFinderCategories\index(), plgFinderContent\index(), plgFinderWeblinks\index(), plgFinderNewsfeeds\index(), plgFinderContacts\index(), ContentModelCategory\populateState(), FinderIndexerQuery\processStaticTaxonomy(), MenusModelItem\rebuild(), JDocumentRendererModule\render(), JUser\save(), JHtmlFilter\select(), JHtmlFilter\slider(), et JInstallerLanguage\uninstall().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

JRegistry::loadXML	(		$data,
			$namespace = null
	)

Load an XML string into the registry into the given namespace [or default if a namespace is not given]

Paramètres:

string	$data	XML formatted string to load into the registry
string	$namespace	Namespace to load the XML string into [optional]

Renvoie:

boolean True on success

Depuis:

11.1

Obsolète:

12.1 Use loadString passing XML as the format instead.

Note:

Références $data, JLog\add(), et JLog\WARNING.

Voici le graphe d'appel pour cette fonction :

JRegistry::makeNameSpace

(

$namespace

)

Create a namespace

Paramètres:

string

$namespace

Name of the namespace to create

Renvoie:

boolean True on success

Obsolète:

12.1

Note:

Namespaces are no longer supported.

Depuis:

11.1

Références JLog\add(), et JLog\WARNING.

Voici le graphe d'appel pour cette fonction :

JRegistry::merge

(

&

$source

)

Merge a JRegistry object into this one

Paramètres:

JRegistry

&$source

Source JRegistry object to merge.

Renvoie:

boolean True on success

Depuis:

11.1

Références null.

JRegistry::set	(		$path,
			$value
	)

Set a registry value.

Paramètres:

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

Renvoie:

mixed The value of the that has been set.

Depuis:

11.1

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

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

Voici le graphe des appelants de cette fonction :

JRegistry::setValue	(		$path,
			$value
	)

Set a registry value

Paramètres:

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

Renvoie:

mixed The value after setting.

Obsolète:

12.1

Note:

Use set instead.

Depuis:

11.1

Références $parts, $path, JLog\add(), et JLog\WARNING.

Voici le graphe d'appel pour cette fonction :

JRegistry::toArray

(

)

Transforms a namespace to an array

Renvoie:

array An associative array holding the namespace data

Depuis:

11.1

JRegistry::toObject

(

)

Transforms a namespace to an object

Renvoie:

object An an object holding the namespace data

Depuis:

11.1

Références $data.

JRegistry::toString	(		$format = 'JSON',
			$options = array()
	)

Get a namespace in a given string format

Paramètres:

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

Renvoie:

string Namespace in string format

Depuis:

11.1

Références $options, et JRegistryFormat\getInstance().

Référencé par ConfigModelApplication\writeConfigFile().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

---

Documentation des données membres

JRegistry::$data

protected

JRegistry::$instances = array()

staticprotected

---

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

• registry.php