Actions

API15

JUtility/dump

From Joomla! Documentation

< API15:JUtility
Replacement filing cabinet.png
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.

Contents

Description

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

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>';
}

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

Examples

<CodeExamplesForm />