[Workflow] Add a MetadataStore

Author: lyrixx

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+4.1.0
+-----
+
+ * add a `workflow_metadata` function
+
 3.4.0
 -----
 

Extension/WorkflowExtension.php

@@ -37,6 +37,7 @@ public function getFunctions()
             new TwigFunction('workflow_transitions', array($this, 'getEnabledTransitions')),
             new TwigFunction('workflow_has_marked_place', array($this, 'hasMarkedPlace')),
             new TwigFunction('workflow_marked_places', array($this, 'getMarkedPlaces')),
+            new TwigFunction('workflow_metadata', array($this, 'getMetadata')),
         );
     }
 
@@ -101,6 +102,24 @@ public function getMarkedPlaces($subject, $placesNameOnly = true, $name = null)
         return $places;
     }
 
+    /**
+     * Returns the metadata for a specific subject.
+     *
+     * @param object                 $subject         A subject
+     * @param null|string|Transition $metadataSubject Use null to get workflow metadata
+     *                                                Use a string (the place name) to get place metadata
+     *                                                Use a Transition instance to get transition metadata
+     */
+    public function getMetadata($subject, string $key, $metadataSubject = null, string $name = null): ?string
+    {
+        return $this
+            ->workflowRegistry
+            ->get($subject, $name)
+            ->getMetadataStore()
+            ->getMetadata($key, $metadataSubject)
+        ;
+    }
+
     public function getName()
     {
         return 'workflow';

Tests/Extension/WorkflowExtensionTest.php

@@ -14,6 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Bridge\Twig\Extension\WorkflowExtension;
 use Symfony\Component\Workflow\Definition;
+use Symfony\Component\Workflow\Metadata\InMemoryMetadataStore;
 use Symfony\Component\Workflow\Registry;
 use Symfony\Component\Workflow\SupportStrategy\ClassInstanceSupportStrategy;
 use Symfony\Component\Workflow\SupportStrategy\InstanceOfSupportStrategy;
@@ -23,6 +24,7 @@
 class WorkflowExtensionTest extends TestCase
 {
     private $extension;
+    private $t1;
 
     protected function setUp()
     {
@@ -32,10 +34,21 @@ protected function setUp()
 
         $places = array('ordered', 'waiting_for_payment', 'processed');
         $transitions = array(
-            new Transition('t1', 'ordered', 'waiting_for_payment'),
+            $this->t1 = new Transition('t1', 'ordered', 'waiting_for_payment'),
             new Transition('t2', 'waiting_for_payment', 'processed'),
         );
-        $definition = new Definition($places, $transitions);
+
+        $metadataStore = null;
+        if (class_exists(InMemoryMetadataStore::class)) {
+            $transitionsMetadata = new \SplObjectStorage();
+            $transitionsMetadata->attach($this->t1, array('title' => 't1 title'));
+            $metadataStore = new InMemoryMetadataStore(
+                array('title' => 'workflow title'),
+                array('orderer' => array('title' => 'ordered title')),
+                $transitionsMetadata
+            );
+        }
+        $definition = new Definition($places, $transitions, null, $metadataStore);
         $workflow = new Workflow($definition);
 
         $registry = new Registry();
@@ -88,4 +101,19 @@ public function testGetMarkedPlaces()
         $this->assertSame(array('ordered', 'waiting_for_payment'), $this->extension->getMarkedPlaces($subject));
         $this->assertSame($subject->marking, $this->extension->getMarkedPlaces($subject, false));
     }
+
+    public function testGetMetadata()
+    {
+        if (!class_exists(InMemoryMetadataStore::class)) {
+            $this->markTestSkipped('This test requires symfony/workflow:4.1.');
+        }
+        $subject = new \stdClass();
+        $subject->marking = array();
+
+        $this->assertSame('workflow title', $this->extension->getMetadata($subject, 'title'));
+        $this->assertSame('ordered title', $this->extension->getMetadata($subject, 'title', 'orderer'));
+        $this->assertSame('t1 title', $this->extension->getMetadata($subject, 'title', $this->t1));
+        $this->assertNull($this->extension->getMetadata($subject, 'not found'));
+        $this->assertNull($this->extension->getMetadata($subject, 'not found', $this->t1));
+    }
 }