API15

JUtility/dump

From Joomla! Documentation

< API15:JUtility
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

The "API15" 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]

Method to dump the structure of a variable for debugging purposes

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax[edit]

dump(&$var, $htmlSafe=true)
Parameter Name Default Value Description
&$var A variable
$htmlSafe true True to ensure all characters are htmlsafe

Returns[edit]

string

Defined in[edit]

libraries/joomla/utilities/utility.php

Importing[edit]

jimport( 'joomla.utilities.utility' );

Source Body[edit]

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

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples[edit]

Code Examples[edit]