View source for JUtility/dump

===Description===
Method to dump the structure of a variable for debugging purposes

<span class="editsection" style="font-size:76%;">
	<nowiki>[</nowiki>[[Description:JUtility/dump|Edit Descripton]]<nowiki>]</nowiki>
</span>

{{Description:JUtility/dump}}

===Syntax===
<source lang="php">dump(&$var, $htmlSafe=true)</source>

 {| class="wikitable"
|-
!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===
<source lang="php">jimport( 'joomla.utilities.utility' );</source>

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

<span class="editsection" style="font-size:76%;">
	<nowiki>[</nowiki>[[SeeAlso:JUtility/dump|Edit See Also]]<nowiki>]</nowiki>
</span>
{{SeeAlso:JUtility/dump}}

===Examples===
<CodeExamplesForm />
<dpl>
 noresultsheader=\n
 category=dump
 category=JUtility
 category=CodeExample
 category=MethodExample
 include=*
 format= ,,,
</dpl>