API15

API15:JUtility/dump

From Joomla! Documentation

Description

Method to dump the structure of a variable for debugging purposes

[Edit Descripton]

Template:Description:JUtility/dump

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 ) : $result).'</pre>';
}

[Edit See Also] Template:SeeAlso:JUtility/dump

Examples

<CodeExamplesForm />