allow creation of multiple entries in 1 request (#993)

Author: lukmzig

src/Translation/Repository/TranslationRepository.php

@@ -20,6 +20,7 @@
 use Pimcore\Bundle\StudioBackendBundle\Exception\Api\ElementExistsException;
 use Pimcore\Bundle\StudioBackendBundle\Exception\Api\InvalidLocaleException;
 use Pimcore\Bundle\StudioBackendBundle\Exception\Api\NotFoundException;
+use Pimcore\Bundle\StudioBackendBundle\Translation\Schema\CreateTranslationData;
 use Pimcore\Bundle\StudioBackendBundle\Translation\Schema\TranslationData;
 use Pimcore\Bundle\StudioBackendBundle\Translation\Service\TranslatorServiceInterface;
 use Pimcore\Model\Translation;
@@ -55,25 +56,20 @@ public function getAllTranslations(string $locale): array
     /**
      * {@inheritdoc}
      */
-    public function createTranslations(string $key, string $type): void
+    public function createTranslations(array $translationData): void
     {
         $languages = $this->adminResolver->getLanguages();
 
-        if ($this->getTranslationByKey($key) !== null) {
-            throw new ElementExistsException(
-                sprintf("Translation with key '%s' already exists", $key),
-            );
-        }
-
-        $t = new Translation();
-        $t->setDomain(TranslatorServiceInterface::DOMAIN);
-        $t->setKey($key);
-        $t->setType($type);
-        $t->setCreationDate(time());
-        $t->setModificationDate(time());
-        $this->setNewValues($t, $languages);
-        $t->save();
+        /** @var CreateTranslationData $translation */
+        foreach ($translationData as $translation) {
+            if ($this->getTranslationByKey($translation->getKey()) !== null) {
+                throw new ElementExistsException(
+                    sprintf("Translation with key '%s' already exists", $translation->getKey()),
+                );
+            }
 
+            $this->createTranslationEntry($translation->getKey(), $translation->getType(), $languages);
+        }
     }
 
     /**
@@ -86,18 +82,15 @@ public function updateTranslations(array $translationData, string $locale): void
 
         /** @var TranslationData $translation */
         foreach ($translationData as $translation) {
-            if ($this->getTranslationByKey($translation->getKey()) === null) {
+            $entry = $this->getTranslationByKey($translation->getKey());
+            if ($entry === null) {
                 throw new NotFoundException('translation', $translation->getKey(), 'key');
             }
 
-            $t = new Translation();
-            $t->setDomain(TranslatorServiceInterface::DOMAIN);
-            $t->setKey($translation->getKey());
-            $t->setType($translation->getType());
-            $t->addTranslation($locale, $translation->getTranslation());
-            $t->setCreationDate(time());
-            $t->setModificationDate(time());
-            $t->save();
+            $entry->addTranslation($locale, $translation->getTranslation());
+            $entry->setType($translation->getType());
+            $entry->setModificationDate(time());
+            $entry->save();
         }
     }
 
@@ -111,6 +104,18 @@ public function deleteTranslation(string $key): void
         $translation->delete();
     }
 
+    private function createTranslationEntry(string $key, string $type, array $languages): void
+    {
+        $t = new Translation();
+        $t->setDomain(TranslatorServiceInterface::DOMAIN);
+        $t->setKey($key);
+        $t->setType($type);
+        $t->setCreationDate(time());
+        $t->setModificationDate(time());
+        $this->setNewValues($t, $languages);
+        $t->save();
+    }
+
     private function getTranslationList(): Listing
     {
         $list = new Translation\Listing();

src/Translation/Repository/TranslationRepositoryInterface.php

@@ -36,7 +36,7 @@ public function getAllTranslations(string $locale): array;
     /**
      * @throws ElementExistsException
      */
-    public function createTranslations(string $key, string $type): void;
+    public function createTranslations(array $translationData): void;
 
     /**
      * @param array<TranslationData> $translationData

src/Translation/Schema/CreateTranslation.php

@@ -16,6 +16,7 @@
 
 namespace Pimcore\Bundle\StudioBackendBundle\Translation\Schema;
 
+use OpenApi\Attributes\Items;
 use OpenApi\Attributes\Property;
 use OpenApi\Attributes\Schema;
 
@@ -26,26 +27,22 @@
     schema: 'CreateTranslation',
     title: 'Translation Create',
     description: 'Translation Crete Scheme for API',
-    required: ['key', 'type'],
+    required: ['translationData'],
     type: 'object'
 )]
 final readonly class CreateTranslation
 {
     public function __construct(
-        #[Property(description: 'Key', type: 'string', example: 'my_translation_key')]
-        private string $key,
-        #[Property(description: 'Type', type: 'string', example: 'simple')]
-        private string $type = 'simple',
+        #[Property(description: 'Translation Data', type: 'array', items: new Items(ref: CreateTranslationData::class))]
+        private array $translationData = []
     ) {
     }
 
-    public function getKey(): string
+    /**
+     * @return array<CreateTranslationData>
+     */
+    public function getTranslationData(): array
     {
-        return $this->key;
-    }
-
-    public function getType(): string
-    {
-        return $this->type;
+        return $this->translationData;
     }
 }

src/Translation/Schema/CreateTranslationData.php

@@ -0,0 +1,51 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Pimcore
+ *
+ * This source file is available under two different licenses:
+ * - GNU General Public License version 3 (GPLv3)
+ * - Pimcore Commercial License (PCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
+ *  @license    http://www.pimcore.org/license     GPLv3 and PCL
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\Translation\Schema;
+
+use OpenApi\Attributes\Property;
+use OpenApi\Attributes\Schema;
+
+/**
+ * @internal
+ */
+#[Schema(
+    schema: 'CreateTranslationData',
+    title: 'Translation Data for create',
+    description: 'Translation Data Scheme for create endpoint of the API',
+    required: ['key', 'type'],
+    type: 'object'
+)]
+final readonly class CreateTranslationData
+{
+    public function __construct(
+        #[Property(description: 'Key', type: 'string', example: 'my_translation_key')]
+        private string $key,
+        #[Property(description: 'Type', type: 'string', example: 'simple')]
+        private string $type = 'simple',
+    ) {
+    }
+
+    public function getKey(): string
+    {
+        return $this->key;
+    }
+
+    public function getType(): string
+    {
+        return $this->type;
+    }
+}

src/Translation/Service/TranslatorService.php

@@ -42,11 +42,17 @@ public function __construct(
         $this->translatorBag = $this->getTranslatorBag();
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function createTranslations(CreateTranslation $translation): void
     {
-        $this->translationRepository->createTranslations($translation->getKey(), $translation->getType());
+        $this->translationRepository->createTranslations($translation->getTranslationData());
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function updateTranslations(UpdateTranslation $translation): void
     {
         $this->translationRepository->updateTranslations($translation->getTranslationData(), $translation->getLocale());