API16

JRegistry/loadObject: Difference between revisions

From Joomla! Documentation

Doxiki (talk | contribs)
New page: ===Description=== Load the public variables of the object into the default namespace. <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>[[Description:JRegistry/loadO...
 
Doxiki (talk | contribs)
No edit summary
Line 17: Line 17:
!Description
!Description
|-
|-
|  
| &$object
|  
|  
|  The object holding the public vars to load  
|  The object holding the public vars to load  

Revision as of 10:18, 30 March 2010

Description

Load the public variables of the object into the default namespace.

[Edit Descripton]

Template:Description:JRegistry/loadObject

Syntax

loadObject(&$object, $namespace=null)
Parameter Name Default Value Description
&$object The object holding the public vars to load
$namespace null 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

public function loadObject(&$object, $namespace = null)
{
        // 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);
        }

        /*
         * 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
         */
        if (is_object($object)) {
                foreach (get_object_vars($object) as $k => $v) {
                        if (substr($k, 0,1) != '_' || $k == '_name') {
                                $this->_registry[$namespace]['data']->$k = $v;
                        }
                }
        }

        return true;
}

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

Examples

<CodeExamplesForm />