JRegistry/toString
From Joomla! Documentation
< API16:JRegistry
The "API16" 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[edit]
Get a namespace in a given string format
Syntax[edit]
toString($format= 'JSON', $namespace=null, $params=null)
Parameter Name | Default Value | Description |
---|---|---|
$format | 'JSON' | Format to return the string in |
$namespace | null | Namespace to return [optional: null returns the default namespace] |
$params | null | Parameters used by the formatter, see formatters for more info |
Returns[edit]
string Namespace in string format
Defined in[edit]
libraries/joomla/registry/registry.php
Importing[edit]
jimport( 'joomla.registry.registry' );
Source Body[edit]
public function toString($format = 'JSON', $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[edit]
Code Examples[edit]