You are browsing the documentation for Symfony 4.2 which is not maintained anymore.
Consider upgrading your projects to Symfony 5.2.
How to Dump Workflows
How to Dump Workflows¶
To help you debug your workflows, you can generate a visual representation of them as SVG or PNG images. First, install any of these free and open source applications needed to generate the images:
If you are defining the workflow inside a Symfony application, run this command to dump it as an image:
1 2 3 4 5 6 7 8 9 10 11
# using Graphviz's 'dot' and SVG images $ php bin/console workflow:dump workflow-name | dot -Tsvg -o graph.svg # using Graphviz's 'dot' and PNG images $ php bin/console workflow:dump workflow-name | dot -Tpng -o graph.png # using PlantUML's 'plantuml.jar' $ php bin/console workflow:dump workflow_name --dump-format=puml | java -jar plantuml.jar -p > graph.png # highlight 'place1' and 'place2' in the dumped workflow $ php bin/console workflow:dump workflow-name place1 place2 | dot -Tsvg -o graph.svg
The DOT image will look like this:
The PlantUML image will look like this:
If you are creating workflows outside of a Symfony application, use the
StateMachineGraphvizDumper class to create the DOT
PlantUmlDumper to create the PlantUML files:
// Add this code to a PHP script; for example: dump-graph.php $dumper = new GraphvizDumper(); echo $dumper->dump($definition); # if you prefer PlantUML, use this code: # $dumper = new PlantUmlDumper(); # echo $dumper->dump($definition);
1 2 3
# replace 'dump-graph.php' by the name of your PHP script $ php dump-graph.php | dot -Tsvg -o graph.svg $ php dump-graph.php | java -jar plantuml.jar -p > graph.png
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.