Revision: Thu, 22 Feb 2024 17:58:45 GMT
v2.14 – outdated
This version of the documentation is outdated. Consider upgrading your project to Spiral Framework 3.11
Edit this page

Debug - Dumping Variables

Use Spiral\Debug\Dumper class or function dump to view content of your variables and instances without xDebug:

php
use Spiral\Debug\Dumper;

protected function indexAction(Dumper $dumper, MemcacheStore $memcacheStore)
{
    $dumper->dump($memcacheStore);
}
php
protected function indexAction(MemcacheStore $memcacheStore)
{
    dump($memcacheStore);
}

The Spiral Dumper supports the __debugInfo method which allows you to dump only relevant information.

Usage

In your code (works in web and CLI SAPIs):

php
$d = new \Spiral\Debug\Dumper\Dumper();

$d->dump($variable);

Dump to Log:

php
$d = new \Spiral\Debug\Dumper\Dumper();

$d->dump($variable, Debug\Dumper::LOGGER);

Dump to STDERR:

php
$d = \Spiral\Debug\Dumper\Dumper($loggerInterface);

$d->dump($variable, Debug\Dumper::STDERR);

Force dump to STDERR with color support:

php
use Spiral\Debug;

$d = new Debug\Dumper($loggerInterface);
$d->setRenderer(Debug\Dumper::STDERR, new Debug\Renderer\ConsoleRenderer());

$d->dump($variable, Debug\Dumper::STDERR);

You can use function dump as a shortcut. Use dumprr to dump to the RoadRunner error log.

Internal Fields

To hide specific fields of your objects without the __debugInfo method, add an "@internal" annotation to your property.

php
class TestService
{
    /** @internal */
    protected ContainerInterface $container = null;
}

In RoadRunner

You can dump variable into roadrunner debug log using function dumprr. Make sure to use this function in your job handlers.