How to Dump Workflows

Version: 4.0
Edit this page

Warning: You are browsing the documentation for Symfony 4.0, which is no longer maintained.

Read the updated version of this page for Symfony 6.0 (the current stable version).

How to Dump Workflows

To help you debug your workflows, you can dump a representation of your workflow with the use of a DumperInterface. Use the GraphvizDumper to create a PNG or SVG image of the workflow defined above:

1
2
3
// dump-graph.php
$dumper = new GraphvizDumper();
echo $dumper->dump($definition);
1
2
3
4
$ php dump-graph.php | dot -Tsvg -o graph.svg

# run this command if you prefer PNG images:
# $ php dump-graph.php | dot -Tpng -o graph.png

The result will look like this:

Inside a Symfony application, you can dump the dot file with the workflow:dump command:

1
$ php bin/console workflow:dump name | dot -Tsvg -o graph.svg

Note

The dot command is part of Graphviz. You can download it and read more about it on Graphviz.org.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.