Refractor dimension content collection behaviour

sulu · Oct 11, 2021 · e229c44 · e229c44
1 parent b6e3237
commit e229c44
Show file tree

Hide file tree

Showing 13 changed files with 148 additions and 130 deletions.
diff --git a/Content/Application/ContentDataMapper/ContentDataMapper.php b/Content/Application/ContentDataMapper/ContentDataMapper.php
@@ -39,13 +39,10 @@ public function map(
         $localizedDimensionAttributes = $dimensionAttributes;
         $unlocalizedDimensionAttributes = $dimensionAttributes;
         $unlocalizedDimensionAttributes['locale'] = null;
-        $unlocalizedDimensionContent = $dimensionContentCollection->getDimensionContent($unlocalizedDimensionAttributes);
-        $localizedDimensionContent = $dimensionContentCollection->getDimensionContent($localizedDimensionAttributes);
-
-        if (!$unlocalizedDimensionContent || !$localizedDimensionContent) {
-            // TODO see https://github.com/sulu/SuluContentBundle/pull/204
-            throw new \RuntimeException('Create unlocalized and localized dimension content.');
-        }
+        $unlocalizedDimensionContent = $dimensionContentCollection->getDimensionContent($unlocalizedDimensionAttributes)
+            ?: $dimensionContentCollection->createDimensionContent($unlocalizedDimensionAttributes);
+        $localizedDimensionContent = $dimensionContentCollection->getDimensionContent($localizedDimensionAttributes)
+            ?: $dimensionContentCollection->createDimensionContent($localizedDimensionAttributes);
 
         foreach ($this->dataMappers as $mapper) {
             $mapper->map($unlocalizedDimensionContent, $localizedDimensionContent, $data);

diff --git a/Content/Application/ContentDataMapper/DataMapper/RoutableDataMapper.php b/Content/Application/ContentDataMapper/DataMapper/RoutableDataMapper.php
@@ -117,7 +117,6 @@ public function map(
         $entityClass = null;
         $routeSchema = null;
         $resourceKey = $localizedDimensionContent::getResourceKey();
-
         foreach ($this->routeMappings as $key => $mapping) {
             if ($resourceKey === $mapping['resource_key']) {
                 $entityClass = $mapping['entityClass'] ?? $key;

diff --git a/Content/Application/ContentManager/ContentManager.php b/Content/Application/ContentManager/ContentManager.php
@@ -20,6 +20,7 @@
 use Sulu\Bundle\ContentBundle\Content\Application\ContentResolver\ContentResolverInterface;
 use Sulu\Bundle\ContentBundle\Content\Application\ContentWorkflow\ContentWorkflowInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\ContentRichEntityInterface;
+use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentCollectionInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentInterface;
 
 class ContentManager implements ContentManagerInterface
@@ -75,9 +76,9 @@ public function resolve(ContentRichEntityInterface $contentRichEntity, array $di
         return $this->contentResolver->resolve($contentRichEntity, $dimensionAttributes);
     }
 
-    public function persist(ContentRichEntityInterface $contentRichEntity, array $data, array $dimensionAttributes): DimensionContentInterface
+    public function persist(ContentRichEntityInterface $contentRichEntity, array $dimensionAttributes, array $data): DimensionContentCollectionInterface
     {
-        return $this->contentPersister->persist($contentRichEntity, $data, $dimensionAttributes);
+        return $this->contentPersister->persist($contentRichEntity, $dimensionAttributes, $data);
     }
 
     public function normalize(DimensionContentInterface $dimensionContent): array

diff --git a/Content/Application/ContentManager/ContentManagerInterface.php b/Content/Application/ContentManager/ContentManagerInterface.php
@@ -14,6 +14,7 @@
 namespace Sulu\Bundle\ContentBundle\Content\Application\ContentManager;
 
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\ContentRichEntityInterface;
+use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentCollectionInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentInterface;
 
 interface ContentManagerInterface
@@ -24,10 +25,10 @@ interface ContentManagerInterface
     public function resolve(ContentRichEntityInterface $contentRichEntity, array $dimensionAttributes): DimensionContentInterface;
 
     /**
-     * @param mixed[] $data
      * @param mixed[] $dimensionAttributes
+     * @param mixed[] $data
      */
-    public function persist(ContentRichEntityInterface $contentRichEntity, array $data, array $dimensionAttributes): DimensionContentInterface;
+    public function persist(ContentRichEntityInterface $contentRichEntity, array $dimensionAttributes, array $data): DimensionContentCollectionInterface;
 
     /**
      * @return mixed[]

diff --git a/Content/Application/ContentPersister/ContentPersister.php b/Content/Application/ContentPersister/ContentPersister.php
@@ -13,10 +13,10 @@
 
 namespace Sulu\Bundle\ContentBundle\Content\Application\ContentPersister;
 
-use Sulu\Bundle\ContentBundle\Content\Application\ContentMerger\ContentMergerInterface;
+use Sulu\Bundle\ContentBundle\Content\Application\ContentDataMapper\ContentDataMapperInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Factory\DimensionContentCollectionFactoryInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\ContentRichEntityInterface;
-use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentInterface;
+use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentCollectionInterface;
 
 class ContentPersister implements ContentPersisterInterface
 {
@@ -26,34 +26,27 @@ class ContentPersister implements ContentPersisterInterface
     private $dimensionContentCollectionFactory;
 
     /**
-     * @var ContentMergerInterface
+     * @var ContentDataMapperInterface
      */
-    private $contentMerger;
+    private $contentDataMapper;
 
     public function __construct(
         DimensionContentCollectionFactoryInterface $dimensionContentCollectionFactory,
-        ContentMergerInterface $contentMerger
+        ContentDataMapperInterface $contentDataMapper
     ) {
         $this->dimensionContentCollectionFactory = $dimensionContentCollectionFactory;
-        $this->contentMerger = $contentMerger;
+        $this->contentDataMapper = $contentDataMapper;
     }
 
-    public function persist(ContentRichEntityInterface $contentRichEntity, array $data, array $dimensionAttributes): DimensionContentInterface
+    public function persist(ContentRichEntityInterface $contentRichEntity, array $dimensionAttributes, array $data): DimensionContentCollectionInterface
     {
-        /*
-         * Data should always be persisted to the STAGE_DRAFT content-dimension of the given $dimensionAttributes.
-         * Modifying data of other content-dimensions (eg. STAGE_LIVE) should only be possible by applying transitions
-         * of the ContentWorkflow.
-         *
-         * TODO: maybe throw an exception here if the $dimensionAttributes contain another stage than 'STAGE_DRAFT'
-         */
-
         $dimensionContentCollection = $this->dimensionContentCollectionFactory->create(
             $contentRichEntity,
-            $dimensionAttributes,
-            $data
+            $dimensionAttributes
         );
 
-        return $this->contentMerger->merge($dimensionContentCollection);
+        $this->contentDataMapper->map($dimensionContentCollection, $dimensionAttributes, $data);
+
+        return $dimensionContentCollection;
     }
 }
diff --git a/Content/Application/ContentPersister/ContentPersisterInterface.php b/Content/Application/ContentPersister/ContentPersisterInterface.php
@@ -14,13 +14,13 @@
 namespace Sulu\Bundle\ContentBundle\Content\Application\ContentPersister;
 
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\ContentRichEntityInterface;
-use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentInterface;
+use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentCollectionInterface;
 
 interface ContentPersisterInterface
 {
     /**
      * @param mixed[] $data
      * @param mixed[] $dimensionAttributes
      */
-    public function persist(ContentRichEntityInterface $contentRichEntity, array $data, array $dimensionAttributes): DimensionContentInterface;
+    public function persist(ContentRichEntityInterface $contentRichEntity, array $dimensionAttributes, array $data): DimensionContentCollectionInterface;
 }
diff --git a/Content/Application/DimensionContentCollectionFactory/DimensionContentCollectionFactory.php b/Content/Application/DimensionContentCollectionFactory/DimensionContentCollectionFactory.php
@@ -13,115 +13,51 @@
 
 namespace Sulu\Bundle\ContentBundle\Content\Application\DimensionContentCollectionFactory;
 
-use Doctrine\Common\Collections\ArrayCollection;
-use Doctrine\Common\Collections\Collection;
-use Sulu\Bundle\ContentBundle\Content\Application\ContentDataMapper\ContentDataMapperInterface;
+use Sulu\Bundle\ContentBundle\Content\Application\ContentMerger\Merger\MergerInterface;
+use Sulu\Bundle\ContentBundle\Content\Application\ContentMetadataInspector\ContentMetadataInspectorInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Factory\DimensionContentCollectionFactoryInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\ContentRichEntityInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentCollection;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentCollectionInterface;
-use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentInterface;
-use Sulu\Bundle\ContentBundle\Content\Domain\Repository\DimensionContentRepositoryInterface;
 use Symfony\Component\PropertyAccess\PropertyAccessor;
-use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
 
 class DimensionContentCollectionFactory implements DimensionContentCollectionFactoryInterface
 {
     /**
-     * @var DimensionContentRepositoryInterface
+     * @var ContentMetadataInspectorInterface
      */
-    private $dimensionContentRepository;
+    private $contentMetadataInspector;
 
     /**
-     * @var ContentDataMapperInterface
+     * @var iterable<MergerInterface>
      */
-    private $contentDataMapper;
+    private $mergers;
 
     /**
-     * @var PropertyAccessorInterface
+     * @var PropertyAccessor
      */
     private $propertyAccessor;
 
     public function __construct(
-        DimensionContentRepositoryInterface $dimensionContentRepository,
-        ContentDataMapperInterface $contentDataMapper,
+        iterable $mergers,
+        ContentMetadataInspectorInterface $contentMetadataInspector,
         PropertyAccessor $propertyAccessor
     ) {
-        $this->dimensionContentRepository = $dimensionContentRepository;
-        $this->contentDataMapper = $contentDataMapper;
+        $this->mergers = $mergers;
+        $this->contentMetadataInspector = $contentMetadataInspector;
         $this->propertyAccessor = $propertyAccessor;
     }
 
     public function create(
         ContentRichEntityInterface $contentRichEntity,
-        array $dimensionAttributes,
-        array $data
+        array $dimensionAttributes
     ): DimensionContentCollectionInterface {
-        $dimensionContentCollection = $this->dimensionContentRepository->load($contentRichEntity, $dimensionAttributes);
-        $dimensionAttributes = $dimensionContentCollection->getDimensionAttributes();
-
-        $orderedContentDimensions = \iterator_to_array($dimensionContentCollection);
-        $dimensionContents = new ArrayCollection($orderedContentDimensions);
-
-        $unlocalizedAttributes = $dimensionAttributes;
-        $unlocalizedAttributes['locale'] = null;
-
-        // get or create unlocalized dimension content
-        $unlocalizedDimensionContent = $dimensionContentCollection->getDimensionContent($unlocalizedAttributes);
-
-        if (!$unlocalizedDimensionContent) {
-            $unlocalizedDimensionContent = $this->createContentDimension(
-                $contentRichEntity,
-                $dimensionContents,
-                $unlocalizedAttributes
-            );
-            $orderedContentDimensions[] = $unlocalizedDimensionContent;
-        }
-
-        $localizedDimensionContent = null;
-        if (isset($dimensionAttributes['locale'])) {
-            // get or create localized dimension content
-            $localizedDimensionContent = $dimensionContentCollection->getDimensionContent($dimensionAttributes);
-
-            if (!$localizedDimensionContent) {
-                $localizedDimensionContent = $this->createContentDimension(
-                    $contentRichEntity,
-                    $dimensionContents,
-                    $dimensionAttributes
-                );
-                $orderedContentDimensions[] = $localizedDimensionContent;
-            }
-        }
-
-        $dimensionContentCollection = new DimensionContentCollection(
-            $orderedContentDimensions,
+        return new DimensionContentCollection(
+            $contentRichEntity,
             $dimensionAttributes,
-            $dimensionContentCollection->getDimensionContentClass()
+            $this->contentMetadataInspector->getDimensionContentClass(\get_class($this)),
+            $this->mergers,
+            $this->propertyAccessor
         );
-
-        $this->contentDataMapper->map($dimensionContentCollection, $dimensionAttributes, $data);
-
-        return $dimensionContentCollection;
-    }
-
-    /**
-     * @param Collection<int, DimensionContentInterface> $dimensionContents
-     * @param mixed[] $attributes
-     */
-    private function createContentDimension(
-        ContentRichEntityInterface $contentRichEntity,
-        Collection $dimensionContents,
-        array $attributes
-    ): DimensionContentInterface {
-        $dimensionContent = $contentRichEntity->createDimensionContent();
-
-        foreach ($attributes as $attributeName => $attributeValue) {
-            $this->propertyAccessor->setValue($dimensionContent, $attributeName, $attributeValue);
-        }
-
-        $contentRichEntity->addDimensionContent($dimensionContent);
-        $dimensionContents->add($dimensionContent);
-
-        return $dimensionContent;
     }
 }
diff --git a/Content/Domain/Factory/DimensionContentCollectionFactoryInterface.php b/Content/Domain/Factory/DimensionContentCollectionFactoryInterface.php
@@ -24,7 +24,6 @@ interface DimensionContentCollectionFactoryInterface
      */
     public function create(
         ContentRichEntityInterface $contentRichEntity,
-        array $dimensionAttributes,
-        array $data
+        array $dimensionAttributes
     ): DimensionContentCollectionInterface;
 }
diff --git a/Content/Domain/Model/ContentRichEntityInterface.php b/Content/Domain/Model/ContentRichEntityInterface.php
@@ -14,6 +14,7 @@
 namespace Sulu\Bundle\ContentBundle\Content\Domain\Model;
 
 use Doctrine\Common\Collections\Collection;
+use Sulu\Bundle\ContentBundle\Content\Domain\Factory\DimensionContentCollectionFactoryInterface;
 
 interface ContentRichEntityInterface
 {