https://github.com/jackd248/typo3-dump-server

TYPO3 extension that brings the Symfony Var Dump Server to TYPO3.
https://github.com/jackd248/typo3-dump-server

typo3 typo3-cms-extension

Last synced: about 1 year ago
JSON representation

TYPO3 extension that brings the Symfony Var Dump Server to TYPO3.

• Host: GitHub
• URL: https://github.com/jackd248/typo3-dump-server
• Owner: jackd248
• License: gpl-2.0
• Created: 2025-02-19T15:58:46.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-17T11:22:53.000Z (over 1 year ago)
• Last Synced: 2025-06-30T20:55:37.150Z (about 1 year ago)
• Topics: typo3, typo3-cms-extension
• Language: PHP
• Homepage:
• Size: 3.88 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          


![Extension icon](Resources/Public/Icons/Extension.svg)

# TYPO3 extension `typo3_dump_server`

[![Latest Stable Version](https://typo3-badges.dev/badge/typo3_dump_server/version/shields.svg)](https://extensions.typo3.org/extension/typo3_dump_server)

[![Supported TYPO3 versions](https://typo3-badges.dev/badge/typo3_dump_server/typo3/shields.svg)](https://extensions.typo3.org/extension/typo3_dump_server)

[![License](https://poser.pugx.org/konradmichalik/typo3-dump-server/license)](LICENSE.md)



This extension brings the [Symfony Var Dump Server](https://symfony.com/doc/current/components/var_dumper.html#the-dump-server) to TYPO3.

This package provides a dump server that gathers all `dump` call outputs, preventing interference with HTTP or API responses.

![Console Command](./Documentation/Images/screenshot.png)

## Requirements

* TYPO3 >= 11.5 & PHP 8.1+

## Installation

### Composer

[![Packagist](https://img.shields.io/packagist/v/konradmichalik/typo3-dump-server?label=version&logo=packagist)](https://packagist.org/packages/konradmichalik/typo3-dump-server)

[![Packagist Downloads](https://img.shields.io/packagist/dt/konradmichalik/typo3-dump-server?color=brightgreen)](https://packagist.org/packages/konradmichalik/typo3-dump-server)

```bash

composer require --dev konradmichalik/typo3-dump-server

```

### TER

[![TER version](https://typo3-badges.dev/badge/typo3_dump_server/version/shields.svg)](https://extensions.typo3.org/extension/typo3_dump_server)

[![TER downloads](https://typo3-badges.dev/badge/typo3_dump_server/downloads/shields.svg)](https://extensions.typo3.org/extension/typo3_dump_server)

Download the zip file from [TYPO3 extension repository (TER)](https://extensions.typo3.org/extension/typo3_dump_server).

## Usage

![Screencast](./Documentation/Images/screencast.gif)

### Console command

Start the dump server with the following command:

```bash

vendor/bin/typo3 server:dump

```

![Console Command](./Documentation/Images/screenshot-command.png)

Use the format option to change the output format to `html`:

```bash

vendor/bin/typo3 server:dump --format=html > dump.html

```

> [!NOTE]  

> The dump server will be available at `tcp://127.0.0.1:9912` by default. Use the environment variable `TYPO3_DUMP_SERVER_HOST` to change the host.

### Dump

Use the `dump` function in your code:

```php

dump($variable);

```

### ViewHelper

Use the `symfony:dump` ViewHelper in your Fluid templates:

```html

{variable}

```

### Extension settings

By default, a `dump()` call will add something like the following output to the frontend if the dump server isn't running:

![Dump output in frontend](./Documentation/Images/output.jpg)

You can suppress this output with the `suppressDump` setting in the extension configuration. If this setting is enabled, the output will be suppressed and the dump will only be sent to the dump server.

You can find the extension settings in the TYPO3 backend under `Admin Tools > Settings > Extension Configuration > typo3_dump_server`.

## Development

Use the following ddev command to easily install all supported TYPO3 versions for locale development.

```bash

$ ddev install all

```

## Credits

This project is highly inspired by the [laravel-dump-server](https://github.com/beyondcode/laravel-dump-server) & the symfony [var-dumper](https://github.com/symfony/var-dumper) component itself.

## License

This project is licensed

under [GNU General Public License 2.0 (or later)](LICENSE.md).