API16

JRegistry/loadObject: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 4: Line 4:




{{subst:Description:JRegistry/loadObject}}
 


===Syntax===
===Syntax===
Line 64: Line 64:




{{subst:SeeAlso:JRegistry/loadObject}}
 


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=loadObject
  category=loadObject
  category=JRegistry
  category=JRegistry
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*
  format= ,,,
  format= ,,,
</dpl>
</dpl>

Latest revision as of 01:59, 25 March 2017

Description

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



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



Examples

Code Examples