API15:JRegistry/toString

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.

Description

Get a namespace in a given string format

Syntax

toString($format= 'INI', $namespace=null, $params=null)

Parameter Name	Default Value	Description
$format	'INI'	$format Format to return the string in
$namespace	null	$namespace Namespace to return [optional: null returns the default namespace]
$params	null	$params Parameters used by the formatter, see formatters for more info

Returns

string Namespace in string format

Defined in

libraries/joomla/registry/registry.php

Importing

jimport( 'joomla.registry.registry' );

Source Body

function toString($format = 'INI', $namespace = null, $params = null)
{
        // Return a namespace in a given format
        $handler =& JRegistryFormat::getInstance($format);
 
        // If namespace is not set, get the default namespace
        if ($namespace == null) {
                $namespace = $this->_defaultNameSpace;
        }
 
        // Get the namespace
        $ns = & $this->_registry[$namespace]['data'];
 
        return $handler->objectToString($ns, $params);
}

Examples

<CodeExamplesForm />