JUtility/dump: Difference between revisions
From Joomla! Documentation
No edit summary |
m preparing for archive only |
||
| (One intermediate revision by the same user not shown) | |||
| 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 | ||
===Syntax=== | ===Syntax=== | ||
| Line 43: | Line 41: | ||
</source> | </source> | ||
===Examples=== | ===Examples=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=dump | category=dump | ||
category=JUtility | category=JUtility | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
Latest revision as of 02:16, 25 March 2017
Description
Method to dump the structure of a variable for debugging purposes
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>';
}
Examples
Code Examples