API15

JRegistry/loadXML: Difference between revisions

From Joomla! Documentation

m removing red link to edit, no existant pages
m preparing for archive only
 
Line 74: Line 74:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=loadXML
  category=loadXML
  category=JRegistry
  category=JRegistry
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 01:04, 25 March 2017

Description

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

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax

loadXML($data, $namespace=null)
Parameter Name Default Value Description
$data $data XML formatted string to load into the registry
$namespace null $namespace Namespace to load the XML string into [optional]

Returns

boolean True on success

Defined in

libraries/joomla/registry/registry.php

Importing

jimport( 'joomla.registry.registry' );

Source Body

function loadXML($data, $namespace = null)
{
        // Load a string into the given namespace [or default namespace if not given]
        $handler =& JRegistryFormat::getInstance('XML');

        // If namespace is not set, get the default namespace
        if ($namespace == null) {
                $namespace = $this->_defaultNameSpace;
        }

        if (!isset($this->_registry[$namespace])) {
                // If namespace does not exist, make it and load the data
                $this->makeNameSpace($namespace);
                $this->_registry[$namespace]['data'] =& $handler->stringToObject($data);
        } else {
                // Get the data in object format
                $ns =& $handler->stringToObject($data);

                /*
                 * We want to leave groups that are already in the namespace and add the
                 * groups loaded into the namespace.  This overwrites any existing group
                 * with the same name
                 */
                foreach (get_object_vars($ns) as $k => $v) {
                        $this->_registry[$namespace]['data']->$k = $v;
                }
        }

        return true;
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

Code Examples