Merge pull request #19 from willemo/dynamic-adding-of-workflows-to-the-registry

Added dynamically adding workflows to the registry

Author: brexis

src/WorkflowRegistry.php

@@ -11,62 +11,53 @@
 use Symfony\Component\Workflow\MarkingStore\SingleStateMarkingStore;
 use Symfony\Component\Workflow\Registry;
 use Symfony\Component\Workflow\StateMachine;
+use Symfony\Component\Workflow\SupportStrategy\ClassInstanceSupportStrategy;
 use Symfony\Component\Workflow\Transition;
 use Symfony\Component\Workflow\Workflow;
-use Symfony\Component\Workflow\SupportStrategy\ClassInstanceSupportStrategy;
 
 /**
  * @author Boris Koumondji <brexis@yahoo.fr>
  */
 class WorkflowRegistry
 {
     /**
-     * @var Symfony\Component\Workflow\Registry
+     * @var Registry
      */
-    private $registry;
+    protected $registry;
 
     /**
      * @var array
      */
-    private $config;
+    protected $config;
 
     /**
      * @var EventDispatcher
      */
-    private $dispatcher;
+    protected $dispatcher;
 
+    /**
+     * WorkflowRegistry constructor
+     *
+     * @param  array $config
+     * @throws \ReflectionException
+     */
     public function __construct(array $config)
     {
-        $this->registry     = new Registry();
-        $this->config       = $config;
-        $this->dispatcher   = new EventDispatcher();
+        $this->registry = new Registry();
+        $this->config = $config;
+        $this->dispatcher = new EventDispatcher();
 
-        $subscriber         = new WorkflowSubscriber();
+        $subscriber = new WorkflowSubscriber();
         $this->dispatcher->addSubscriber($subscriber);
 
         foreach ($this->config as $name => $workflowData) {
-            $builder = new DefinitionBuilder($workflowData['places']);
-
-            foreach ($workflowData['transitions'] as $transitionName => $transition) {
-                if (!is_string($transitionName)) {
-                    $transitionName = $transition['name'];
-                }
-
-                $builder->addTransition(new Transition($transitionName, $transition['from'], $transition['to']));
-            }
-
-            $definition     = $builder->build();
-            $markingStore   = $this->getMakingStoreInstance($workflowData);
-            $workflow       = $this->getWorkflowInstance($name, $workflowData, $definition, $markingStore);
-
-            foreach ($workflowData['supports'] as $supportedClass) {
-                $this->add($workflow, $supportedClass);
-            }
+            $this->addFromArray($name, $workflowData);
         }
     }
 
     /**
-     * Return the $subject workflo
+     * Return the $subject workflow
+     *
      * @param  object $subject
      * @param  string $workflowName
      * @return Workflow
@@ -78,32 +69,64 @@ public function get($subject, $workflowName = null)
 
     /**
      * Add a workflow to the subject
+     *
      * @param Workflow $workflow
-     * @param Symfony\Component\Workflow\SupportStrategy\SupportStrategyInterface $supportStrategy
+     * @param string   $supportStrategy
      */
     public function add(Workflow $workflow, $supportStrategy)
     {
-        return $this->registry->add($workflow, new ClassInstanceSupportStrategy($supportStrategy));
+        $this->registry->add($workflow, new ClassInstanceSupportStrategy($supportStrategy));
     }
 
     /**
-     * Return the workflow instance
+     * Add a workflow to the registry from array
      *
-     * @param  String                                                        $name
-     * @param  array                                                         $workflowData
-     * @param  Symfony\Component\Workflow\Definition                         $definition
-     * @param  Symfony\Component\Workflow\MarkingStore\MarkingStoreInterface $makingStore
-     * @return Symfony\Component\Workflow\Workflow
+     * @param  string $name
+     * @param  array  $workflowData
+     * @throws \ReflectionException
      */
-    private function getWorkflowInstance($name, $workflowData, Definition $definition, MarkingStoreInterface $markingStore)
+    public function addFromArray($name, array $workflowData)
     {
-        $type  = isset($workflowData['type']) ? $workflowData['type'] : 'workflow';
-        $className = Workflow::class;
+        $builder = new DefinitionBuilder($workflowData['places']);
 
-        if ($type === 'state_machine') {
-            $className = StateMachine::class;
-        } else if (isset($workflowData['class'])) {
+        foreach ($workflowData['transitions'] as $transitionName => $transition) {
+            if (!is_string($transitionName)) {
+                $transitionName = $transition['name'];
+            }
+
+            $builder->addTransition(new Transition($transitionName, $transition['from'], $transition['to']));
+        }
+
+        $definition = $builder->build();
+        $markingStore = $this->getMarkingStoreInstance($workflowData);
+        $workflow = $this->getWorkflowInstance($name, $workflowData, $definition, $markingStore);
+
+        foreach ($workflowData['supports'] as $supportedClass) {
+            $this->add($workflow, $supportedClass);
+        }
+    }
+
+    /**
+     * Return the workflow instance
+     *
+     * @param  String                $name
+     * @param  array                 $workflowData
+     * @param  Definition            $definition
+     * @param  MarkingStoreInterface $markingStore
+     * @return Workflow
+     */
+    protected function getWorkflowInstance(
+        $name,
+        array $workflowData,
+        Definition $definition,
+        MarkingStoreInterface $markingStore
+    ) {
+        if (isset($workflowData['class'])) {
             $className = $workflowData['class'];
+        } elseif (isset($workflowData['type']) && $workflowData['type'] === 'state_machine') {
+            $className = StateMachine::class;
+        } else {
+            $className = Workflow::class;
         }
 
         return new $className($definition, $markingStore, $this->dispatcher, $name);
@@ -112,24 +135,21 @@ private function getWorkflowInstance($name, $workflowData, Definition $definitio
     /**
      * Return the making store instance
      *
-     * @param  array $makingStoreData
-     * @return Symfony\Component\Workflow\MarkingStore\MarkingStoreInterface
+     * @param  array $workflowData
+     * @return MarkingStoreInterface
+     * @throws \ReflectionException
      */
-    private function getMakingStoreInstance($workflowData)
+    protected function getMarkingStoreInstance(array $workflowData)
     {
-        $makingStoreData    = isset($workflowData['marking_store']) ? $workflowData['marking_store'] : [];
-        $type               = isset($makingStoreData['type']) ? $makingStoreData['type'] : 'single_state';
-        $className          = SingleStateMarkingStore::class;
-        $arguments          = [];
+        $markingStoreData = isset($workflowData['marking_store']) ? $workflowData['marking_store'] : [];
+        $arguments = isset($markingStoreData['arguments']) ? $markingStoreData['arguments'] : [];
 
-        if ($type === 'multiple_state') {
+        if (isset($markingStoreData['class'])) {
+            $className = $markingStoreData['class'];
+        } elseif (isset($markingStoreData['type']) && $markingStoreData['type'] === 'multiple_state') {
             $className = MultipleStateMarkingStore::class;
-        } else if (isset($workflowData['class'])) {
-            $className = $workflowData['class'];
-        }
-
-        if (isset($makingStoreData['arguments'])) {
-            $arguments = $makingStoreData['arguments'];
+        } else {
+            $className = SingleStateMarkingStore::class;
         }
 
         $class = new \ReflectionClass($className);