 |
VOOZH | about |
|
VOOZH | about |
The Enhanced VarDumper system extends Symfony's VarDumper component to provide automatic source file resolution, compiled view origin tracking, and editor link generation when debugging with dump() or dd(). This system intercepts variable dumps and augments them with contextual information about where the dump call originated, making debugging significantly more efficient.
For information about monitoring and observability in production, see Telescope Monitoring System.
The Enhanced VarDumper system consists of two dumper implementations that extend Symfony's base dumpers, a shared trait for source resolution logic, and automatic registration through the FoundationServiceProvider.
Sources: src/foundation/src/Providers/FoundationServiceProvider.php181-201 src/foundation/src/Console/CliDumper.php1-103 src/foundation/src/Http/HtmlDumper.php1-115 src/foundation/src/Concerns/ResolvesDumpSource.php1-191
| Component | Location | Purpose |
|---|---|---|
CliDumper | src/foundation/src/Console/CliDumper.php | CLI-formatted dumps with ANSI colors and hyperlinks |
HtmlDumper | src/foundation/src/Http/HtmlDumper.php | HTML-formatted dumps for web requests |
ResolvesDumpSource | src/foundation/src/Concerns/ResolvesDumpSource.php | Shared logic for backtrace analysis and source resolution |
FoundationServiceProvider::registerDumper() | src/foundation/src/Providers/FoundationServiceProvider.php181-201 | Automatic registration during framework bootstrap |
Sources: src/foundation/src/Console/CliDumper.php src/foundation/src/Http/HtmlDumper.php src/foundation/src/Concerns/ResolvesDumpSource.php src/foundation/src/Providers/FoundationServiceProvider.php
The system automatically selects and registers the appropriate dumper based on the execution context.
Sources: src/foundation/src/Providers/FoundationServiceProvider.php181-201
The ResolvesDumpSource trait implements sophisticated backtrace analysis to determine where dump() was called.
The system walks the debug backtrace to find the originating call site, with special handling for wrapper functions:
Sources: src/foundation/src/Concerns/ResolvesDumpSource.php56-113
Certain files require special offset handling in the backtrace to correctly identify the actual call site:
| File Pattern | Offset | Reason |
|---|---|---|
symfony/var-dumper/Resources/functions/dump.php | +1 | Global dump() function wraps the actual dumper |
Sources: src/foundation/src/Concerns/ResolvesDumpSource.php40-42
One of the most powerful features is the ability to trace dumps in compiled Blade views back to their original source files.
Sources: src/foundation/src/Concerns/ResolvesDumpSource.php118-139
Blade compiles views into PHP files that include a special comment marker:
The getOriginalFileForCompiledView() method extracts this path using the regex /\/\*\*PATH\s(.*)\sENDPATH/.
Sources: src/foundation/src/Concerns/ResolvesDumpSource.php130-139 tests/Foundation/fixtures/fake-compiled-view.php9
The system generates clickable links that open files in your preferred editor at the specific line number.
The $editorHrefs array defines URL schemes for popular editors:
| Editor | URL Scheme | Example |
|---|---|---|
atom | atom://core/open/file?filename={file}&line={line} | Atom editor |
cursor | cursor://file/{file}:{line} | Cursor editor |
phpstorm | phpstorm://open?file={file}&line={line} | PhpStorm/IntelliJ |
vscode | vscode://file/{file}:{line} | Visual Studio Code |
vscode-insiders | vscode-insiders://file/{file}:{line} | VSCode Insiders |
vscode-remote | vscode://vscode-remote/{file}:{line} | VSCode Remote |
sublime | subl://open?url=file://{file}&line={line} | Sublime Text |
emacs | emacs://open?url=file://{file}&line={line} | Emacs |
textmate | txmt://open?url=file://{file}&line={line} | TextMate |
nova | nova://core/open/file?filename={file}&line={line} | Nova |
macvim | mvim://open/?url=file://{file}&line={line} | MacVim |
netbeans | netbeans://open/?f={file}:{line} | NetBeans |
xdebug | xdebug://{file}@{line} | Xdebug |
Sources: src/foundation/src/Concerns/ResolvesDumpSource.php16-33
Editor links are configured via the app.editor configuration key. Multiple formats are supported:
For Docker or remote environments where the file path on the host differs from the container:
For editors not in the predefined list or custom URL schemes:
Sources: src/foundation/src/Concerns/ResolvesDumpSource.php146-171 tests/Foundation/Http/HtmlDumperTest.php215-288
The CLI dumper outputs dumps with source information appended as a gray comment.
Sources: src/foundation/src/Console/CliDumper.php56-76
The getDumpSourceContent() method formats the source information with ANSI color codes and optional hyperlinks:
When a file is a compiled view, the line number is omitted since it cannot be accurately mapped back to the original view.
Sources: src/foundation/src/Console/CliDumper.php81-97
Creates a VarCloner with UNSET_CLOSURE_FILE_INFO casters to hide internal closure details, then sets the global VarDumper handler to use the CliDumper instance.
Sources: src/foundation/src/Console/CliDumper.php46-53
The HTML dumper injects source information as styled HTML spans within the dump output.
The dumper searches for specific separators in the dump HTML to determine where to inject source information:
Sources: src/foundation/src/Http/HtmlDumper.php65-94
The getDumpSourceContent() method generates a gray-colored span with an optional hyperlink:
Sources: src/foundation/src/Http/HtmlDumper.php99-114
| Constant | Value | Purpose |
|---|---|---|
EXPANDED_SEPARATOR | 'class=sf-dump-expanded>' | Injection point for expanded dumps (arrays, objects) |
NON_EXPANDED_SEPARATOR | "\n</pre><script>" | Injection point for non-expanded dumps (scalars) |
Sources: src/foundation/src/Http/HtmlDumper.php23-30
The system allows complete customization of source resolution logic.
Sources: src/foundation/src/Concerns/ResolvesDumpSource.php178-181
To completely disable source information in dumps:
This sets the internal resolver to false, causing resolveDumpSource() to always return null.
Sources: src/foundation/src/Concerns/ResolvesDumpSource.php186-189
The dumpers are configured with default casters to prevent dumping internal framework objects:
These casters use StubCaster::cutInternals to hide internal properties that would create noisy, unhelpful dumps.
Sources: src/foundation/src/Providers/FoundationServiceProvider.php183-186
Both dumpers implement a $dumping flag to prevent infinite recursion:
This prevents issues when the dumper needs to call dump() internally while generating source content.
Sources: src/foundation/src/Console/CliDumper.php60-64 src/foundation/src/Http/HtmlDumper.php67-71
The VAR_DUMPER_FORMAT environment variable overrides automatic dumper selection:
| Value | Behavior |
|---|---|
html | Force HtmlDumper |
cli | Force CliDumper |
server | Use Symfony's server dumper (no source resolution) |
tcp://host:port | Use Symfony's TCP dumper (no source resolution) |
| (not set) | Auto-detect based on php_sapi_name() |
Sources: src/foundation/src/Providers/FoundationServiceProvider.php192-200
The dumpers include comprehensive test coverage demonstrating all features:
| Test | Purpose |
|---|---|
| Primitive types | Verify correct output for strings, integers, floats, booleans, null |
| Arrays and objects | Verify expanded format with source injection |
| Compiled view detection | Test isCompiledViewFile() logic |
| Original view extraction | Test PATH comment parsing |
| Editor href generation | Test all configuration formats |
| Unresolvable sources | Test graceful fallback when source cannot be determined |
| Custom resolvers | Test resolveDumpSourceUsing() API |
Sources: tests/Foundation/Console/CliDumperTest.php tests/Foundation/Http/HtmlDumperTest.php
Refresh this wiki