| Current File : //var/www/vinorea/modules/ps_mbo/vendor/symfony/workflow/Dumper/GraphvizDumper.php |
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\Workflow\Dumper;
use Symfony\Component\Workflow\Definition;
use Symfony\Component\Workflow\Marking;
/**
* GraphvizDumper dumps a workflow as a graphviz file.
*
* You can convert the generated dot file with the dot utility (https://graphviz.org/):
*
* dot -Tpng workflow.dot > workflow.png
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Grégoire Pineau <lyrixx@lyrixx.info>
*/
class GraphvizDumper implements DumperInterface
{
// All values should be strings
protected static $defaultOptions = [
'graph' => ['ratio' => 'compress', 'rankdir' => 'LR'],
'node' => ['fontsize' => '9', 'fontname' => 'Arial', 'color' => '#333333', 'fillcolor' => 'lightblue', 'fixedsize' => 'false', 'width' => '1'],
'edge' => ['fontsize' => '9', 'fontname' => 'Arial', 'color' => '#333333', 'arrowhead' => 'normal', 'arrowsize' => '0.5'],
];
/**
* {@inheritdoc}
*
* Dumps the workflow as a graphviz graph.
*
* Available options:
*
* * graph: The default options for the whole graph
* * node: The default options for nodes (places + transitions)
* * edge: The default options for edges
*/
public function dump(Definition $definition, Marking $marking = null, array $options = [])
{
$places = $this->findPlaces($definition, $marking);
$transitions = $this->findTransitions($definition);
$edges = $this->findEdges($definition);
$options = array_replace_recursive(self::$defaultOptions, $options);
return $this->startDot($options)
.$this->addPlaces($places)
.$this->addTransitions($transitions)
.$this->addEdges($edges)
.$this->endDot();
}
/**
* @internal
*/
protected function findPlaces(Definition $definition, Marking $marking = null): array
{
$workflowMetadata = $definition->getMetadataStore();
$places = [];
foreach ($definition->getPlaces() as $place) {
$attributes = [];
if (\in_array($place, $definition->getInitialPlaces(), true)) {
$attributes['style'] = 'filled';
}
if ($marking && $marking->has($place)) {
$attributes['color'] = '#FF0000';
$attributes['shape'] = 'doublecircle';
}
$backgroundColor = $workflowMetadata->getMetadata('bg_color', $place);
if (null !== $backgroundColor) {
$attributes['style'] = 'filled';
$attributes['fillcolor'] = $backgroundColor;
}
$label = $workflowMetadata->getMetadata('label', $place);
if (null !== $label) {
$attributes['name'] = $label;
}
$places[$place] = [
'attributes' => $attributes,
];
}
return $places;
}
/**
* @internal
*/
protected function findTransitions(Definition $definition): array
{
$workflowMetadata = $definition->getMetadataStore();
$transitions = [];
foreach ($definition->getTransitions() as $transition) {
$attributes = ['shape' => 'box', 'regular' => true];
$backgroundColor = $workflowMetadata->getMetadata('bg_color', $transition);
if (null !== $backgroundColor) {
$attributes['style'] = 'filled';
$attributes['fillcolor'] = $backgroundColor;
}
$name = $workflowMetadata->getMetadata('label', $transition) ?? $transition->getName();
$transitions[] = [
'attributes' => $attributes,
'name' => $name,
];
}
return $transitions;
}
/**
* @internal
*/
protected function addPlaces(array $places): string
{
$code = '';
foreach ($places as $id => $place) {
if (isset($place['attributes']['name'])) {
$placeName = $place['attributes']['name'];
unset($place['attributes']['name']);
} else {
$placeName = $id;
}
$code .= sprintf(" place_%s [label=\"%s\", shape=circle%s];\n", $this->dotize($id), $this->escape($placeName), $this->addAttributes($place['attributes']));
}
return $code;
}
/**
* @internal
*/
protected function addTransitions(array $transitions): string
{
$code = '';
foreach ($transitions as $i => $place) {
$code .= sprintf(" transition_%s [label=\"%s\",%s];\n", $this->dotize($i), $this->escape($place['name']), $this->addAttributes($place['attributes']));
}
return $code;
}
/**
* @internal
*/
protected function findEdges(Definition $definition): array
{
$workflowMetadata = $definition->getMetadataStore();
$dotEdges = [];
foreach ($definition->getTransitions() as $i => $transition) {
$transitionName = $workflowMetadata->getMetadata('label', $transition) ?? $transition->getName();
foreach ($transition->getFroms() as $from) {
$dotEdges[] = [
'from' => $from,
'to' => $transitionName,
'direction' => 'from',
'transition_number' => $i,
];
}
foreach ($transition->getTos() as $to) {
$dotEdges[] = [
'from' => $transitionName,
'to' => $to,
'direction' => 'to',
'transition_number' => $i,
];
}
}
return $dotEdges;
}
/**
* @internal
*/
protected function addEdges(array $edges): string
{
$code = '';
foreach ($edges as $edge) {
if ('from' === $edge['direction']) {
$code .= sprintf(" place_%s -> transition_%s [style=\"solid\"];\n",
$this->dotize($edge['from']),
$this->dotize($edge['transition_number'])
);
} else {
$code .= sprintf(" transition_%s -> place_%s [style=\"solid\"];\n",
$this->dotize($edge['transition_number']),
$this->dotize($edge['to'])
);
}
}
return $code;
}
/**
* @internal
*/
protected function startDot(array $options): string
{
return sprintf("digraph workflow {\n %s\n node [%s];\n edge [%s];\n\n",
$this->addOptions($options['graph']),
$this->addOptions($options['node']),
$this->addOptions($options['edge'])
);
}
/**
* @internal
*/
protected function endDot(): string
{
return "}\n";
}
/**
* @internal
*/
protected function dotize(string $id): string
{
return hash('sha1', $id);
}
/**
* @internal
*/
protected function escape($value): string
{
return \is_bool($value) ? ($value ? '1' : '0') : addslashes($value);
}
protected function addAttributes(array $attributes): string
{
$code = [];
foreach ($attributes as $k => $v) {
$code[] = sprintf('%s="%s"', $k, $this->escape($v));
}
return $code ? ' '.implode(' ', $code) : '';
}
private function addOptions(array $options): string
{
$code = [];
foreach ($options as $k => $v) {
$code[] = sprintf('%s="%s"', $k, $v);
}
return implode(' ', $code);
}
}