API15

JRegistry/loadINI

From Joomla! Documentation

< API15:JRegistry
Revision as of 17:24, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Load an INI string into the registry into the given namespace [or default if a namespace is not given] <span class="editsection" style="font-size:76%;"> <nowiki>[</n...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The "API15" 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.

Description[edit]

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

[Edit Descripton]

Template:Description:JRegistry/loadINI

Syntax[edit]

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

Returns[edit]

boolean True on success

Defined in[edit]

libraries/joomla/registry/registry.php

Importing[edit]

jimport( 'joomla.registry.registry' );

Source Body[edit]

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

        // 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;
}

[Edit See Also] Template:SeeAlso:JRegistry/loadINI

Examples[edit]

<CodeExamplesForm />