API16:JUtility/dump

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

Method to dump the structure of a variable for debugging purposes

Syntax

dump(&$var, $htmlSafe=true)

Parameter Name	Default Value	Description
&$var		A variable
$htmlSafe	true	True to ensure all characters are htmlsafe

Returns

string

Defined in

libraries/joomla/utilities/utility.php

Importing

jimport( 'joomla.utilities.utility' );

Source Body

function dump(&$var, $htmlSafe = true)
{
        $result = var_export($var, true);
        return '<pre>'.($htmlSafe ? htmlspecialchars($result, ENT_COMPAT, 'UTF-8') : $result).'</pre>';
}

Examples

<CodeExamplesForm />