API15:JRegistry/setValue

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

Set a registry value

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

Syntax

setValue($regpath, $value)

Parameter Name	Default Value	Description
$regpath		$regpath Registry Path (e.g. joomla.content.showauthor)
$value		$value Value of entry

Returns

mixed Value of old value or boolean false if operation failed

Defined in

libraries/joomla/registry/registry.php

Importing

jimport( 'joomla.registry.registry' );

Source Body

function setValue($regpath, $value)
{
        // Explode the registry path into an array
        $nodes = explode('.', $regpath);

        // Get the namespace
        $count = count($nodes);

        if ($count < 2) {
                $namespace = $this->_defaultNameSpace;
        } else {
                $namespace = array_shift($nodes);
                $count--;
        }

        if (!isset($this->_registry[$namespace])) {
                $this->makeNameSpace($namespace);
        }

        $ns = & $this->_registry[$namespace]['data'];

        $pathNodes = $count - 1;

        if ($pathNodes < 0) {
                $pathNodes = 0;
        }

        for ($i = 0; $i < $pathNodes; $i ++)
        {
                // If any node along the registry path does not exist, create it
                if (!isset($ns->$nodes[$i])) {
                        $ns->$nodes[$i] = new stdClass();
                }
                $ns =& $ns->$nodes[$i];
        }

        // Get the old value if exists so we can return it
        $ns->$nodes[$i] =& $value;

        return $ns->$nodes[$i];
}

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

Examples

<CodeExamplesForm />