Symfony VarDumper

https://github.com/symfony/var-dumper
Admin
The VarDumper component provides a better dump() function for inspecting PHP variables, offering...
Tokens:100,606
Snippets:561
Trust Score:9.5
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Run var-dump-server with --host option

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/server.md

Starts the dump server on a specified host and port. The default host is '127.0.0.1:9912'.

```bash
php bin/var-dump-server --host=0.0.0.0:9913
```

--------------------------------

### DumpServer::start

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/server.md

Binds the listening socket using stream_socket_server(). Throws a RuntimeException if the server fails to start.

```APIDOC
## DumpServer::start

### Description
Binds the listening socket using `stream_socket_server()`. Throws a `\RuntimeException` on failure.

### Method
start

### Signature
```php
public function start(): void;
```

### Parameters
None

### Return Value
void

### Exceptions
- **\RuntimeException** - Thrown if the server fails to start. The message includes the host and error details.

### Usage Example
```php
$server->start();
```
```

--------------------------------

### Custom Caster Registration

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/caster-registry.md

Shows how to write and register a custom caster for a class, either per-instance or globally. The example demonstrates trimming and adding a virtual property.

```APIDOC
## Custom Caster Registration

### Description
Shows how to write and register a custom caster for a class, either per-instance or globally. The example demonstrates trimming and adding a virtual property.

### Method
`function (mixed $obj, array $a, Stub $stub, bool $isNested, int $filter = 0): array`

### Parameters
- `$obj` (object|resource) - Required - The object or resource to cast.
- `$a` (array) - Required - The array of properties.
- `$stub` (Stub) - Required - The stub object; can be mutated: `$stub->class`, `$stub->value` (replace object), `$stub->cut`, `$stub->attr`.
- `$isNested` (bool) - Required - Whether the cast is nested.
- `$filter` (int) - Optional - Filter for properties.

### Registration Options
1. Per-instance: `$cloner->addCasters(['My\Class' => 'My\Caster::castMyClass'])`.
2. Globally for all future cloners: `VarCloner::addDefaultCasters([...])`.
3. Resource types are keyed with a leading `:` — `$cloner->addCasters([':mystream' => ...])`.

### Example
```php
use Symfony\Component\VarDumper\Cloner\VarCloner;
use Symfony\Component\VarDumper\Caster\Caster;

$cloner = new VarCloner();
$cloner->addCasters([
    My\Entity::class => static function (My\Entity $e, array $a, Stub $stub, bool $isNested, int $filter): array {
        $a = Caster::filter($a, $filter, ['createdAt'], $count);
        $a[Caster::PREFIX_VIRTUAL.'display_name'] = $e->displayName();
        return $a;
    },
]);
$dumper->dump($cloner->cloneVar($entity));
```
```

--------------------------------

### Run var-dump-server with VAR_DUMPER_SERVER environment variable

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/server.md

Starts the dump server using the host and port from the VAR_DUMPER_SERVER environment variable, overriding the default.

```bash
VAR_DUMPER_SERVER=127.0.0.1:9912 php bin/var-dump-server
```

--------------------------------

### DumpServer usage example

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/server.md

Shows how to instantiate DumpServer with a host and NullLogger, then listen for incoming dumps. The callback receives the data, context, and client ID; here it exports the source name from context.

```php
use Psr\Log\NullLogger;
use Symfony\Component\VarDumper\Server\DumpServer;

$server = new DumpServer('127.0.0.1:9912', new NullLogger());
$server->listen(static function ($data, array $context, int $clientId): void {
    var_export($context['source']['name'] ?? 'unknown');
    // render $data with a dumper…
});
```

--------------------------------

### DumpServer::listen

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/server.md

Starts a blocking loop that accepts client connections and processes incoming dump data. It calls start() if needed and invokes the provided callback for each valid payload.

```APIDOC
## DumpServer::listen

### Description
Starts a blocking loop that accepts client connections and processes incoming dump data. It calls `start()` if needed and invokes the provided callback for each valid payload.

### Method
listen

### Signature
```php
public function listen(callable $callback): void;
```

### Parameters
- **$callback** (callable) - Required - A callback invoked for each valid payload. The callback receives three arguments: `Data $data`, `array $context`, and `int $clientId`.

### Return Value
void

### Behavior
- Uses `stream_select()` over all accepted client sockets.
- For each complete line, decodes the payload, validates it, and invokes the callback.
- Runs forever; interrupted by CONTROL-C or any interruption.
- If the payload cannot be decoded (base64/serialize), logs `'Unable to decode a message from {clientId} client.'` and skips.
- If the payload shape is invalid (not a 2-element array of `Data` + array), logs `'Invalid payload from {clientId} client. Expected an array of two elements (Data $data, array $context)'` and skips.

### Usage Example
```php
$server->listen(static function ($data, array $context, int $clientId): void {
    var_export($context['source']['name'] ?? 'unknown');
    // render $data with a dumper…
});
```
```

--------------------------------

### DumpServer class definition

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/server.md

Defines the DumpServer class with constructor, start(), listen(), and getHost() methods. The constructor requires a host string and optionally accepts a PSR-3 logger. start() binds the socket and throws RuntimeException on failure; listen() runs a blocking loop and invokes the callback with decoded data.

```php
/**
 * @final
 */
class DumpServer
{
    public function __construct(
        string $host,
        private ?LoggerInterface $logger = null,
    );

    public function start(): void;

    /**
     * @param-immediately-invoked-callable $callback
     */
    public function listen(callable $callback): void;

    public function getHost(): string;
}
```

--------------------------------

### CliContextProvider usage example

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/context-providers.md

Instantiates CliContextProvider and calls getContext(). Returns an array with command_line and identifier keys, e.g., ['command_line' => 'php bin/console app:run', 'identifier' => 'ab12cd…'].

```php
use Symfony\Component\VarDumper\Dumper\ContextProvider\CliContextProvider;

$ctx = (new CliContextProvider())->getContext();
// ['command_line' => 'php bin/console app:run', 'identifier' => 'ab12cd…']
```

--------------------------------

### Full consumer flow example

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/cloner-data.md

Complete example using VarCloner and CliDumper to clone and traverse data, including error handling for immutable Data objects.

```php
use Symfony\Component\VarDumper\Cloner\VarCloner;
use Symfony\Component\VarDumper\Dumper\CliDumper;

$cloner = new VarCloner();
$data = $cloner->cloneVar(['users' => [['id' => 1], ['id' => 2]]]);

printf("type=%s count=%d\n", $data->getType(), $data->count());
// type=array count=1

$users = $data->seek('users');           // Data positioned on the 'users' array
foreach ($users as $i => $u) {
    echo $i . ' => id=' . $u->seek('id')->getValue() . "\n";
}

// Handle immutable errors:
try {
    $data['new'] = 'x';
} catch (\BadMethodCallException $e) {
    echo $e->getMessage(); // ...Data objects are immutable.
}
```

--------------------------------

### SourceContextProvider usage example

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/context-providers.md

Shows how to instantiate SourceContextProvider with a project directory and call getContext(). The returned array includes name, file, line, file_excerpt, project_dir, and file_relative keys. file_excerpt is false for non-Twig dump sites.

```php
use Symfony\Component\VarDumper\Dumper\ContextProvider\SourceContextProvider;

$provider = new SourceContextProvider(null, __DIR__);
$ctx = $provider->getContext();
// ['name' => 'index.php', 'file' => '/app/index.php', 'line' => 42, 'file_excerpt' => false, 'project_dir' => '/app', 'file_relative' => 'index.php']
```

--------------------------------

### Example usage of VarDumperTestTrait

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/test-trait.md

Shows a complete test case using the trait to assert exact dumps, format patterns, and filtered dumps.

```php
use PHPUnit\Framework\TestCase;
use Symfony\Component\VarDumper\Test\VarDumperTestTrait;

final class MyDumpTest extends TestCase
{
    use VarDumperTestTrait;

    public function testUserDump(): void
    {
        $this->setUpVarDumper([
            My\Entity::class => My\Caster::castEntity(...),
        ], flags: CliDumper::DUMP_STRING_LENGTH);

        $user = new My\Entity('Ada');

        // Exact equality (auto-dump both sides):
        $this->assertDumpEquals("My\Entity {\n  +name: \"Ada\"\n}", $user);

        // Pattern with placeholders:
        $this->assertDumpMatchesFormat("My\\Entity {\n  +name: \"%s\"\n}", $user);

        // Filter internals while asserting:
        $this->assertDumpEquals(['visible' => 1], $user, Caster::EXCLUDE_NOT_IMPORTANT);
    }
}
```

--------------------------------

### HtmlDumper usage example

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/dumper.md

Shows how to instantiate HtmlDumper, set a theme, apply CSP nonces, and configure display options. The dump() call demonstrates per-call override of maxDepth and maxStringLength.

```php
use Symfony\Component\VarDumper\Cloner\VarCloner;
use Symfony\Component\VarDumper\Dumper\HtmlDumper;

$dumper = new HtmlDumper();
$dumper->setTheme('light');
$dumper->setNonce('script-nonce-value', 'style-nonce-value'); // CSP
$dumper->setDisplayOptions(['maxDepth' => 5, 'maxStringLength' => 300]);

$html = $dumper->dump($cloner->cloneVar($user), true, ['maxDepth' => 2]); // per-call override
```

--------------------------------

### Usage example with CliDumper and custom line dumper

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/dumper.md

Shows how to clone data with VarCloner, dump to stdout, return as string, and set a custom line dumper via setOutput().

```php
use Symfony\Component\VarDumper\Cloner\VarCloner;
use Symfony\Component\VarDumper\Dumper\CliDumper;

$cloner = new VarCloner();
$data = $cloner->cloneVar(['a' => 1, 's' => 'hello']);

$dumper = new CliDumper();
$dumper->dump($data);                                  // to php://stdout

$string = (new CliDumper())->dump($data, true);        // return as string
$prev = $dumper->setOutput(fn (string $line, int $depth, string $pad) => error_log($pad . $line));
$dumper->dump($data);                                  // via custom line dumper
```

--------------------------------

### RequestContextProvider usage example

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/context-providers.md

Shows how to instantiate RequestContextProvider with a RequestStack and call getContext(). The returned array contains keys uri, method, controller, and identifier. The controller value is cloned with an internal VarCloner when truthy.

```php
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\VarDumper\Dumper\ContextProvider\RequestContextProvider;

$requestStack = new RequestStack();
$requestStack->push($request);
$ctx = (new RequestContextProvider($requestStack))->getContext();
// ['uri' => 'https://…', 'method' => 'GET', 'controller' => Data, 'identifier' => '…']
```

--------------------------------

### Using VarCloner with setMaxString and setMaxItems

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/cloner.md

Example of instantiating VarCloner, configuring limits, and cloning a variable. The string is cut at 50 characters due to setMaxString(50).

```php
use Symfony\Component\VarDumper\Cloner\VarCloner;

$cloner = new VarCloner();
$cloner->setMaxString(50);
$cloner->setMaxItems(1000);
$data = $cloner->cloneVar(['payload' => str_repeat('x', 1000)]); // string cut at 50 chars
```

--------------------------------

### ContextualizedDumper usage example

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/dumper.md

Shows how to instantiate ContextualizedDumper with a CliDumper and a SourceContextProvider, then dump a cloned variable. The context provider adds source information to the dump.

```php
use Symfony\Component\VarDumper\Dumper\CliDumper;
use Symfony\Component\VarDumper\Dumper\ContextProvider\SourceContextProvider;
use Symfony\Component\VarDumper\Dumper\ContextualizedDumper;

$dumper = new ContextualizedDumper(new CliDumper(), [
    new SourceContextProvider(null, __DIR__),
]);
$dumper->dump($cloner->cloneVar($var));
```

--------------------------------

### ServerDumper usage example

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/dumper.md

Shows how to instantiate ServerDumper with a host and a CliDumper as local fallback, then dump a cloned variable. The dumper attempts to send the dump to the server at the given host.

```php
use Symfony\Component\VarDumper\Dumper\CliDumper;
use Symfony\Component\VarDumper\Dumper\ServerDumper;

$dumper = new ServerDumper('127.0.0.1:9912', new CliDumper()); // local fallback
$dumper->dump($cloner->cloneVar($var));
```

--------------------------------

### Caster::filter() usage examples

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/caster.md

Shows how to use Caster::filter() to drop nulls, empties, and a deprecated property, and to keep only listed properties. The first example uses EXCLUDE_NULL, EXCLUDE_EMPTY, and EXCLUDE_VERBOSE with a list of properties to exclude. The second uses EXCLUDE_NOT_IMPORTANT to preserve only the listed properties.

```php
$props = Caster::castObject($object, SomeClass::class);

// Drop nulls, empties and the deprecated 'legacy' property:
$kept = Caster::filter($props, Caster::EXCLUDE_NULL | Caster::EXCLUDE_EMPTY | Caster::EXCLUDE_VERBOSE, ['legacy'], $count);

// Keep nothing but the listed properties:
$important = Caster::filter($props, Caster::EXCLUDE_NOT_IMPORTANT, ['id', 'name']);
```

--------------------------------

### dump() usage examples

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/var-dumper.md

Shows how dump() returns the single argument when called with one argument, and returns the whole array when called with multiple arguments. Labels are 1-based for integer keys and use string keys as-is.

```php
$result = dump($user);             // dumps $user, returns $user
dump($user, $profile, 'extra' => $x); // three labeled dumps; returns [$user, $profile, 'extra' => $x]
```

--------------------------------

### dd() usage example

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/var-dumper.md

Stops execution and dumps variables on a code path. Prints both variables and exits with status code 1.

```php
// Stop execution and dump on a code path:
dd($request, $response); // prints both, exits with status code 1
```

--------------------------------

### Minimal custom caster example

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/caster.md

A minimal custom caster that filters properties and adds a virtual status property. It uses Caster::filter() and Caster::PREFIX_VIRTUAL to modify the property array.

```php
// A minimal custom caster:
function castMyService(MyService $s, array $a, Stub $stub, bool $isNested, int $filter): array
{
    $a = Caster::filter($a, $filter, ['logger'], $count);
    $a[Caster::PREFIX_VIRTUAL.'status'] = $s->isReady() ? 'ready' : 'down';

    return $a;
}
```

--------------------------------

### Rendering stubs from user code

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/caster-stubs.md

Example of a custom caster method that uses LinkStub, EnumStub, TraceStub, and CutStub to enrich the array representation.

```php
use Symfony\Component\VarDumper\Caster\Caster;
use Symfony\Component\VarDumper\Caster\CutStub;
use Symfony\Component\VarDumper\Caster\LinkStub;
use Symfony\Component\VarDumper\Caster\TraceStub;
use Symfony\Component\VarDumper\Caster\EnumStub;

function castMyObject(MyObject $o, array $a, Stub $stub, bool $isNested, int $filter): array
{
    $a[Caster::PREFIX_VIRTUAL.'link'] = new LinkStub(__FILE__, __LINE__);
    $a[Caster::PREFIX_VIRTUAL.'states'] = new EnumStub(['new', 'done']);
    $a[Caster::PREFIX_VIRTUAL.'trace'] = new TraceStub(debug_backtrace(), keepArgs: false, sliceOffset: 1);
    $a[Caster::PREFIX_VIRTUAL.'internal'] = new CutStub($o->secret); // hidden, counted as cut

    return $a;
}
```

--------------------------------

### ConstStub::fromBitfield usage example

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/caster-stubs.md

Shows how to create a ConstStub from a bitfield value. With value 3 and named bits 1 and 2, the resulting name is 'read | write' and the value is 3.

```php
$stub = ConstStub::fromBitfield(3, [0 => 'none', 1 => 'read', 2 => 'write']);
// name 'read | write', value 3
```

--------------------------------

### CliDumper usage example

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/dumper.md

Instantiate CliDumper with UTF-8 charset and flags DUMP_STRING_LENGTH | DUMP_TRAILING_COMMA. Disables colors for plain text output, sets max string width to 80, configures fileLinkFormat for VS Code, then dumps $data.

```php
use Symfony\Component\VarDumper\Dumper\CliDumper;

$dumper = new CliDumper(null, 'UTF-8', CliDumper::DUMP_STRING_LENGTH | CliDumper::DUMP_TRAILING_COMMA);
$dumper->setColors(false);      // plain text output
$dumper->setMaxStringWidth(80);
$dumper->setDisplayOptions(['fileLinkFormat' => 'vscode://file/%f:%l']);
$dumper->dump($data);
```

--------------------------------

### LinkStub constructor signature

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/caster-stubs.md

Creates a stub for a file or URL link. The href defaults to the label; file:// prefixes are stripped, :// URLs become a plain href attribute, and existing files get path ellipsization relative to the composer root, which also sets the public $inVendor flag.

```php
class LinkStub extends ConstStub
{
    public bool $inVendor = false;

    public function __construct(string $label, int $line = 0, ?string $href = null)
}
```

--------------------------------

### getValue() usage example

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/cloner-data.md

Shows how to use getValue() with and without recursion. The first call returns one level of children as plain array; the second call with true resolves nested structures recursively.

```php
$data = $cloner->cloneVar(['a' => [1, 2], 'b' => 'x']);

var_dump($data->getValue());
// ['a' => Data, 'b' => 'x']

$nested = $data->getValue(true);
var_dump($nested['a']);            // [1, 2] — recursively resolved
var_dump($nested['a'][0]);         // 1
```

--------------------------------

### CutStub constructor signature

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/caster-stubs.md

Represents a value the caster decided not to expand. Objects and resources get cut = -1 (type/class kept, contents hidden; closures additionally get their reflection info), arrays get cut = count, and strings keep their length as cut with an empty value.

```php
class CutStub extends Stub
{
    public function __construct(mixed $value)
}
```

--------------------------------

### setUpVarDumper method signature

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/test-trait.md

Sets up the test cloner with additional casters and optional flags. Flags default to null, deriving from environment variables.

```php
/**
 * @param array<string, callable> $casters
 */
protected function setUpVarDumper(array $casters, ?int $flags = null): void
```

--------------------------------

### AbstractDumper Constructor and Setters

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/configuration.md

Configures the base dumper with output, charset, flags, and indentation.

```APIDOC
## AbstractDumper Constructor and Setters

### Description
Sets up the base dumper with output destination, charset, flags, and indentation.

### Method
Constructor

### Endpoint
`__construct($output, $charset, $flags)`

### Parameters
#### Constructor Parameters
- **output** (`callable|resource|string|null`) - Optional - Line-dumper callable, stream, or output path; defaults to `static::$defaultOutput` (`php://output`; `CliDumper` overrides to `php://stdout`).
- **charset** (`?string`) - Optional - Encoding for non-UTF-8 strings; defaults to ini fallbacks → `'UTF-8'` (`'UTF-8'`/`'UTF8'` mapped to `'CP1252'`).
- **flags** (`int`) - Optional - Bit field of `DUMP_LIGHT_ARRAY | DUMP_STRING_LENGTH | DUMP_COMMA_SEPARATOR | DUMP_TRAILING_COMMA`; default `0`.

### Setters
- **setOutput($output)** - Sets the output destination.
- **setCharset(string)** - Sets the charset.
- **setIndentPad(string)** - Sets indentation unit per depth level; default `'  '` (two spaces).

### Per-Call Parameter
- **dump(Data, $output)** - `$output` (`callable|resource|string|true|null`) - Optional - If `true`, returns the dump string; default `null`.
```

--------------------------------

### setUpVarDumper()

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/test-trait.md

Configures the test cloner with additional casters and optional dump flags. This method should be called before performing dump assertions.

```APIDOC
## setUpVarDumper()

### Description
Configures the test cloner with additional casters and optional dump flags. This method should be called before performing dump assertions.

### Method
setUpVarDumper

### Parameters
- `$casters` (array<string, callable>) - Required - Additional casters for the test cloner.
- `$flags` (?int) - Optional - `CliDumper::DUMP_*` flags; `null` derives them from environment.

### Return Value
void
```

--------------------------------

### SourceContextProvider::__construct

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/context-providers.md

Creates a new SourceContextProvider instance. The constructor accepts optional parameters for charset, project directory, file link formatter, and backtrace limit.

```APIDOC
## [PHP] SourceContextProvider::__construct

### Description
Creates a new SourceContextProvider instance. The constructor accepts optional parameters for charset, project directory, file link formatter, and backtrace limit.

### Method
Constructor

### Endpoint
`SourceContextProvider::__construct(?string $charset = null, ?string $projectDir = null, ?FileLinkFormatter $fileLinkFormatter = null, int $limit = 9)`

### Parameters
#### Constructor Parameters
- **$charset** (?string) - Optional - Charset used to HTML-encode the code excerpt. Default: null.
- **$projectDir** (?string) - Optional - Project root; enables `project_dir`/`file_relative` keys and relative-path shortening. Default: null.
- **$fileLinkFormatter** (?FileLinkFormatter) - Optional - `symfony/error-handler` formatter producing `file_link`. Default: null.
- **$limit** (int) - Optional - Backtrace depth to walk. Default: 9.

### Request Example
```php
use Symfony\Component\VarDumper\Dumper\ContextProvider\SourceContextProvider;

$provider = new SourceContextProvider(null, __DIR__);
```

### Response
#### Success Response
Returns a new SourceContextProvider instance.

#### Response Example
```php
// No return value (constructor)
```
```

--------------------------------

### Using seek() to access object properties

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/cloner-data.md

Example of using seek() to find public and protected/private properties on a cloned object. Returns null if the key is not found or not navigable.

```php
$data = $cloner->cloneVar($user);   // $user is an object

$name = $data->seek('name');        // find public property
$secret = $data->seek('password');  // find (protected/private) property via prefix search
if (null !== $secret) {
    // ...
}
```

--------------------------------

### DumpServer::__construct

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/server.md

Creates a new DumpServer instance with the specified bind address and optional logger. The host is normalized to include the tcp:// prefix if missing.

```APIDOC
## DumpServer::__construct

### Description
Creates a new DumpServer instance with the specified bind address and optional logger. The host is normalized to include the tcp:// prefix if missing.

### Method
Constructor

### Signature
```php
public function __construct(
    string $host,
    private ?LoggerInterface $logger = null,
);
```

### Parameters
- **$host** (string) - Required - Bind address; `tcp://` prepended when missing.
- **$logger** (?LoggerInterface) - Optional - PSR-3 logger for logging received payloads and decode failures. Defaults to `null`.

### Usage Example
```php
use Psr\Log\NullLogger;
use Symfony\Component\VarDumper\Server\DumpServer;

$server = new DumpServer('127.0.0.1:9912', new NullLogger());
```
```

--------------------------------

### SourceContextProvider class definition

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/context-providers.md

Defines the SourceContextProvider class that implements ContextProviderInterface. The constructor accepts optional charset, projectDir, fileLinkFormatter, and limit parameters. getContext() walks the backtrace to find where the dump happened, skipping VarDumper::dump() and call_user_func* wrappers.

```php
final class SourceContextProvider implements ContextProviderInterface
{
    public function __construct(
        private ?string $charset = null,
        private ?string $projectDir = null,
        private ?FileLinkFormatter $fileLinkFormatter = null,
        private int $limit = 9,
    ) {
    }

    public function getContext(): ?array
}
```

--------------------------------

### Caster callback contract signature

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/caster.md

The shared signature for all casters, including custom ones, used by AbstractCloner::castObject() and castResource(). The fifth $filter parameter is optional in most built-in casters (default 0), and resource casters get the ':'-prefixed resource type as key.

```php
/**
 * @param mixed $objOrResource The object or resource being cast
 * @param array $a             The current property array
 * @param Stub  $stub          The Stub describing the value (set $stub->value to replace the object, $stub->class to rename, $stub->cut += n to mark cut items)
 * @param bool  $isNested      True when the value is nested inside the dumped structure
 * @param int   $filter        The bit field passed to AbstractCloner::cloneVar()
 */
function (mixed $obj, array $a, Stub $stub, bool $isNested, int $filter = 0): array
```

--------------------------------

### Connection::__construct

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/server.md

Creates a new Connection instance for client-side socket handling. The host parameter specifies the server address, and context providers can be supplied to enrich the dump context.

```APIDOC
## Connection::__construct

### Description
Creates a new Connection instance for client-side socket handling. The host parameter specifies the server address, and context providers can be supplied to enrich the dump context.

### Method
Constructor

### Signature
```php
public function __construct(
    string $host,
    private array $contextProviders = [],
)
```

### Parameters
- **$host** (string) - Required - Server address; `tcp://` is prepended when no scheme is present.
- **$contextProviders** (ContextProviderInterface[]) - Optional - Providers indexed by context name (each array key becomes a context key). Default: `[]`.

### Return Value
No return value (constructor).
```

--------------------------------

### AbstractCloner / VarCloner Constructor

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/configuration.md

Configures the cloner with casters and limits for cloning variables.

```APIDOC
## AbstractCloner / VarCloner Constructor

### Description
Sets up the cloner with a caster map and default limits for cloning.

### Method
Constructor

### Endpoint
`__construct(?array $casters)`

### Parameters
#### Constructor Parameters
- **casters** (`?array<string, callable>`) - Optional - Caster map; defaults to `static::$defaultCasters`.

### Setters
- **setMaxItems(int)** - Sets max items cloned past minimum depth; default `2500`, `-1` unlimited.
- **setMaxString(int)** - Sets max cloned string length; default `-1` (unlimited), `0` truncates all strings.
- **setMinDepth(int)** - Sets depth where exhaustive cloning is guaranteed before `maxItems` applies; default `1`.

### Per-Call Parameter
- **filter** (`int`) - Optional - `Caster::EXCLUDE_*` bit field forwarded to casters; default `0`.

### Static Method
- **AbstractCloner::addDefaultCasters(array)** - Extends the static caster registry for all future cloners.
```

--------------------------------

### VarCloner class declaration with doClone method

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/cloner.md

Shows the class signature of VarCloner extending AbstractCloner. The doClone() method builds the queue array (Data payload) with breadth-first cloning, handling scalars, strings, arrays, objects, resources, and references.

```php
class VarCloner extends AbstractCloner
{
    protected function doClone(mixed $var): array
}
```

--------------------------------

### CliContextProvider class declaration

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/context-providers.md

Final class implementing ContextProviderInterface. Only active when PHP_SAPI is 'cli'. Provides command_line and identifier context keys.

```php
final class CliContextProvider implements ContextProviderInterface
{
    public function getContext(): ?array
}
```

--------------------------------

### Constructor with casters parameter

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/cloner.md

Constructor accepts an optional caster map. If null, uses static::$defaultCasters. The built-in default casters are merged into the instance.

```php
/**
 * @param callable[]|null $casters A map of casters
 *
 * @see addCasters
 */
public function __construct(?array $casters = null)
```

--------------------------------

### setDumpBoundaries(string $prefix, string $suffix): void

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/dumper.md

Sets the prefix and suffix that wrap every single dump. Defaults are `'<pre class=sf-dump id=%s data-indent-pad="%s">'` and `'</pre><script>Sfdump(%s)</script>'`.

```APIDOC
## setDumpBoundaries(string $prefix, string $suffix): void

### Description
Sets the prefix and suffix that wrap every single dump. Defaults are `'<pre class=sf-dump id=%s data-indent-pad="%s">'` and `'</pre><script>Sfdump(%s)</script>'`.

### Method
setDumpBoundaries

### Parameters
- `$prefix` (string) - Required - Prefix string for the dump wrapper.
- `$suffix` (string) - Required - Suffix string for the dump wrapper.

### Return
void
```

--------------------------------

### Registering casters with VarCloner

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/cloner.md

Shows how to register casters globally or per instance. Resource types use a leading colon key.

```php
VarCloner::addDefaultCasters([My\Entity::class => [My\Caster::class, 'castEntity']]);
// or, per instance:
$cloner = new VarCloner();
$cloner->addCasters([My\Entity::class => My\Caster::castEntity(...)]);
```

--------------------------------

### DumpDescriptorInterface with describe method

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/server.md

Interface for dump descriptors. Implementations must provide a describe method that renders dump data to an output with context and client ID.

```php
interface DumpDescriptorInterface
{
    public function describe(OutputInterface $output, Data $data, array $context, int $clientId): void;
}
```

--------------------------------

### ArgsStub constructor

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/caster-stubs.md

Defines the ArgsStub class for listing function arguments. The constructor takes an array of arguments, a function name, and an optional class name. It reflects the signature to label arguments and cuts non-scalar non-Stub arguments.

```php
class ArgsStub extends EnumStub
{
    public function __construct(array $args, string $function, ?string $class)
}
```

--------------------------------

### setTheme(string $themeName): void

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/dumper.md

Switches to a theme from the static `$themes` property. Throws `\InvalidArgumentException` for unknown theme names.

```APIDOC
## setTheme(string $themeName): void

### Description
Switches to a theme from the static `$themes` property. Throws `\InvalidArgumentException` for unknown theme names.

### Method
setTheme

### Parameters
- `$themeName` (string) - Required - Name of the theme (e.g., 'dark' or 'light').

### Return
void

### Exceptions
- `\InvalidArgumentException` - If the theme name does not exist in `static::$themes`.
```

--------------------------------

### RequestContextProvider::__construct

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/context-providers.md

Creates a new RequestContextProvider instance. The constructor requires a RequestStack object and internally builds a VarCloner with setMaxItems(0) and adds ReflectionCaster::UNSET_CLOSURE_FILE_INFO.

```APIDOC
## [PHP] RequestContextProvider::__construct

### Description
Creates a new RequestContextProvider instance. The constructor requires a RequestStack object and internally builds a VarCloner with setMaxItems(0) and adds ReflectionCaster::UNSET_CLOSURE_FILE_INFO.

### Method
Constructor

### Endpoint
`RequestContextProvider::__construct(RequestStack $requestStack)`

### Parameters
#### Constructor Parameters
- **$requestStack** (RequestStack) - Required - The request stack to use.

### Request Example
```php
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\VarDumper\Dumper\ContextProvider\RequestContextProvider;

$requestStack = new RequestStack();
$requestStack->push($request);
$ctx = (new RequestContextProvider($requestStack))->getContext();
```

### Response
#### Success Response
Returns a new RequestContextProvider instance.

#### Response Example
```php
// No return value (constructor)
```
```

--------------------------------

### Connection::getContextProviders

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/server.md

Returns the array of context providers that were passed to the constructor. This method provides access to the configured context providers for inspection or further use.

```APIDOC
## Connection::getContextProviders

### Description
Returns the array of context providers that were passed to the constructor. This method provides access to the configured context providers for inspection or further use.

### Method
GET (method call)

### Signature
```php
public function getContextProviders(): array
```

### Parameters
None

### Return Value
- **array** - The array of context providers indexed by context name.
```

--------------------------------

### DumpServer::getHost

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/server.md

Returns the normalized host address of the server.

```APIDOC
## DumpServer::getHost

### Description
Returns the normalized host address of the server.

### Method
getHost

### Signature
```php
public function getHost(): string;
```

### Parameters
None

### Return Value
- **string** - The normalized host address.

### Usage Example
```php
$host = $server->getHost();
```
```

--------------------------------

### ServerDumpCommand class with AsCommand attribute

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/server.md

Symfony Console command registered as 'server:dump'. Constructor requires a DumpServer and optional descriptors map; defaults add 'cli' and 'html' descriptors. The --format option defaults to 'cli' and unsupported formats throw InvalidArgumentException.

```php
#[AsCommand(name: 'server:dump', description: 'Start a dump server that collects and displays dumps in a single place')]
class ServerDumpCommand extends Command
{
    public function __construct(
        private DumpServer $server,
        array $descriptors = [],
    );

    protected function configure(): void;
    protected function execute(InputInterface $input, OutputInterface $output): int;
    public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void;
}
```

--------------------------------

### addCasters and addDefaultCasters methods

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/cloner.md

Both methods append caster maps. addCasters adds to the instance, addDefaultCasters adds to the static default for all future instances.

```php
public function addCasters(array $casters): void
public static function addDefaultCasters(array $casters): void
```

--------------------------------

### ContextProviderInterface getContext() method

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/context-providers.md

Defines the contract for context providers. Returns an array of context data or null when preconditions are not met (e.g., not on CLI).

```php
interface ContextProviderInterface
{
    public function getContext(): ?array;
}
```

--------------------------------

### Connection class skeleton

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/server.md

Client-side socket handling used by ServerDumper. Constructor accepts host and optional context providers; write() sends payloads and never throws.

```php
class Connection
{
    /**
     * @param string                     $host             The server host
     * @param ContextProviderInterface[] $contextProviders Context providers indexed by context name
     */
    public function __construct(
        string $host,
        private array $contextProviders = [],
    );

    public function getContextProviders(): array;

    public function write(Data $data): bool;
}
```

--------------------------------

### AbstractDumper constructor with docblock

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/dumper.md

Constructor for AbstractDumper, accepting an output destination, charset, and flags bit field. Defaults to static::$defaultOutput for output and 'UTF-8' charset fallback.

```php
/**
 * @param callable|resource|string|null $output  A line dumper callable, an opened stream or an output path, defaults to static::$defaultOutput
 * @param string|null                   $charset The default character encoding to use for non-UTF8 strings
 * @param int                           $flags   A bit field of static::DUMP_* constants to fine tune dumps representation
 */
public function __construct(
    $output = null,
    ?string $charset = null,
    protected int $flags = 0,
)
```

--------------------------------

### setCharset and setIndentPad method signatures

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/dumper.md

setCharset() normalizes charset and maps 'UTF-8'/'UTF8' to 'CP1252'. setIndentPad() sets the string prefixed per nesting level; default is two spaces. Both return the previous value.

```php
public function setCharset(string $charset): string
public function setIndentPad(string $pad): string
```

--------------------------------

### new HtmlDumper($output, $charset, $flags)

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/dumper.md

Creates a new HtmlDumper instance. Extends CliDumper to render interactive HTML dumps with collapse/expand nodes, search, and keyboard shortcuts.

```APIDOC
## new HtmlDumper($output, $charset, $flags)

### Description
Creates a new HtmlDumper instance. Extends CliDumper to render interactive HTML dumps with collapse/expand nodes, search, and keyboard shortcuts.

### Method
Constructor

### Parameters
- `$output` (mixed) - Optional - Output destination (callable, resource, string, or null). Defaults to `'php://output'`.
- `$charset` (string|null) - Optional - Character set for the dump.
- `$flags` (int) - Optional - Dumper flags.

### Example
```php
$dumper = new HtmlDumper();
```
```

--------------------------------

### Custom caster with trimming and virtual property

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/caster-registry.md

Registers a per-instance custom caster on a VarCloner for My\Entity. It filters out the 'createdAt' property using Caster::filter and adds a virtual 'display_name' property, then dumps the cloned variable.

```php
use Symfony\Component\VarDumper\Cloner\VarCloner;
use Symfony\Component\VarDumper\Caster\Caster;

// Trimming + virtual property in one custom caster, registered per-instance:
$cloner = new VarCloner();
$cloner->addCasters([
    My\Entity::class => static function (My\Entity $e, array $a, Stub $stub, bool $isNested, int $filter): array {
        $a = Caster::filter($a, $filter, ['createdAt'], $count);
        $a[Caster::PREFIX_VIRTUAL.'display_name'] = $e->displayName();

        return $a;
    },
]);
$dumper->dump($cloner->cloneVar($entity));
```

--------------------------------

### CliDumper Extras

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/configuration.md

Additional configuration options specific to CliDumper for colored and wrapped output.

```APIDOC
## CliDumper Extras

### Description
Additional options for CLI output, including colors, string wrapping, and styles.

### Setters
- **setColors(bool)** - Enables or disables colored output; default autodetected via `supportsColors()`.
- **setMaxStringWidth(int)** - Sets wrap width for dumped strings; default `0` (no wrap).
- **setStyles(array)** - Sets style name → ANSI code map; merged over built-in 12-style defaults.
- **setDisplayOptions(array)** - Sets display options; default `['fileLinkFormat' => null]`; `fileLinkFormat` can be a `FileLinkFormatter` or a `'…%f…%l…'` string.
```

--------------------------------

### __get(), __isset(), offsetGet(), offsetExists() methods

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/cloner-data.md

Property/array-style access delegates to seek($key). Returns a Data instance or raw value if found; null when absent. offsetExists/__isset return false when key is missing.

```php
public function __get(string $key): mixed
public function __isset(string $key): bool
public function offsetExists(mixed $key): bool
public function offsetGet(mixed $key): mixed
```

--------------------------------

### HtmlDumper Extras

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/configuration.md

Additional configuration options specific to HtmlDumper for themes, styles, and display options.

```APIDOC
## HtmlDumper Extras

### Description
Additional options for HTML output, including theme, styles, and JS-side rendering limits.

### Setters
- **setTheme(string)** - Sets theme to `'dark'` or `'light'` (per `static::$themes`); unknown theme throws `InvalidArgumentException`; default `'dark'`.
- **setStyles(array)** - Sets CSS per style name; default dark theme CSS map.
- **setDisplayOptions(array)** - Sets JS-side rendering limits and link format; default `['maxDepth' => 1, 'maxStringLength' => 160, 'fileLinkFormat' => null]`.
- **setDumpHeader(?string)** - Sets custom header HTML; default generated `<script>`+`<style>`.
- **setDumpBoundaries(string, string)** - Sets per-dump prefix/suffix; defaults `'<pre class=sf-dump id=%s …>'` and `'</pre><script>Sfdump(%s)</script>'`.
- **setNonce(string|Closure|null, string|Closure|null)** - Sets CSP nonce sources for `<script>`/`<style>` tags; closures re-resolved per dump; default `null`/`null`.

### Per-Call Parameter
- **dump(Data, $output, array)** - `extraDisplayOptions` (`array`) - Optional - Merged over `displayOptions` for that dump; default `[]`.
```

--------------------------------

### AbstractCloner::__construct

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/cloner.md

Initializes a new cloner instance with an optional map of casters. If null, the static default casters are used.

```APIDOC
## AbstractCloner::__construct

### Description
Initializes a new cloner instance with an optional map of casters. If null, the static default casters are used.

### Method
Constructor

### Signature
`public function __construct(?array $casters = null)`

### Parameters
- `$casters` (?array<string, callable>) - Optional - Caster map (`type → callable`); `null` uses `static::$defaultCasters`.

### Notes
The built-in `$defaultCasters` map is merged into `$this->casters`; `addCasters()` appends callbacks per type (multiple callbacks for the same type run in order).
```

--------------------------------

### setDisplayOptions(array $displayOptions): void

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/dumper.md

Sets display options for the dump, such as maxDepth, maxStringLength, and fileLinkFormat. These options control how the dump is rendered.

```APIDOC
## setDisplayOptions(array $displayOptions): void

### Description
Sets display options for the dump, such as maxDepth, maxStringLength, and fileLinkFormat. These options control how the dump is rendered.

### Method
setDisplayOptions

### Parameters
- `$displayOptions` (array) - Required - Associative array of display options. Defaults: `['maxDepth' => 1, 'maxStringLength' => 160, 'fileLinkFormat' => null]`.

### Return
void
```

--------------------------------

### CliDumper::__construct

Source: https://github.com/symfony/var-dumper/blob/8.2/_autodocs/api-reference/dumper.md

Creates a new CliDumper instance. The constructor initializes the dumper with optional output stream, charset, and flags.

```APIDOC
## CliDumper::__construct

### Description
Creates a new CliDumper instance. The constructor initializes the dumper with optional output stream, charset, and flags.

### Method
Constructor

### Signature
```php
public function __construct($output = null, ?string $charset = null, int $flags = 0)
```

### Parameters
- **$output** (mixed) - Optional - The output stream, resource, or null. Defaults to null.
- **$charset** (?string) - Optional - The character set to use. Defaults to null.
- **$flags** (int) - Optional - Bitmask of flags (e.g., `CliDumper::DUMP_STRING_LENGTH`, `CliDumper::DUMP_TRAILING_COMMA`). Defaults to 0.

### Example
```php
$dumper = new CliDumper(null, 'UTF-8', CliDumper::DUMP_STRING_LENGTH | CliDumper::DUMP_TRAILING_COMMA);
```
```
Tokens:
Raw