API15:JRegistry/loadFile

Description

Load the contents of a file into the registry

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

Syntax

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

Parameter Name	Default Value	Description
$file		$file Path to file to load
$format	'INI'	$format Format of the file [optional: defaults to INI]
$namespace	null	$namespace Namespace to load the INI string into [optional]

Returns

boolean True on success

Defined in

libraries/joomla/registry/registry.php

Importing

jimport( 'joomla.registry.registry' );

Source Body

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

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

        // Get the contents of the file
        jimport('joomla.filesystem.file');
        $data = JFile::read($file);

        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 transcluded page call, red link never existed >

Examples

<CodeExamplesForm />