Référence de la classe JRegistry

Graphe d'héritage de JRegistry:

Graphe de collaboration de JRegistry:

Liste de tous les membres

Fonctions membres publiques

• __construct ($namespace= 'default')
• makeNameSpace ($namespace)
• getNameSpaces ()
• getValue ($regpath, $default=null)
• setValue ($regpath, $value)
• loadArray ($array, $namespace=null)
• loadObject (&$object, $namespace=null)
• loadFile ($file, $format= 'INI', $namespace=null)
• loadXML ($data, $namespace=null)
• loadINI ($data, $namespace=null)
• merge (&$source)
• toString ($format= 'INI', $namespace=null, $params=null)
• toArray ($namespace=null)
• toObject ($namespace=null)
• __clone ()

Fonctions membres publiques statiques

• & getInstance ($id, $namespace= 'default')

Attributs publics

• $_defaultNameSpace = null
• $_registry = array ()

---

Documentation des constructeurs et destructeur

JRegistry::__construct

(

$

namespace = 'default'

)

Constructor

protected

Paramètres:

string

$namespace

Default registry namespace

Renvoie:

void

Depuis:

1.5

---

Documentation des fonctions membres

JRegistry::__clone

(

)

& JRegistry::getInstance	(	$	id,
		$	namespace = 'default'
	)		[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[, $namespace]);

Paramètres:

string	$id	An ID for the registry instance
string	$namespace	The default namespace for the registry object [optional]

Renvoie:

object The JRegistry object.

Depuis:

1.5

Références $id.

JRegistry::getNameSpaces

(

)

Get the list of namespaces

public

Renvoie:

array List of namespaces

Depuis:

1.5

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

Get a registry value

public

Paramètres:

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

Renvoie:

mixed Value of entry or null

Depuis:

1.5

Références $count, et $i.

JRegistry::loadArray	(	$	array,
		$	namespace = null
	)

Load a associative array of values into the default namespace

public

Paramètres:

array	$array	Associative array of value to load
string	$namepsace	The name of the namespace

Renvoie:

boolean True on success

Depuis:

1.5

Références $array, et $k.

JRegistry::loadFile	(	$	file,
		$	format = 'INI',
		$	namespace = null
	)

Load the contents of a file into the registry

public

Paramètres:

string	$file	Path to file to load
string	$format	Format of the file [optional: defaults to INI]
string	$namespace	Namespace to load the INI string into [optional]

Renvoie:

boolean True on success

Depuis:

1.5

Références $data, $file, $k, JRegistryFormat::getInstance(), jimport(), et JFile::read().

Voici le graphe d'appel pour cette fonction :

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

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

public

Paramètres:

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

Renvoie:

boolean True on success

Depuis:

1.5

Références $data, $k, et JRegistryFormat::getInstance().

Voici le graphe d'appel pour cette fonction :

JRegistry::loadObject	(	&$	object,
		$	namespace = null
	)

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

public

Paramètres:

object	$object	The object holding the public vars to load
string	$namespace	Namespace to load the INI string into [optional]

Renvoie:

boolean True on success

Depuis:

1.5

Références $k.

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

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

public

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:

1.5

Références $data, $k, et JRegistryFormat::getInstance().

Voici le graphe d'appel pour cette fonction :

JRegistry::makeNameSpace

(

$

namespace

)

Create a namespace

public

Paramètres:

string

$namespace

Name of the namespace to create

Renvoie:

boolean True on success

Depuis:

1.5

JRegistry::merge

(

&$

source

)

Merge a JRegistry object into this one

public

Paramètres:

object

$source

Source JRegistry object ot merge

Renvoie:

boolean True on success

Depuis:

1.5

Références $k.

JRegistry::setValue	(	$	regpath,
		$	value
	)

Set a registry value

public

Paramètres:

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

Renvoie:

mixed Value of old value or boolean false if operation failed

Depuis:

1.5

Références $count, et $i.

JRegistry::toArray

(

$

namespace = null

)

Transforms a namespace to an array

public

Paramètres:

string

$namespace

Namespace to return [optional: null returns the default namespace]

Renvoie:

array An associative array holding the namespace data

Depuis:

1.5

Références $array, et $k.

JRegistry::toObject

(

$

namespace = null

)

Transforms a namespace to an object

public

Paramètres:

string

$namespace

Namespace to return [optional: null returns the default namespace]

Renvoie:

object An an object holding the namespace data

Depuis:

1.5

JRegistry::toString	(	$	format = 'INI',
		$	namespace = null,
		$	params = null
	)

Get a namespace in a given string format

public

Paramètres:

string	$format	Format to return the string in
string	$namespace	Namespace to return [optional: null returns the default namespace]
mixed	$params	Parameters used by the formatter, see formatters for more info

Renvoie:

string Namespace in string format

Depuis:

1.5

Références $params, et JRegistryFormat::getInstance().

Voici le graphe d'appel pour cette fonction :

---

Documentation des données membres

JRegistry::$_defaultNameSpace = null

JRegistry::$_registry = array ()

---

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

• registry.php