API16

JUtility/dump: Difference between revisions

From Joomla! Documentation

Doxiki (talk | contribs)
No edit summary
m clean up
Line 2: Line 2:
Method to dump the structure of a variable for debugging purposes
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}}
 
{{subst:Description:JUtility/dump}}


===Syntax===
===Syntax===
Line 43: Line 41:
</source>
</source>


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


===Examples===
===Examples===

Revision as of 14:36, 24 March 2017

Description

Method to dump the structure of a variable for debugging purposes


{{subst: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, ENT_COMPAT, 'UTF-8') : $result).'</pre>';
}


{{subst:SeeAlso:JUtility/dump}}

Examples

<CodeExamplesForm />