8000 minor #9783 Documented the new Dump Server (javiereguiluz) · symfony/symfony-docs@3cd9ccd · GitHub
[go: up one dir, main page]
Skip to content

Commit 3cd9ccd

Browse files
javiereguiluzjaviereguiluz
committed
minor #9783 Documented the new Dump Server (javiereguiluz)
This PR was squashed before being merged into the 4.1 branch (closes #9783). Discussion ---------- Documented the new Dump Server This fixes #9474. Commits ------- 3eb53d3 Documented the new Dump Server
2 parents 5c4b0b2 + 3eb53d3 commit 3cd9ccd

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

‎components/var_dumper.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,34 @@ current PHP SAPI:
9191
.. versionadded:: 4.1
9292
The ``dd()`` helper method was introduced in Symfony 4.1.
9393

94+
The Dump Server
95+
---------------
96+
97+
.. versionadded:: 4.1
98+
The dump server was introduced in Symfony 4.1.
99+
100+
The ``dump()`` function outputs its contents in the same browser window or
101+
console terminal as your own application. Sometimes mixing the real output
102+
with the debug output can be confusing. That's why this component provides a
103+
server to collect all the dumped data.
104+
105+
Start the server with the ``server:dump`` command and whenever you call to
106+
``dump()``, the dumped data won't be displayed in the output but sent to that
107+
server, which outputs it to its own console or to an HTML file:
108+
109+
.. code-block:: terminal
110+
111+
# displays the dumped data in the console:
112+
$ ./bin/console server:dump
113+
[OK] Server listening on tcp://0.0.0.0:9912
114+
115+
# stores the dumped data in a file using the HTML format:
116+
$ ./bin/console server:dump --format=html > dump.html
117+
118+
Inside a Symfony application, the output of the dump server is configured with
119+
the :ref:`dump_destination option <configuration-debug-dump_destination>` of the
120+
``debug`` package.
121+
94122
DebugBundle and Twig Integration
95123
--------------------------------
96124

‎reference/configuration/debug.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ max_string_length
4949
This option configures the maximum string length before truncating the
5050
string. The default value (``-1``) means that strings are never truncated.
5151

52+
.. _configuration-debug-dump_destination:
53+
5254
dump_destination
5355
~~~~~~~~~~~~~~~~
5456

0 commit comments

Comments
 (0)
0