API16

JRegistry/loadINI

From Joomla! Documentation

< API16:JRegistry
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

The "API16" 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]



Syntax[edit]

loadINI($data, $namespace=null)
Parameter Name Default Value Description
$data INI formatted string to load into the registry
$namespace null 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]

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



Examples[edit]

Code Examples[edit]