Actions

API15

JRegistry/setValue

From Joomla! Documentation

< API15:JRegistry
Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

Description

Set a registry value

[<! removed edit link to red link >]

<! 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 edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />