VELOX API Docs

Dumper

in package

• Velox
• Helper

A class that dumps variables and exception in a nice formatting.

Tags

since

1.0.0

Table of Contents

VAR_DUMP_CONVERSIONS  = [ // replace unnecessary line breaks after arrow with spaces only '/(=>)\s*(.+)/' => ' $1 $2', // replace opening curly brace with opening square bracket '/{\n/' => "[ ", // replace closing curly brace with closing square bracket '/}\n/' => "] ", // replace multiline empty square brackets with single line square brackets '/\[\n\s*\]/' => "[]", // add comma to all line endings except the ones wrapped in double quotes and the ones preceded by opening brackets '/(?<!\[)\n(?=([^"]*["][^"]*["])*[^"]*$)/' => ", ", // add object type info as comment after array opening bracket '/&?(object\(.+\))(#\d+) \(\d+\) (\[)/' => '/* $1 [SPL-ID: $2] */ $3', // add resource type info as comment in a single line '/&?(resource\(\d+\) ([\w ]+) \((\w+)\))(,)*/' => '/* $1 */ "$3"$4', // remove the type hint and variable length for strings, and arrays at the beginning of line '/^&?(?:string|array|\w+)(\(.+\)) /m' => '', // remove the type hint and variable length for strings, and arrays after arrow '/(=>) &?(?:string|array|\w+)(\(.+\)) ([\["])/' => '$1 $3', // replace bool($var), int($var), float($var) with $var '/&?(?:bool|int|float)\((.+?)\)/' => '$1', // replace NULL with null '/NULL/' => 'null', // replace all backslashes with escaped backslashes '/(\\)/' => '\\$1', // replace all single quotes with an escaped single quotes '/(')/' => '\\$1', // replace private visibility with a better formatted one '/\["(.+?)":"(.+)":(private)\]/' => '["$1":$3($2)]', // replace key with visibility in double quotes in square brackets with key in single quotes and add visibility as comment '/\["(.+?)":(.+?)\] (=>) (.+)/' => "'$1' $3 /* $2 */ $4", // replace key in double quotes in square brackets with key in single quotes '/\["(.*)"\] (=>)/' => "'$1' $2", // replace numeric key in square brackets with key '/\[(-?\d+)\] (=>)/' => '$1 $2', // replace string opening double quotes with single quotes '/(=>)([ ]\/\*.*\*\/)? "/' => "$1$2 '", // replace string closing double quotes with single quotes '/(.+)"(,)( \/\/.*)?\n/' => "$1'$2$3 ", // replace double quotes at the beginning of line with single quotes '/^"/m' => "'", // combine consequent comments with semicolon '/[ ]\*\/ \/\*[ ]/' => '; ', // replace *RECURSION* with __RECURSION__ '/\*(RECURSION)\*/' => '__$1__', ]

Regular expressions to transform `var_dump()` result from var dump syntax to a valid square brackets array (`[]`).

VAR_EXPORT_CONVERSIONS  = [ // replace array construct opening alone '/array \(/' => '[', // replace array construct opening inside a function call '/(\()array\(/' => '$1[', // replace array construct opening for stdClass '/\(object\) array\(/' => '(object)[', // replace array construct closing not part of a string '/\)(\))(?=([^']*'[^']*')*[^']*$)/' => ']$1', // replace array construct closing alone '/^([ ]*)\)(,?)$/m' => '$1]$2', // replace array construct closing inside a function call '/(\n)([ ]*)\]\)/' => '$1$2])', // replace array key with nested array '/([ ]*)('[^']+') => ([\['])/' => '$1$2 => $3', // replace array construct/bracket opening after arrow with newline and spaces '/=>[ ]?\n[ ]+(\[|\()/' => '=> $1', // replace any valid php after arrow with a newline and spaces '/=>[ ]?\n[ ]+([a-zA-Z0-9_\x7f-\xff])/' => '=> $1', // replace empty array brackets array with a newline and spaces '/\[[ ]?\n[ ]*\]/' => '[]', // replace NULL with null '/NULL/' => 'null', ]

Regular expressions to transform `var_export()` result from array construct (`array()`) to valid square brackets array (`[]`).

$accentColor  : string

Accent color of exceptions page and dump block.

$contrastColor  : string

Contrast color of exceptions page and dump block.

$styles  : array<string|int, mixed>

Dumper CSS styles.

$syntaxHighlightColors  : array<string|int, mixed>

Colors of syntax tokens.

$syntaxHighlightStyles  : array<string|int, mixed>

Additional CSS styling of syntax tokens.

$useVarDump  : bool

Whether or not to use `var_dump()` instead of `var_export()` to dump the variables.

$syntaxHighlightTokens  : array<string|int, mixed>

PHP highlighting syntax tokens.

dd()  : void

Dumps a variable and dies.

dump()  : void

Dumps a variable in a nice HTML block with syntax highlighting.

dumpException()  : void

Dumps an exception in a nice HTML page or as string and exits the script.

exportExpression()  : string

Dumps an expression using `var_export()` or `var_dump()`.

varDump()  : string

Returns dump of the passed variable using `var_dump()`.

varExport()  : string

Returns dump of the passed variable using `var_export()`.

exportExpressionWithSyntaxHighlighting()  : string

Dumps an expression using `var_export()` or `var_dump()` with syntax highlighting.

getAnsiCodeFromHexColor()  : int

Converts a hex color to the closest standard ANSI color code.

getDumpingBlocks()  : void

Returns an array containing HTML/ANSI wrapping blocks.

getValidCallerTrace()  : string

Returns the last caller trace before `dd()` or `dump()` if the format of `file:line`.

highlightFile()  : string

Highlights the passed file with the possibility to focus a specific line.

isCli()  : bool

Checks whether the script is currently running in CLI mode or not.

setSyntaxHighlighting()  : void

Sets PHP syntax highlighting colors according to current class state.

tabulateStacktrace()  : string

Tabulates the passed stacktrace in an HTML table.