Merge 4ffbd5c into 0343c4c

sulu · Oct 15, 2021 · 87fb112 · 87fb112
2 parents 0343c4c + 4ffbd5c
commit 87fb112
Show file tree

Hide file tree

Showing 31 changed files with 619 additions and 73 deletions.
diff --git a/Content/Application/ContentMerger/Merger/AuthorMerger.php b/Content/Application/ContentMerger/Merger/AuthorMerger.php
@@ -15,7 +15,11 @@
 
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\AuthorInterface;
 
-class AuthorMerger implements MergerInterface
+/**
+ * @internal This class should not be instantiated by a project.
+ *           Create your own merger instead.
+ */
+final class AuthorMerger implements MergerInterface
 {
     public function merge(object $targetObject, object $sourceObject): void
     {

diff --git a/Content/Application/ContentMerger/Merger/DimensionContentMerger.php b/Content/Application/ContentMerger/Merger/DimensionContentMerger.php
@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of Sulu.
+ *
+ * (c) Sulu GmbH
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Sulu\Bundle\ContentBundle\Content\Application\ContentMerger\Merger;
+
+use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentInterface;
+
+/**
+ * @internal This class should not be instantiated by a project.
+ *           Create your own merger instead.
+ */
+final class DimensionContentMerger implements MergerInterface
+{
+    public function merge(object $targetObject, object $sourceObject): void
+    {
+        if (!$targetObject instanceof DimensionContentInterface) {
+            return;
+        }
+
+        if (!$sourceObject instanceof DimensionContentInterface) {
+            return;
+        }
+
+        if ($ghostLocale = $sourceObject->getGhostLocale()) {
+            $targetObject->setGhostLocale($ghostLocale);
+        }
+
+        foreach ($sourceObject->getAvailableLocales() ?: [] as $availableLocale) {
+            $targetObject->addAvailableLocale($availableLocale);
+        }
+    }
+}
diff --git a/Content/Application/ContentMerger/Merger/ExcerptMerger.php b/Content/Application/ContentMerger/Merger/ExcerptMerger.php
@@ -15,7 +15,11 @@
 
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\ExcerptInterface;
 
-class ExcerptMerger implements MergerInterface
+/**
+ * @internal This class should not be instantiated by a project.
+ *           Create your own merger instead.
+ */
+final class ExcerptMerger implements MergerInterface
 {
     public function merge(object $targetObject, object $sourceObject): void
     {

diff --git a/Content/Application/ContentMerger/Merger/SeoMerger.php b/Content/Application/ContentMerger/Merger/SeoMerger.php
@@ -15,7 +15,11 @@
 
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\SeoInterface;
 
-class SeoMerger implements MergerInterface
+/**
+ * @internal This class should not be instantiated by a project.
+ *           Create your own merger instead.
+ */
+final class SeoMerger implements MergerInterface
 {
     public function merge(object $targetObject, object $sourceObject): void
     {

diff --git a/Content/Application/ContentMerger/Merger/TemplateMerger.php b/Content/Application/ContentMerger/Merger/TemplateMerger.php
@@ -15,7 +15,11 @@
 
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\TemplateInterface;
 
-class TemplateMerger implements MergerInterface
+/**
+ * @internal This class should not be instantiated by a project.
+ *           Create your own merger instead.
+ */
+final class TemplateMerger implements MergerInterface
 {
     public function merge(object $targetObject, object $sourceObject): void
     {

diff --git a/Content/Application/ContentMerger/Merger/WorkflowMerger.php b/Content/Application/ContentMerger/Merger/WorkflowMerger.php
@@ -15,7 +15,11 @@
 
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\WorkflowInterface;
 
-class WorkflowMerger implements MergerInterface
+/**
+ * @internal This class should not be instantiated by a project.
+ *           Create your own merger instead.
+ */
+final class WorkflowMerger implements MergerInterface
 {
     public function merge(object $targetObject, object $sourceObject): void
     {

diff --git a/Content/Application/DimensionContentCollectionFactory/DimensionContentCollectionFactory.php b/Content/Application/DimensionContentCollectionFactory/DimensionContentCollectionFactory.php
@@ -13,8 +13,6 @@
 
 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\Domain\Factory\DimensionContentCollectionFactoryInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\ContentRichEntityInterface;
@@ -60,41 +58,42 @@ public function create(
         $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
+        $locale = $dimensionAttributes['locale'] ?? null;
+        if ($locale) {
             $localizedDimensionContent = $dimensionContentCollection->getDimensionContent($dimensionAttributes);
 
             if (!$localizedDimensionContent) {
                 $localizedDimensionContent = $this->createContentDimension(
                     $contentRichEntity,
-                    $dimensionContents,
                     $dimensionAttributes
                 );
-                $orderedContentDimensions[] = $localizedDimensionContent;
+
+                $unlocalizedDimensionContent->addAvailableLocale($locale);
+
+                if (!$unlocalizedDimensionContent->getGhostLocale()) {
+                    $unlocalizedDimensionContent->setGhostLocale($locale);
+                }
             }
         }
 
         $dimensionContentCollection = new DimensionContentCollection(
-            $orderedContentDimensions,
+            \array_filter([
+                $unlocalizedDimensionContent,
+                $localizedDimensionContent,
+            ]),
             $dimensionAttributes,
             $dimensionContentCollection->getDimensionContentClass()
         );
@@ -105,12 +104,10 @@ public function create(
     }
 
     /**
-     * @param Collection<int, DimensionContentInterface> $dimensionContents
      * @param mixed[] $attributes
      */
     private function createContentDimension(
         ContentRichEntityInterface $contentRichEntity,
-        Collection $dimensionContents,
         array $attributes
     ): DimensionContentInterface {
         $dimensionContent = $contentRichEntity->createDimensionContent();
@@ -120,7 +117,6 @@ private function createContentDimension(
         }
 
         $contentRichEntity->addDimensionContent($dimensionContent);
-        $dimensionContents->add($dimensionContent);
 
         return $dimensionContent;
     }

diff --git a/Content/Domain/Model/DimensionContentInterface.php b/Content/Domain/Model/DimensionContentInterface.php
@@ -22,16 +22,42 @@ public static function getResourceKey(): string;
 
     public function getLocale(): ?string;
 
+    /**
+     * @internal should only be set by content bundle services not from outside
+     */
     public function setLocale(?string $locale): void;
 
+    /**
+     * @internal should only be set by content bundle services not from outside
+     */
+    public function setGhostLocale(?string $ghostLocale): void;
+
+    public function getGhostLocale(): ?string;
+
+    /**
+     * @internal should only be set by content bundle services not from outside
+     */
+    public function addAvailableLocale(string $availableLocale): void;
+
+    /**
+     * @return string[]|null
+     */
+    public function getAvailableLocales(): ?array;
+
     public function getStage(): string;
 
+    /**
+     * @internal should only be set by content bundle services not from outside
+     */
     public function setStage(string $stage): void;
 
     public function getResource(): ContentRichEntityInterface;
 
     public function isMerged(): bool;
 
+    /**
+     * @internal should only be set by content bundle services not from outside
+     */
     public function markAsMerged(): void;
 
     /**

diff --git a/Content/Domain/Model/DimensionContentTrait.php b/Content/Domain/Model/DimensionContentTrait.php
@@ -20,6 +20,16 @@ trait DimensionContentTrait
      */
     protected $locale;
 
+    /**
+     * @var string|null
+     */
+    protected $ghostLocale;
+
+    /**
+     * @var string[]|null
+     */
+    protected $availableLocales;
+
     /**
      * @var string
      */
@@ -30,6 +40,9 @@ trait DimensionContentTrait
      */
     private $isMerged = false;
 
+    /**
+     * @internal should only be set by content bundle services not from outside
+     */
     public function setLocale(?string $locale): void
     {
         $this->locale = $locale;
@@ -40,6 +53,41 @@ public function getLocale(): ?string
         return $this->locale;
     }
 
+    /**
+     * @internal should only be set by content bundle services not from outside
+     */
+    public function setGhostLocale(?string $ghostLocale): void
+    {
+        $this->ghostLocale = $ghostLocale;
+    }
+
+    public function getGhostLocale(): ?string
+    {
+        return $this->ghostLocale;
+    }
+
+    /**
+     * @internal should only be set by content bundle services not from outside
+     */
+    public function addAvailableLocale(string $availableLocale): void
+    {
+        if (null === $this->availableLocales) {
+            $this->availableLocales = [];
+        }
+
+        if (!\in_array($availableLocale, $this->availableLocales, true)) {
+            $this->availableLocales[] = $availableLocale;
+        }
+    }
+
+    public function getAvailableLocales(): ?array
+    {
+        return $this->availableLocales;
+    }
+
+    /**
+     * @internal should only be set by content bundle services not from outside
+     */
     public function setStage(string $stage): void
     {
         $this->stage = $stage;
@@ -55,6 +103,9 @@ public function isMerged(): bool
         return $this->isMerged;
     }
 
+    /**
+     * @internal should only be set by content bundle services not from outside
+     */
     public function markAsMerged(): void
     {
         $this->isMerged = true;

diff --git a/Content/Infrastructure/Doctrine/DimensionContentQueryEnhancer.php b/Content/Infrastructure/Doctrine/DimensionContentQueryEnhancer.php
@@ -23,8 +23,7 @@
 use Webmozart\Assert\Assert;
 
 /**
- * TODO add loadGhost functionality
- *      add loadShadow functionality.
+ * TODO add loadShadow functionality.
  *
  * @final
  */
@@ -88,6 +87,7 @@ public function __construct(
      *     tagNames?: string[],
      *     tagOperator?: 'AND'|'OR',
      *     templateKeys?: string[],
+     *     loadGhost?: bool,
      * } $filters
      */
     public function addFilters(
@@ -114,6 +114,11 @@ public function addFilters(
                 continue;
             }
 
+            if ('locale' === $key && ($filters['loadGhost'] ?? false)) {
+                // do not filter by locale when loadGhost is active
+                continue;
+            }
+
             $queryBuilder->andWhere('filterDimensionContent.' . $key . '= :' . $key)
                 ->setParameter($key, $value);
         }

diff --git a/Content/Infrastructure/Doctrine/MetadataLoader.php b/Content/Infrastructure/Doctrine/MetadataLoader.php
@@ -47,6 +47,8 @@ public function loadClassMetadata(LoadClassMetadataEventArgs $event): void
         if ($reflection->implementsInterface(DimensionContentInterface::class)) {
             $this->addField($metadata, 'stage', 'string', ['length' => 16, 'nullable' => false]);
             $this->addField($metadata, 'locale', 'string', ['length' => 7, 'nullable' => true]);
+            $this->addField($metadata, 'ghostLocale', 'string', ['length' => 7, 'nullable' => true]);
+            $this->addField($metadata, 'availableLocales', 'json', ['nullable' => true]);
         }
 
         if ($reflection->implementsInterface(SeoInterface::class)) {

diff --git a/Content/Infrastructure/Sulu/Preview/ContentObjectProvider.php b/Content/Infrastructure/Sulu/Preview/ContentObjectProvider.php
@@ -181,6 +181,11 @@ protected function resolveContent(ContentRichEntityInterface $contentRichEntity,
                 ]
             );
 
+            if (!$resolvedDimensionContent->getLocale()) {
+                // avoid 500 error when ghostLocale is loaded
+                $resolvedDimensionContent->setLocale($locale);
+            }
+
             return $resolvedDimensionContent;
         } catch (ContentNotFoundException $exception) {
             return null;

diff --git a/Resources/config/merger.xml b/Resources/config/merger.xml
@@ -4,6 +4,10 @@
            xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
     <services>
         <!-- Merger -->
+        <service id="sulu_content.dimension_content_merger" class="Sulu\Bundle\ContentBundle\Content\Application\ContentMerger\Merger\DimensionContentMerger">
+            <tag name="sulu_content.merger" priority="256"/>
+        </service>
+
         <service id="`sulu_content.template_merger`" class="Sulu\Bundle\ContentBundle\Content\Application\ContentMerger\Merger\TemplateMerger">
             <tag name="sulu_content.merger" priority="128"/>
         </service>