spiral/dumper

Dumper for PHP variables based on Symfony VarDumper for Spiral Framework and RoadRunner

3.3.0 2024-06-06 21:16 UTC

Requires

• php: >= 8.1
• buggregator/trap: ^1.8
• spiral/boot: ^3.7
• symfony/var-dumper: ^6.1 || ^7.0

Requires (Dev)

• psr/http-factory: ^1.0
• psr/http-server-middleware: ^1.0
• vimeo/psalm: ^5.14

MIT

• Anton Titov (wolfy-j)
• Pavel Buchnev (butschster)
• Aleksei Gagarin (roxblnfk)
• Maksim Smakouz (msmakouz)

README

Spiral: Colorful variable dumper

With spiral/dumper, developers can easily inspect and analyze variable values during the development process, making it an indispensable tool for debugging and troubleshooting in web and CLI applications.

The component provides a wrapper over the symfony/var-dumper library. This component sends dumps directly to the browser within HTTP workers or to the STDERR output in other environments.

Documentation

Installation

Use Composer to install the package:

composer require spiral/dumper

Usage

Symfony VarDumper

In your code:

dump($variable);

In an application using RoadRunner, you cannot use the dd() function. But the package provides an alternative \rr\dd() function. To use it, you need to add Spiral\Debug\Middleware\DumperMiddleware in the application, after ErrorHandlerMiddleware:

use Spiral\Bootloader\Http\RoutesBootloader as BaseRoutesBootloader;
use Spiral\Debug\Middleware\DumperMiddleware;
use Spiral\Http\Middleware\ErrorHandlerMiddleware;

final class RoutesBootloader extends BaseRoutesBootloader
{
    protected function globalMiddleware(): array
    {
        return [
            ErrorHandlerMiddleware::class,
            DumperMiddleware::class,
            // ...
        ];
    }

    // ...
}

Buggregator

The package provides a built-in integration with the Buggregator service via Trap library.

1. Run a Buggregator server:
   • Full server using Docker:

     docker run --rm --pull always -p 127.0.0.1:8000:8000 -p 127.0.0.1:1025:1025 -p 127.0.0.1:9912:9912 -p 127.0.0.1:9913:9913 ghcr.io/buggregator/server:latest

   • Mini server using PHP:

     ./vendor/bin/trap

2. Use trap() function instead of dump() to send dumps to the Buggregator server:

   trap($variable);

License

The MIT License (MIT). Please see LICENSE for more information. Maintained by SpiralScout.