Set workflow place only on draft dimension

sulu · May 15, 2020 · 5a468fd · 5a468fd
1 parent ac74df7
commit 5a468fd
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 10 deletions.
diff --git a/Content/Application/ContentDataMapper/DataMapper/WorkflowDataMapper.php b/Content/Application/ContentDataMapper/DataMapper/WorkflowDataMapper.php
@@ -46,6 +46,38 @@ public function map(
      */
     private function setWorkflowData(WorkflowInterface $object, array $data): void
     {
+        $this->setInitialPlaceToDraftDimension($object, $data);
+        $this->setPublishedToLiveDimension($object, $data);
+    }
+
+    /**
+     * @param mixed[] $data
+     */
+    private function setInitialPlaceToDraftDimension(WorkflowInterface $object, array $data): void
+    {
+        // we want to set the initial place only to the draft dimension, the live dimension should not have a place
+        // after the place was set by this mapper initially, the place should only be changed by the ContentWorkflow
+        // see: https://github.com/sulu/SuluContentBundle/issues/92
+
+        if (!$object instanceof DimensionContentInterface
+            || DimensionInterface::STAGE_DRAFT !== $object->getDimension()->getStage()) {
+            return;
+        }
+
+        if (!$object->getWorkflowPlace()) {
+            // TODO: get public workflow registry and set initial place based on $object::getWorkflowName()
+            $object->setWorkflowPlace(WorkflowInterface::WORKFLOW_PLACE_UNPUBLISHED);
+        }
+    }
+
+    /**
+     * @param mixed[] $data
+     */
+    private function setPublishedToLiveDimension(WorkflowInterface $object, array $data): void
+    {
+        // the published property of the draft dimension should only be changed by a ContentWorkflow subscriber
+        // therefore we only want to copy the published property from the draft to the live dimension
+
         if (!$object instanceof DimensionContentInterface
             || DimensionInterface::STAGE_LIVE !== $object->getDimension()->getStage()) {
             return;

diff --git a/Content/Application/ContentWorkflow/ContentWorkflow.php b/Content/Application/ContentWorkflow/ContentWorkflow.php
@@ -72,7 +72,7 @@ public function __construct(
         $this->dimensionContentRepository = $dimensionContentRepository;
         $this->viewFactory = $viewFactory;
         $this->eventDispatcher = $eventDispatcher ?: new EventDispatcher();
-        // TODO get workflow from outside
+        // TODO: get public workflow registry from outside
         $this->workflowRegistry = $workflowRegistry ?: new Registry();
         $this->workflowRegistry->addWorkflow(
             $this->getWorkflow(),

diff --git a/Content/Domain/Model/WorkflowInterface.php b/Content/Domain/Model/WorkflowInterface.php
@@ -47,9 +47,9 @@ interface WorkflowInterface
 
     public static function getWorkflowName(): string;
 
-    public function getWorkflowPlace(): string;
+    public function getWorkflowPlace(): ?string;
 
-    public function setWorkflowPlace(string $workflowPlace): void;
+    public function setWorkflowPlace(?string $workflowPlace): void;
 
     public function getWorkflowPublished(): ?\DateTimeImmutable;
 

diff --git a/Content/Domain/Model/WorkflowTrait.php b/Content/Domain/Model/WorkflowTrait.php
@@ -16,9 +16,9 @@
 trait WorkflowTrait
 {
     /**
-     * @var string
+     * @var string|null
      */
-    protected $workflowPlace = WorkflowInterface::WORKFLOW_PLACE_UNPUBLISHED;
+    protected $workflowPlace;
 
     /**
      * @var \DateTimeImmutable|null
@@ -30,12 +30,12 @@ public static function getWorkflowName(): string
         return WorkflowInterface::WORKFLOW_DEFAULT_NAME;
     }
 
-    public function getWorkflowPlace(): string
+    public function getWorkflowPlace(): ?string
     {
         return $this->workflowPlace;
     }
 
-    public function setWorkflowPlace(string $workflowPlace): void
+    public function setWorkflowPlace(?string $workflowPlace): void
     {
         $this->workflowPlace = $workflowPlace;
     }

diff --git a/Content/Infrastructure/Doctrine/MetadataLoader.php b/Content/Infrastructure/Doctrine/MetadataLoader.php
@@ -102,7 +102,7 @@ public function loadClassMetadata(LoadClassMetadataEventArgs $event): void
         }
 
         if ($reflection->implementsInterface(WorkflowInterface::class)) {
-            $this->addField($metadata, 'workflowPlace', 'string', ['length' => 32, 'nullable' => false, 'default' => WorkflowInterface::WORKFLOW_PLACE_UNPUBLISHED]);
+            $this->addField($metadata, 'workflowPlace', 'string', ['length' => 32, 'nullable' => true]);
             $this->addField($metadata, 'workflowPublished', 'datetime_immutable', ['nullable' => true]);
         }
     }

diff --git a/Tests/Unit/Mocks/WorkflowMockWrapperTrait.php b/Tests/Unit/Mocks/WorkflowMockWrapperTrait.php
@@ -25,12 +25,12 @@ public static function getWorkflowName(): string
         return 'mock-workflow-name';
     }
 
-    public function getWorkflowPlace(): string
+    public function getWorkflowPlace(): ?string
     {
         return $this->instance->getWorkflowPlace();
     }
 
-    public function setWorkflowPlace(string $workflowPlace): void
+    public function setWorkflowPlace(?string $workflowPlace): void
     {
         $this->instance->setWorkflowPlace($workflowPlace);
     }