CTP SDK : File Core/Helper/State/Renderer.php

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256

<?php
/**
 * @author @jenschude <jens.schulze@commercetools.de>
 */

namespace Commercetools\Core\Helper\State;

use Commercetools\Core\Client;
use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Helper\State\Renderer\NodeRenderer;
use Commercetools\Core\Helper\State\Renderer\TransitionRenderer;
use Commercetools\Core\Model\State\StateCollection;
use Commercetools\Core\Request\States\StateQueryRequest;

class Renderer
{
    /** @var array Colors for drawing dwh states */
    public static $colors = array(
        '#2266aa',
        '#228866',
        '#775533',
        '#333311',
        '#881122',
        '#662266',
        '#00212E',
        '#42002E',
        '#422100',
        '#000B11',
        '#5A0011',
        '#5A0B00'
    );

    /** @var array $eventColors colors for drawing the events */
    protected $eventColors = array(
        'manual'  => '#00AA00',     // color for manually executable event
        'timeout' => '#AAAAAA',     // color for timeout event
        'statewasset' => '#0000AA',     // color for other events
        'default' => '#222222',     // color for other events
    );

    /** @var string $defaultFontColor default font color for state nodes */
    protected $defaultFontColor = '';
    /** @var string $defaultBorderColor default border color for state nodes */
    protected $defaultBorderColor = '';

    /**
     * @var array $nodeRenderers contains the renderers for the state nodes.
     *
     * They can be set by setNodeRendererByStateName(). If no renderer is set the default renderer
     * Bob_StateMachine_Renderer_Node_DefaultRenderer will be used.
     */
    protected $nodeRenderers = array();

    protected $transitionRenderers = array();

    /**
     * @return array
     */
    public function getEventColors()
    {
        return $this->eventColors;
    }

    /**
     * @param array $eventColors
     */
    public function setEventColors($eventColors)
    {
        $this->eventColors = $eventColors;
    }

    /**
     * @return string
     */
    public function getDefaultFontColor()
    {
        return $this->defaultFontColor;
    }

    /**
     * @param string $defaultFontColor
     */
    public function setDefaultFontColor($defaultFontColor)
    {
        $this->defaultFontColor = $defaultFontColor;
    }

    /**
     * @return string
     */
    public function getDefaultBorderColor()
    {
        return $this->defaultBorderColor;
    }

    /**
     * @param string $defaultBorderColor
     */
    public function setDefaultBorderColor($defaultBorderColor)
    {
        $this->defaultBorderColor = $defaultBorderColor;
    }

    /**
     * @return array
     */
    public function getNodeRenderers()
    {
        return $this->nodeRenderers;
    }

    /**
     * @param array $nodeRenderers
     */
    public function setNodeRenderers($nodeRenderers)
    {
        $this->nodeRenderers = $nodeRenderers;
    }

    /**
     * @return array
     */
    public function getTransitionRenderers()
    {
        return $this->transitionRenderers;
    }

    /**
     * @param array $transitionRenderers
     */
    public function setTransitionRenderers($transitionRenderers)
    {
        $this->transitionRenderers = $transitionRenderers;
    }

    /**
     * Is there a state node renderer for the given state name?
     *
     * @param $stateName
     * @return bool
     */
    public function hasNodeRendererByStateName($stateName)
    {
        return isset($this->nodeRenderers[$stateName]);
    }

    /**
     * Get the renderer for the given state name.
     *
     * If no renderer was set the default renderer Bob_StateMachine_Renderer_Node_DefaultRenderer() is returned
     *
     * @param $stateName
     * @return NodeRenderer
     */
    public function getNodeRendererByStateName($stateName)
    {
        if (isset($this->nodeRenderers[$stateName])) {
            return $this->nodeRenderers[$stateName];
        }
        return new NodeRenderer();
    }

    public function getTransitionRendererByStateName($stateName)
    {
        if (isset($this->transitionRenderers[$stateName])) {
            return $this->transitionRenderers[$stateName];
        }
        return new TransitionRenderer();
    }

    /**
     * Renders a dot graph into an svg
     *
     * @param string $dotString The dot graph that is fed into the
     * @return string|bool the resulting SVG
     */
    public function runDot($dotString)
    {
        $descriptorSpec = array(
            0 => array("pipe", "r"), // stdin
            1 => array("pipe", "w"), // stdout
            2 => array("pipe", "a") // stderr
        );

        $process = proc_open('dot -Tsvg', $descriptorSpec, $pipes);

        if (is_resource($process)) {
            fwrite($pipes[0], $dotString);
            fclose($pipes[0]);

            $svg = stream_get_contents($pipes[1]);
            fclose($pipes[1]);

            proc_close($process);
            $svg = explode('<svg ', $svg);

            // has it worked out?
            if (count($svg) < 2) {
                return false;
            }

            return '<svg ' . $svg[1];
        }

        return false;
    }

    /**
     * Creates a dot graph for a process
     *
     * @param StateCollection $stateCollection
     * @return string A dot graph
     */
    public function renderDot(StateCollection $stateCollection)
    {
        // define the graph
        $graph = 'digraph ' . 'test'
            . ' { dpi="56";compound="true";fontname="Arial";margin="";nodesep="0.6";rankdir="TD";ranksep="0.4";'
            . PHP_EOL;

        // add all states to the graph
        foreach ($stateCollection as $state) {
            $nodeRenderer = $this->getNodeRendererByStateName($state->getKey());
            $graph .= ' ' . $nodeRenderer->render($state);
        }

        // add all transitions to the graph
        foreach ($stateCollection as $state) {
            $nodeRenderer = $this->getTransitionRendererByStateName($state->getKey());
            $graph .= ' ' . $nodeRenderer->render($state);
        }

        $graph .= '}' . PHP_EOL;


        return $graph;
    }

    /**
     * @param Client $client
     * @param Context $context
     * @return string
     */
    public static function run(Client $client, Context $context = null)
    {
        $renderer = new static();
        $request = new StateQueryRequest($context);
        $request->expand('transitions[*]');

        $states = $client->execute($request)->toObject();

        $dotString = $renderer->renderDot($states);
        return $renderer->runDot($dotString);
    }
}

Namespaces

Classes