Add additional webspaces field

sulu · Oct 14, 2021 · 1134821 · 1134821
1 parent ecfab9d
commit 1134821
Show file tree

Hide file tree

Showing 16 changed files with 118 additions and 6 deletions.
diff --git a/Content/Application/ContentDataMapper/DataMapper/WebspaceDataMapper.php b/Content/Application/ContentDataMapper/DataMapper/WebspaceDataMapper.php
@@ -61,6 +61,10 @@ private function setWebspaceData(WebspaceInterface $dimensionContent, array $dat
             // if no main webspace is yet set a default webspace will be set
             $dimensionContent->setMainWebspace($this->getDefaultWebspaceKey());
         }
+
+        if (\array_key_exists('additionalWebspaces', $data)) {
+            $dimensionContent->setAdditionalWebspaces($data['additionalWebspaces'] ?: []);
+        }
     }
 
     private function getDefaultWebspaceKey(): ?string

diff --git a/Content/Application/ContentMerger/Merger/WebspaceMerger.php b/Content/Application/ContentMerger/Merger/WebspaceMerger.php
@@ -30,5 +30,9 @@ public function merge(object $targetObject, object $sourceObject): void
         if ($mainWebspace = $sourceObject->getMainWebspace()) {
             $targetObject->setMainWebspace($mainWebspace);
         }
+
+        if ($additionalWebspaces = $sourceObject->getAdditionalWebspaces()) {
+            $targetObject->setAdditionalWebspaces($additionalWebspaces);
+        }
     }
 }
diff --git a/Content/Domain/Model/WebspaceInterface.php b/Content/Domain/Model/WebspaceInterface.php
@@ -18,4 +18,14 @@ interface WebspaceInterface
     public function getMainWebspace(): ?string;
 
     public function setMainWebspace(?string $mainWebspace): void;
+
+    /**
+     * @return string[]
+     */
+    public function getAdditionalWebspaces(): array;
+
+    /**
+     * @param string[] $additionalWebspaces
+     */
+    public function setAdditionalWebspaces(array $additionalWebspaces): void;
 }
diff --git a/Content/Domain/Model/WebspaceTrait.php b/Content/Domain/Model/WebspaceTrait.php
@@ -20,6 +20,11 @@ trait WebspaceTrait
      */
     protected $mainWebspace;
 
+    /**
+     * @var string[]|null
+     */
+    protected $additionalWebspaces;
+
     public function getMainWebspace(): ?string
     {
         return $this->mainWebspace;
@@ -28,5 +33,31 @@ public function getMainWebspace(): ?string
     public function setMainWebspace(?string $mainWebspace): void
     {
         $this->mainWebspace = $mainWebspace;
+
+        if ($mainWebspace && !\in_array($mainWebspace, $this->additionalWebspaces ?: [], true)) {
+            // additional webspace always include also the main webspace to make query simpler
+            $this->additionalWebspaces = \array_merge($this->additionalWebspaces ?: [], [$mainWebspace]);
+        }
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getAdditionalWebspaces(): array
+    {
+        return $this->additionalWebspaces ?: [];
+    }
+
+    /**
+     * @param string[] $additionalWebspaces
+     */
+    public function setAdditionalWebspaces(array $additionalWebspaces): void
+    {
+        if ($this->mainWebspace && !\in_array($this->mainWebspace, $additionalWebspaces, true)) {
+            // additional webspace always include also the main webspace to make query simpler
+            $additionalWebspaces[] = $this->mainWebspace;
+        }
+
+        $this->additionalWebspaces = $additionalWebspaces;
     }
 }
diff --git a/Content/Infrastructure/Doctrine/MetadataLoader.php b/Content/Infrastructure/Doctrine/MetadataLoader.php
@@ -97,6 +97,7 @@ public function loadClassMetadata(LoadClassMetadataEventArgs $event): void
 
         if ($reflection->implementsInterface(WebspaceInterface::class)) {
             $this->addField($metadata, 'mainWebspace', 'string', ['nullable' => true]);
+            $this->addField($metadata, 'additionalWebspaces', 'json', ['nullable' => true]);
         }
 
         if ($reflection->implementsInterface(AuthorInterface::class)) {

diff --git a/Resources/config/forms/content_settings_webspace.xml b/Resources/config/forms/content_settings_webspace.xml
@@ -14,7 +14,7 @@
             </meta>
 
             <properties>
-                <property name="mainWebspace" type="single_select" colspan="6" spaceAfter="6">
+                <property name="mainWebspace" type="single_select" colspan="6">
                     <meta>
                         <title>sulu_content.main_webspace</title>
                     </meta>
@@ -27,6 +27,20 @@
                         />
                     </params>
                 </property>
+
+                <property name="additionalWebspaces" type="select" colspan="6">
+                    <meta>
+                        <title>sulu_content.additional_webspaces</title>
+                    </meta>
+
+                    <params>
+                        <param
+                            name="values"
+                            type="expression"
+                            value="service('sulu_content.webspace_select').getValues()"
+                        />
+                    </params>
+                </property>
             </properties>
         </section>
     </properties>

diff --git a/Tests/Functional/Integration/ExampleControllerTest.php b/Tests/Functional/Integration/ExampleControllerTest.php
@@ -67,6 +67,7 @@ public function testPostPublish(): int
             'author' => null,
             'authored' => '2020-05-08T00:00:00+00:00',
             'mainWebspace' => 'sulu-io',
+            'additionalWebspaces' => ['sulu-io', 'sulu-io2'],
         ]) ?: null);
 
         $response = $this->client->getResponse();
@@ -134,6 +135,7 @@ public function testPost(): int
             'excerptIcon' => null,
             'excerptMedia' => null,
             'mainWebspace' => 'sulu-io',
+            'additionalWebspaces' => ['sulu-io', 'sulu-io2'],
             'authored' => '2020-05-08T00:00:00+00:00',
         ]) ?: null);
 
@@ -194,6 +196,7 @@ public function testPut(int $id): void
             'excerptMedia' => null,
             'authored' => '2020-06-09T00:00:00+00:00',
             'mainWebspace' => 'sulu-io2',
+            'additionalWebspaces' => ['sulu-io', 'sulu-io2'],
         ]) ?: null);
 
         $response = $this->client->getResponse();

diff --git a/Tests/Functional/Integration/responses/example_get.json b/Tests/Functional/Integration/responses/example_get.json
@@ -28,5 +28,6 @@
     "title": "Test Example",
     "url": "/my-example",
     "workflowPlace": "unpublished",
-    "mainWebspace": "sulu-io"
+    "mainWebspace": "sulu-io",
+    "additionalWebspaces": ["sulu-io", "sulu-io2"]
 }
diff --git a/Tests/Functional/Integration/responses/example_post.json b/Tests/Functional/Integration/responses/example_post.json
@@ -28,5 +28,6 @@
     "title": "Test Example",
     "url": "/my-example",
     "workflowPlace": "unpublished",
-    "mainWebspace": "sulu-io"
+    "mainWebspace": "sulu-io",
+    "additionalWebspaces": ["sulu-io", "sulu-io2"]
 }
diff --git a/Tests/Functional/Integration/responses/example_post_publish.json b/Tests/Functional/Integration/responses/example_post_publish.json
@@ -28,5 +28,6 @@
     "title": "Test Example",
     "url": "/my-example",
     "workflowPlace": "published",
-    "mainWebspace": "sulu-io"
+    "mainWebspace": "sulu-io",
+    "additionalWebspaces": ["sulu-io", "sulu-io2"]
 }
diff --git a/Tests/Functional/Integration/responses/example_post_trigger_unpublish.json b/Tests/Functional/Integration/responses/example_post_trigger_unpublish.json
@@ -28,5 +28,6 @@
     "title": "Test Example",
     "url": "\/my-example",
     "workflowPlace": "unpublished",
-    "mainWebspace": "sulu-io"
+    "mainWebspace": "sulu-io",
+    "additionalWebspaces": ["sulu-io", "sulu-io2"]
 }
diff --git a/Tests/Functional/Integration/responses/example_put.json b/Tests/Functional/Integration/responses/example_put.json
@@ -31,5 +31,6 @@
     "title": "Test Example 2",
     "url": "/my-example-2",
     "workflowPlace": "unpublished",
-    "mainWebspace": "sulu-io2"
+    "mainWebspace": "sulu-io2",
+    "additionalWebspaces": ["sulu-io", "sulu-io2"]
 }
diff --git a/Tests/Unit/Content/Application/ContentDataMapper/DataMapper/WebspaceDataMapperTest.php b/Tests/Unit/Content/Application/ContentDataMapper/DataMapper/WebspaceDataMapperTest.php
@@ -75,6 +75,7 @@ public function testMapWebspaceNoData(): void
         $authorMapper->map($unlocalizedDimensionContent, $localizedDimensionContent, $data);
 
         $this->assertNull($localizedDimensionContent->getMainWebspace());
+        $this->assertSame([], $localizedDimensionContent->getAdditionalWebspaces());
     }
 
     public function testMapDefaultWebspace(): void
@@ -93,12 +94,14 @@ public function testMapDefaultWebspace(): void
         $authorMapper->map($unlocalizedDimensionContent, $localizedDimensionContent, $data);
 
         $this->assertSame('default-webspace', $localizedDimensionContent->getMainWebspace());
+        $this->assertSame(['default-webspace'], $localizedDimensionContent->getAdditionalWebspaces());
     }
 
     public function testMapData(): void
     {
         $data = [
             'mainWebspace' => 'example',
+            'additionalWebspaces' => ['example', 'example2'],
         ];
 
         $example = new Example();
@@ -109,22 +112,26 @@ public function testMapData(): void
         $authorMapper->map($unlocalizedDimensionContent, $localizedDimensionContent, $data);
 
         $this->assertSame('example', $localizedDimensionContent->getMainWebspace());
+        $this->assertSame(['example', 'example2'], $localizedDimensionContent->getAdditionalWebspaces());
     }
 
     public function testMapDataEmpty(): void
     {
         $data = [
             'mainWebspace' => null,
+            'additionalWebspaces' => null,
         ];
 
         $example = new Example();
         $unlocalizedDimensionContent = new ExampleDimensionContent($example);
         $localizedDimensionContent = new ExampleDimensionContent($example);
         $localizedDimensionContent->setMainWebspace('example');
+        $localizedDimensionContent->setAdditionalWebspaces(['example', 'example2']);
 
         $authorMapper = $this->createWebspaceDataMapperInstance();
         $authorMapper->map($unlocalizedDimensionContent, $localizedDimensionContent, $data);
 
         $this->assertNull($localizedDimensionContent->getMainWebspace());
+        $this->assertSame([], $localizedDimensionContent->getAdditionalWebspaces());
     }
 }
diff --git a/Tests/Unit/Content/Application/ContentMerger/Merger/WebspaceMergerTest.php b/Tests/Unit/Content/Application/ContentMerger/Merger/WebspaceMergerTest.php
@@ -58,14 +58,17 @@ public function testMergeSet(): void
         $merger = $this->getWebspaceMergerInstance();
 
         $mainWebspace = 'sulu-io';
+        $additionalWebspaces = ['sulu-io', 'sulu-io2'];
 
         $source = $this->prophesize(DimensionContentInterface::class);
         $source->willImplement(WebspaceInterface::class);
         $source->getMainWebspace()->willReturn($mainWebspace)->shouldBeCalled();
+        $source->getAdditionalWebspaces()->willReturn($additionalWebspaces)->shouldBeCalled();
 
         $target = $this->prophesize(DimensionContentInterface::class);
         $target->willImplement(WebspaceInterface::class);
         $target->setMainWebspace($mainWebspace)->shouldBeCalled();
+        $target->setAdditionalWebspaces($additionalWebspaces)->shouldBeCalled();
 
         $merger->merge($target->reveal(), $source->reveal());
     }
@@ -77,10 +80,12 @@ public function testMergeNotSet(): void
         $source = $this->prophesize(DimensionContentInterface::class);
         $source->willImplement(WebspaceInterface::class);
         $source->getMainWebspace()->willReturn(null)->shouldBeCalled();
+        $source->getAdditionalWebspaces()->willReturn([])->shouldBeCalled();
 
         $target = $this->prophesize(DimensionContentInterface::class);
         $target->willImplement(WebspaceInterface::class);
         $target->setMainWebspace(Argument::any())->shouldNotBeCalled();
+        $target->setAdditionalWebspaces(Argument::any())->shouldNotBeCalled();
 
         $merger->merge($target->reveal(), $source->reveal());
     }

diff --git a/Tests/Unit/Content/Domain/Model/WebspaceTraitTest.php b/Tests/Unit/Content/Domain/Model/WebspaceTraitTest.php
@@ -33,4 +33,31 @@ public function testGetSetMainWebspace(): void
         $model->setMainWebspace('example');
         $this->assertSame('example', $model->getMainWebspace());
     }
+
+    public function testGetSetAdditionalWebspaces(): void
+    {
+        $model = $this->getWebspaceInstance();
+        $this->assertSame([], $model->getAdditionalWebspaces());
+        $model->setAdditionalWebspaces(['example', 'example2']);
+        $this->assertSame(['example', 'example2'], $model->getAdditionalWebspaces());
+    }
+
+    public function testMainWebspaceAlwaysAdditionalWebspaces(): void
+    {
+        $model = $this->getWebspaceInstance();
+        $model->setMainWebspace('example');
+
+        $this->assertSame('example', $model->getMainWebspace());
+        $this->assertSame(['example'], $model->getAdditionalWebspaces());
+    }
+
+    public function testAdditionalWebspacesWithoutMainWebspace(): void
+    {
+        $model = $this->getWebspaceInstance();
+        $model->setMainWebspace('example');
+        $model->setAdditionalWebspaces(['example-2']);
+
+        $this->assertSame('example', $model->getMainWebspace());
+        $this->assertSame(['example-2', 'example'], $model->getAdditionalWebspaces());
+    }
 }
diff --git a/Tests/Unit/Content/Infrastructure/Doctrine/MetadataLoaderTest.php b/Tests/Unit/Content/Infrastructure/Doctrine/MetadataLoaderTest.php
@@ -252,6 +252,7 @@ public function dataProvider(): \Generator
             ],
             [
                 'mainWebspace' => true,
+                'additionalWebspaces' => true,
             ],
             [],
             [],
-Original file line number
+Diff line change
@@ Expand Up / @@ -252,6 +252,7 @@ public function dataProvider(): \Generator @@
                 ],
                 [
                     'mainWebspace' => true,
+                    'additionalWebspaces' => true,
                 ],
                 [],
                 [],
@@ Expand Down @@