Class HtmlFormatter
A Debugger formatter for generating interactive styled HTML output.
Property Summary
-
$id protected
stringRandom id so that HTML ids are not shared between dump outputs.
-
$outputHeader protected static
bool
Method Summary
-
__construct() public
Constructor.
-
dump() public
Convert a tree of NodeInterface objects into HTML
-
dumpHeader() protected
Generate the CSS and Javascript for dumps
-
environmentMatches() public static
Check if the current environment is not a CLI context
-
export() protected
Convert a tree of NodeInterface objects into HTML
-
exportArray() protected
Export an array type object
-
exportObject() protected
Handles object to string conversion.
-
formatWrapper() public
Output a dump wrapper with location context.
-
style() protected
Style text with HTML class names
Method Detail
dump() ¶ public
dump(Cake\Error\Debug\NodeInterface $node): stringConvert a tree of NodeInterface objects into HTML
Parameters
-
Cake\Error\Debug\NodeInterface$node The node tree to dump.
Returns
stringdumpHeader() ¶ protected
dumpHeader(): stringGenerate the CSS and Javascript for dumps
Only output once per process as we don't need it more than once.
Returns
stringenvironmentMatches() ¶ public static
environmentMatches(): boolCheck if the current environment is not a CLI context
Returns
boolexport() ¶ protected
export(Cake\Error\Debug\NodeInterface $var, int $indent): stringConvert a tree of NodeInterface objects into HTML
Parameters
-
Cake\Error\Debug\NodeInterface$var The node tree to dump.
-
int$indent The current indentation level.
Returns
stringexportArray() ¶ protected
exportArray(Cake\Error\Debug\ArrayNode $var, int $indent): stringExport an array type object
Parameters
-
Cake\Error\Debug\ArrayNode$var The array to export.
-
int$indent The current indentation level.
Returns
stringExported array.
exportObject() ¶ protected
exportObject(Cake\Error\Debug\ClassNode|Cake\Error\Debug\ReferenceNode $var, int $indent): stringHandles object to string conversion.
Parameters
-
Cake\Error\Debug\ClassNode|Cake\Error\Debug\ReferenceNode$var Object to convert.
-
int$indent The current indentation level.
Returns
stringSee Also
formatWrapper() ¶ public
formatWrapper(string $contents, array $location): stringOutput a dump wrapper with location context.
Parameters
-
string$contents -
array$location
Returns
stringstyle() ¶ protected
style(string $style, string $text): stringStyle text with HTML class names
Parameters
-
string$style The style name to use.
-
string$text The text to style.
Returns
stringThe styled output.