Difference between revisions of "JRegistry"

Latest revision as of 22:33, 24 March 2017

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

JRegistry[edit]

Description[edit]

Methods[edit]

Visibility	Method name	Description
public	__clone	Magic function to clone the registry object.
public	__construct	Constructor.
public	__toString	Magic function to render this object as a string using default args of toString method.
public	def	Sets a default value if not alreay assigned.
public	exists	Check if a registry path exists.
public	get	Get a registry value.
public	getNameSpaces	Get the list of namespaces.
public	getValue	Get a registry value.
public	loadArray	Load a associative array of values into the default namespace.
public	loadFile	Load the contents of a file into the registry.
public	loadINI	Load an INI string into the registry into the given namespace [or default if a namespace is not given].
public	loadJSON	Load an JSON string into the registry into the given namespace [or default if a namespace is not given].
public	loadObject	Load the public variables of the object into the default namespace.
public	loadSetupFile	This method is added as an interim solution for API references in Joomla! 1.6 to the object where in 1.5 a object existed.
public	loadString	Load a string into the registry.
public	loadXML	Load an XML string into the registry into the given namespace [or default if a namespace is not given].
public	makeNameSpace	Create a namespace.
public	merge	Merge a object into this one.
public	set	Set a registry value.
public	setValue	Set a registry value.
public	toArray	Transforms a namespace to an array.
public	toObject	Transforms a namespace to an object.
public	toString	Get a namespace in a given string format.
public static	getInstance	Returns a reference to a global object, only creating it if it doesn't already exist.
protected	asArray	Method to recursively convert an object of data to an array.
protected	bindData	Method to recursively bind data to a parent object.

Defined in libraries/joomla/registry/registry.php
Extended by
- JParameter

Importing[edit]

jimport( 'joomla.registry.registry' );

User contributed notes[edit]

Code Examples[edit]

@@ Line 2: / Line 2: @@
 =={{JVer|11.1}} JRegistry==
 ===Description===
-{{Description:JRegistry}}
-<span class="editsection" style="font-size:76%;">
-<nowiki>[</nowiki>[[Description:JRegistry|Edit Descripton]]<nowiki>]</nowiki>
-</span>
 ===Methods===
 {| class="wikitable sortable"
@@ Line 14: / Line 12: @@
 |-
 |public
-|[[JRegistry::__clone/11.1|__clone]]
+|[[API17:JRegistry::__clone|__clone]]
 |Magic function to clone the registry object.
 |-
 |public
-|[[JRegistry::__construct/11.1|__construct]]
+|[[API17:JRegistry::__construct|__construct]]
 |Constructor.
 |-
 |public
-|[[JRegistry::__toString/11.1|__toString]]
+|[[API17:JRegistry::__toString|__toString]]
 |Magic function to render this object as a string using default args of toString method.
 |-
 |public
-|[[JRegistry::def/11.1|def]]
+|[[API17:JRegistry::def|def]]
 |Sets a default value if not alreay assigned.
 |-
 |public
-|[[JRegistry::exists/11.1|exists]]
+|[[API17:JRegistry::exists|exists]]
 |Check if a registry path exists.
 |-
 |public
-|[[JRegistry::get/11.1|get]]
+|[[API17:JRegistry::get|get]]
 |Get a registry value.
 |-
 |public
-|[[JRegistry::getNameSpaces/11.1|getNameSpaces]]
+|[[API17:JRegistry::getNameSpaces|getNameSpaces]]
 |Get the list of namespaces.
 |-
 |public
-|[[JRegistry::getValue/11.1|getValue]]
+|[[API17:JRegistry::getValue|getValue]]
 |Get a registry value.
 |-
 |public
-|[[JRegistry::loadArray/11.1|loadArray]]
+|[[API17:JRegistry::loadArray|loadArray]]
 |Load a associative array of values into the default namespace.
 |-
 |public
-|[[JRegistry::loadFile/11.1|loadFile]]
+|[[API17:JRegistry::loadFile|loadFile]]
 |Load the contents of a file into the registry.
 |-
 |public
-|[[JRegistry::loadINI/11.1|loadINI]]
+|[[API17:JRegistry::loadINI|loadINI]]
 |Load an INI string into the registry into the given namespace [or default if a namespace is not given].
 |-
 |public
-|[[JRegistry::loadJSON/11.1|loadJSON]]
+|[[API17:JRegistry::loadJSON|loadJSON]]
 |Load an JSON string into the registry into the given namespace [or default if a namespace is not given].
 |-
 |public
-|[[JRegistry::loadObject/11.1|loadObject]]
+|[[API17:JRegistry::loadObject|loadObject]]
 |Load the public variables of the object into the default namespace.
 |-
 |public
-|[[JRegistry::loadSetupFile/11.1|loadSetupFile]]
+|[[API17:JRegistry::loadSetupFile|loadSetupFile]]
 |This method is added as an interim solution for API references in Joomla! 1.6 to the  object where in 1.5 a  object existed.
 |-
 |public
-|[[JRegistry::loadString/11.1|loadString]]
+|[[API17:JRegistry::loadString|loadString]]
 |Load a string into the registry.
 |-
 |public
-|[[JRegistry::loadXML/11.1|loadXML]]
+|[[API17:JRegistry::loadXML|loadXML]]
 |Load an XML string into the registry into the given namespace [or default if a namespace is not given].
 |-
 |public
-|[[JRegistry::makeNameSpace/11.1|makeNameSpace]]
+|[[API17:JRegistry::makeNameSpace|makeNameSpace]]
 |Create a namespace.
 |-
 |public
-|[[JRegistry::merge/11.1|merge]]
+|[[API17:JRegistry::merge|merge]]
 |Merge a  object into this one.
 |-
 |public
-|[[JRegistry::set/11.1|set]]
+|[[API17:JRegistry::set|set]]
 |Set a registry value.
 |-
 |public
-|[[JRegistry::setValue/11.1|setValue]]
+|[[API17:JRegistry::setValue|setValue]]
 |Set a registry value.
 |-
 |public
-|[[JRegistry::toArray/11.1|toArray]]
+|[[API17:JRegistry::toArray|toArray]]
 |Transforms a namespace to an array.
 |-
 |public
-|[[JRegistry::toObject/11.1|toObject]]
+|[[API17:JRegistry::toObject|toObject]]
 |Transforms a namespace to an object.
 |-
 |public
-|[[JRegistry::toString/11.1|toString]]
+|[[API17:JRegistry::toString|toString]]
 |Get a namespace in a given string format.
 |-
 |public static
-|[[JRegistry::getInstance/11.1|getInstance]]
+|[[API17:JRegistry::getInstance|getInstance]]
 |Returns a reference to a global  object, only creating it if it doesn't already exist.
 |-
 |protected
-|[[JRegistry::asArray/11.1|asArray]]
+|[[API17:JRegistry::asArray|asArray]]
 |Method to recursively convert an object of data to an array.
 |-
 |protected
-|[[JRegistry::bindData/11.1|bindData]]
+|[[API17:JRegistry::bindData|bindData]]
 |Method to recursively bind data to a parent object.
 |-
@@ Line 120: / Line 118: @@
 * '''Defined in''' libraries/joomla/registry/registry.php
 * '''Extended by'''
-** [[JParameter/11.1|JParameter]]
+** [[API17:JParameter|JParameter]]
 ===Importing===
 <source lang="php">jimport( 'joomla.registry.registry' );</source>
 ===See also===
 * {{JVer|11.1}} '''JRegistry source code''' on [[jplatform:registry/registry.php|BitBucket]]
-* {{JVer|11.1}} Subpackage [[Subpackage Registry/11.1|Registry]]
+* {{JVer|11.1}} Subpackage [[API17:Subpackage Registry|Registry]]
-* [[JRegistry|Other versions of JRegistry]]
+* [[API17:JRegistry|Other versions of JRegistry]]
-{{SeeAlso:JRegistry}}
-<span class="editsection" style="font-size:76%;">
-<nowiki>[</nowiki>[[SeeAlso:JRegistry|Edit See Also]]<nowiki>]</nowiki>
-</span>
 ===User contributed notes===
-<CodeExamplesForm />
+=== Code Examples ===
 <dpl>
 noresultsheader=\n
 category=JRegistry
-category=CodeExample
+namespace=CodeExample
 category=ClassExample
 include=*

API17