[PageSnippet Import Error] (#22)

mike4git · web-flow · commit c6e45543eb2e · 2025-08-11T10:25:01.000+02:00
* [PageSnippet Import Error] Fix it by introducing Snippet instead of PageSnippet type

* [PageSnippet Import Error] Separating PageImportPopulator into three different Populators because of separation of concerns
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,16 @@
 # Changelog
 
+## 3.0.0
+
+- BC-break: bugfix: Import of exported Page Snippet documents by changing type to `Pimcore\Model\Document\Snippet`
+  You have to change the key of your already exported YAML files 
+  from `Pimcore\Model\Document\PageSnippet` to `Pimcore\Model\Document\Snippet`
+- improvement: Refactoring of PageImportPopulator - separated into three new Populators
+
 ## 2.1.0
 
 - feature: [With or Without IDs] Export and Import should be possible without IDs (#20)
+- change: You have to change the key of already exported YAML files from `Pimcore\Model\Document` to `Pimcore\Model\Document\Page`
 
 ## 2.0.1
 
diff --git a/config/pimcore/export/documents/converters_populators.yaml b/config/pimcore/export/documents/converters_populators.yaml
@@ -28,12 +28,12 @@ neusta_converter:
         published: ~
         path: ~
 
-    neusta_pimcore_import_export.export_page_snippet:
-      target: Neusta\Pimcore\ImportExportBundle\Model\Document\PageSnippet
+    neusta_pimcore_import_export.export_snippet:
+      target: Neusta\Pimcore\ImportExportBundle\Model\Document\Snippet
       populators:
         - Neusta\Pimcore\ImportExportBundle\Populator\IdsPopulator
-        - neusta_pimcore_import_export.page_snippet.controller.populator
-        - neusta_pimcore_import_export.page_snippet.editables.populator
+        - neusta_pimcore_import_export.snippet.controller.populator
+        - neusta_pimcore_import_export.snippet.editables.populator
         - neusta_pimcore_import_export.document.properties.populator
       properties:
         key: ~
@@ -45,8 +45,8 @@ neusta_converter:
       target: Neusta\Pimcore\ImportExportBundle\Model\Document\Page
       populators:
         - Neusta\Pimcore\ImportExportBundle\Populator\IdsPopulator
-        - neusta_pimcore_import_export.page_snippet.controller.populator
-        - neusta_pimcore_import_export.page_snippet.editables.populator
+        - neusta_pimcore_import_export.snippet.controller.populator
+        - neusta_pimcore_import_export.snippet.editables.populator
         - neusta_pimcore_import_export.page.title.populator
         - neusta_pimcore_import_export.document.properties.populator
       properties:
@@ -84,7 +84,7 @@ services:
     arguments:
       $typeToConverterMap:
         Pimcore\Model\Document\Page: '@neusta_pimcore_import_export.export_page'
-        Pimcore\Model\Document\PageSnippet: '@neusta_pimcore_import_export.export_page_snippet'
+        Pimcore\Model\Document\PageSnippet: '@neusta_pimcore_import_export.export_snippet'
         Pimcore\Model\Document\Folder: '@neusta_pimcore_import_export.export_folder'
         Pimcore\Model\Document: '@neusta_pimcore_import_export.export_document'
 
@@ -99,13 +99,13 @@ services:
       $sourceProperty: title
       $targetProperty: title
 
-  neusta_pimcore_import_export.page_snippet.controller.populator:
+  neusta_pimcore_import_export.snippet.controller.populator:
     class: Neusta\ConverterBundle\Populator\PropertyMappingPopulator
     arguments:
       $sourceProperty: controller
       $targetProperty: controller
 
-  neusta_pimcore_import_export.page_snippet.editables.populator:
+  neusta_pimcore_import_export.snippet.editables.populator:
     class: Neusta\ConverterBundle\Populator\ArrayConvertingPopulator
     arguments:
       $converter: '@neusta_pimcore_import_export.editable_converter'
diff --git a/config/pimcore/import/documents/converters_populators.yaml b/config/pimcore/import/documents/converters_populators.yaml
@@ -27,10 +27,12 @@ neusta_converter:
         - neusta_pimcore_import_export.documents.import.populator.published
         - neusta_pimcore_import_export.documents.import.populator.path
         - neusta_pimcore_import_export.documents.import.populator.parentId
-        - Neusta\Pimcore\ImportExportBundle\Populator\PageImportPopulator
+        - Neusta\Pimcore\ImportExportBundle\Populator\Document\EditablesPopulator
+        - Neusta\Pimcore\ImportExportBundle\Populator\Document\PropertiesPopulator
+        - Neusta\Pimcore\ImportExportBundle\Populator\Document\PageTitlePopulator
 
-    neusta_pimcore_import_export.import_page_snippet:
-      target: Pimcore\Model\Document\PageSnippet
+    neusta_pimcore_import_export.import_snippet:
+      target: Pimcore\Model\Document\Snippet
       populators:
         - neusta_pimcore_import_export.documents.import.populator.id
         - neusta_pimcore_import_export.documents.import.populator.key
@@ -39,7 +41,8 @@ neusta_converter:
         - neusta_pimcore_import_export.documents.import.populator.published
         - neusta_pimcore_import_export.documents.import.populator.path
         - neusta_pimcore_import_export.documents.import.populator.parentId
-        - Neusta\Pimcore\ImportExportBundle\Populator\PageImportPopulator
+        - Neusta\Pimcore\ImportExportBundle\Populator\Document\EditablesPopulator
+        - Neusta\Pimcore\ImportExportBundle\Populator\Document\PropertiesPopulator
 
 services:
   _defaults:
@@ -96,4 +99,6 @@ services:
       $targetProperty: parentId
       $defaultValue: 0
 
-  Neusta\Pimcore\ImportExportBundle\Populator\PageImportPopulator: ~
+  Neusta\Pimcore\ImportExportBundle\Populator\Document\PropertiesPopulator: ~
+  Neusta\Pimcore\ImportExportBundle\Populator\Document\EditablesPopulator: ~
+  Neusta\Pimcore\ImportExportBundle\Populator\Document\PageTitlePopulator: ~
diff --git a/config/services.yaml b/config/services.yaml
@@ -90,7 +90,7 @@ services:
       $typeToConverterMap:
         Pimcore\Model\Asset: '@neusta_pimcore_import_export.strategy.export_asset'
         Pimcore\Model\Document\Page: '@neusta_pimcore_import_export.strategy.export_document'
-        Pimcore\Model\Document\PageSnippet: '@neusta_pimcore_import_export.strategy.export_document'
+        Pimcore\Model\Document\Snippet: '@neusta_pimcore_import_export.strategy.export_document'
         Pimcore\Model\Document: '@neusta_pimcore_import_export.strategy.export_document'
         Pimcore\Model\DataObject: '@neusta_pimcore_import_export.export_object'
       $serializer: '@Neusta\Pimcore\ImportExportBundle\Serializer\SerializerStrategy'
@@ -103,7 +103,7 @@ services:
       - { name: 'neusta.import_export.merge_strategy', type: 'Pimcore\Model\Document' }
       - { name: 'neusta.import_export.merge_strategy', type: 'Pimcore\Model\Document\Folder' }
       - { name: 'neusta.import_export.merge_strategy', type: 'Pimcore\Model\Document\Page' }
-      - { name: 'neusta.import_export.merge_strategy', type: 'Pimcore\Model\Document\PageSnippet' }
+      - { name: 'neusta.import_export.merge_strategy', type: 'Pimcore\Model\Document\Snippet' }
 
   Neusta\Pimcore\ImportExportBundle\Import\Strategy\ReplaceExistingElementStrategy:
     tags:
@@ -133,7 +133,7 @@ services:
       - { name: 'neusta.import_export.repository', type: 'Pimcore\Model\Document' }
       - { name: 'neusta.import_export.repository', type: 'Pimcore\Model\Document\Folder' }
       - { name: 'neusta.import_export.repository', type: 'Pimcore\Model\Document\Page' }
-      - { name: 'neusta.import_export.repository', type: 'Pimcore\Model\Document\PageSnippet' }
+      - { name: 'neusta.import_export.repository', type: 'Pimcore\Model\Document\Snippet' }
 
 
   ##############
diff --git a/docs/images/document_model.png b/docs/images/document_model.png
diff --git a/src/Model/Document/Page.php b/src/Model/Document/Page.php
@@ -2,7 +2,7 @@
 
 namespace Neusta\Pimcore\ImportExportBundle\Model\Document;
 
-class Page extends PageSnippet
+class Page extends Snippet
 {
     public ?string $title = null;
 }
diff --git a/src/Model/Document/Snippet.php b/src/Model/Document/Snippet.php
@@ -2,7 +2,7 @@
 
 namespace Neusta\Pimcore\ImportExportBundle\Model\Document;
 
-class PageSnippet extends Folder
+class Snippet extends Folder
 {
     public ?string $controller = null;
     /** @var array<Editable> */
diff --git a/src/Populator/Document/EditablesPopulator.php b/src/Populator/Document/EditablesPopulator.php
@@ -0,0 +1,41 @@
+<?php declare(strict_types=1);
+
+namespace Neusta\Pimcore\ImportExportBundle\Populator\Document;
+
+use Neusta\ConverterBundle\Converter\Context\GenericContext;
+use Neusta\ConverterBundle\Populator;
+use Pimcore\Model\Document as PimcoreDocument;
+use Psr\Log\LoggerInterface;
+
+/**
+ * @implements Populator<\ArrayObject<string, mixed>, PimcoreDocument, GenericContext|null>
+ */
+class EditablesPopulator implements Populator
+{
+    public function __construct(
+        private readonly ?LoggerInterface $logger = null,
+    ) {
+    }
+
+    /**
+     * @param \ArrayObject<string, mixed> $source
+     * @param PimcoreDocument             $target
+     * @param GenericContext|null         $ctx
+     */
+    public function populate(object $target, object $source, ?object $ctx = null): void
+    {
+        if ($target instanceof PimcoreDocument\PageSnippet) {
+            /** @var array{type: string, data: mixed} $editable */
+            foreach ($source['editables'] ?? [] as $key => $editable) {
+                if (!isset($editable['data'])) {
+                    $this->logger?->warning('Skipping editable with missing required fields', [
+                        'key' => $key,
+                        'editable' => $editable,
+                    ]);
+                    continue; // Skip editables with missing required fields
+                }
+                $target->setRawEditable((string) $key, $editable['type'], $editable['data']);
+            }
+        }
+    }
+}
diff --git a/src/Populator/Document/PageTitlePopulator.php b/src/Populator/Document/PageTitlePopulator.php
@@ -0,0 +1,25 @@
+<?php declare(strict_types=1);
+
+namespace Neusta\Pimcore\ImportExportBundle\Populator\Document;
+
+use Neusta\ConverterBundle\Converter\Context\GenericContext;
+use Neusta\ConverterBundle\Populator;
+use Pimcore\Model\Document as PimcoreDocument;
+
+/**
+ * @implements Populator<\ArrayObject<string, mixed>, PimcoreDocument, GenericContext|null>
+ */
+class PageTitlePopulator implements Populator
+{
+    /**
+     * @param \ArrayObject<string, mixed> $source
+     * @param PimcoreDocument             $target
+     * @param GenericContext|null         $ctx
+     */
+    public function populate(object $target, object $source, ?object $ctx = null): void
+    {
+        if ($target instanceof PimcoreDocument\Page && isset($source['title'])) {
+            $target->setTitle($source['title']);
+        }
+    }
+}
diff --git a/src/Populator/Document/PropertiesPopulator.php b/src/Populator/Document/PropertiesPopulator.php
@@ -1,25 +1,23 @@
 <?php declare(strict_types=1);
 
-namespace Neusta\Pimcore\ImportExportBundle\Populator;
+namespace Neusta\Pimcore\ImportExportBundle\Populator\Document;
 
 use Neusta\ConverterBundle\Converter\Context\GenericContext;
 use Neusta\ConverterBundle\Populator;
 use Neusta\Pimcore\ImportExportBundle\Toolbox\Repository\AssetRepository;
 use Neusta\Pimcore\ImportExportBundle\Toolbox\Repository\DataObjectRepository;
 use Neusta\Pimcore\ImportExportBundle\Toolbox\Repository\DocumentRepository;
 use Pimcore\Model\Document as PimcoreDocument;
-use Psr\Log\LoggerInterface;
 
 /**
  * @implements Populator<\ArrayObject<string, mixed>, PimcoreDocument, GenericContext|null>
  */
-class PageImportPopulator implements Populator
+class PropertiesPopulator implements Populator
 {
     public function __construct(
         private readonly AssetRepository $assetRepository,
         private readonly DataObjectRepository $objectRepository,
         private readonly DocumentRepository $documentRepository,
-        private readonly ?LoggerInterface $logger = null,
     ) {
     }
 
@@ -42,19 +40,5 @@ public function populate(object $target, object $source, ?object $ctx = null): v
             }
             $target->setProperty($property['key'], $property['type'], $value);
         }
-
-        if ($target instanceof PimcoreDocument\PageSnippet) {
-            /** @var array{type: string, data: mixed} $editable */
-            foreach ($source['editables'] ?? [] as $key => $editable) {
-                if (!isset($editable['data'])) {
-                    $this->logger?->warning('Skipping editable with missing required fields', [
-                        'key' => $key,
-                        'editable' => $editable,
-                    ]);
-                    continue; // Skip editables with missing required fields
-                }
-                $target->setRawEditable((string) $key, $editable['type'], $editable['data']);
-            }
-        }
     }
 }
diff --git a/tests/Integration/Export/ExporterTest.php b/tests/Integration/Export/ExporterTest.php
@@ -7,6 +7,7 @@
 use Pimcore\Model\Asset\Image;
 use Pimcore\Model\Document\Editable\Input;
 use Pimcore\Model\Document\Page;
+use Pimcore\Model\Document\Snippet;
 use Pimcore\Test\KernelTestCase;
 use Spatie\Snapshots\MatchesSnapshots;
 
@@ -48,6 +49,14 @@ public function test_single_image_export_with_ids(): void
         $this->assertMatchesSnapshot($yaml, new ImportExportYamlDriver());
     }
 
+    public function test_single_page_snippet_export(): void
+    {
+        $page = $this->createPageSnippetWithInputEditable();
+
+        $yaml = $this->exporter->export([$page], 'yaml');
+        $this->assertMatchesSnapshot($yaml, new ImportExportYamlDriver());
+    }
+
     public function test_single_page_export(): void
     {
         $page = $this->createPageWithInputEditable();
@@ -145,6 +154,27 @@ private function createPageWithInputEditable(): Page
         return $page;
     }
 
+    private function createPageSnippetWithInputEditable(): Snippet
+    {
+        $page = new Snippet();
+        $page->setId(999);
+        $page->setParentId(4);
+        $page->setType('snippet');
+        $page->setPublished(false);
+        $page->setPath('/test/');
+        $page->setKey('test_document_1');
+        $page->setProperty('language', 'string', 'en');
+        $page->setProperty('navigation_name', 'string', 'My Document');
+        $page->setProperty('navigation_title', 'string', 'My Document - Title');
+        $page->setController('/Some/Controller');
+        $inputEditable = new Input();
+        $inputEditable->setName('textInput');
+        $inputEditable->setDataFromResource('some text input');
+        $page->setEditables([$inputEditable]);
+
+        return $page;
+    }
+
     private function createSimplePage(string $index, int $parentId, string $path): Page
     {
         $page1 = new Page();
diff --git a/tests/Integration/Export/__snapshots__/ExporterTest__test_single_page_snippet_export__1.yaml b/tests/Integration/Export/__snapshots__/ExporterTest__test_single_page_snippet_export__1.yaml
@@ -0,0 +1,26 @@
+elements:
+    -
+        Pimcore\Model\Document\Snippet:
+            type: snippet
+            path: /test/
+            key: test_document_1
+            published: false
+            controller: /Some/Controller
+            editables:
+                -
+                    type: input
+                    name: textInput
+                    data: 'some text input'
+            properties:
+                language:
+                    key: language
+                    type: string
+                    value: en
+                navigation_name:
+                    key: navigation_name
+                    type: string
+                    value: 'My Document'
+                navigation_title:
+                    key: navigation_title
+                    type: string
+                    value: 'My Document - Title'
diff --git a/tests/Integration/Import/ImporterExporterTest.php b/tests/Integration/Import/ImporterExporterTest.php
@@ -7,6 +7,7 @@
 use Neusta\Pimcore\TestingFramework\Database\ResetDatabase;
 use Pimcore\Model\Asset;
 use Pimcore\Model\Document\Page;
+use Pimcore\Model\Document\Snippet;
 use Pimcore\Model\Version;
 use Pimcore\Test\KernelTestCase;
 use Prophecy\PhpUnit\ProphecyTrait;
@@ -51,4 +52,14 @@ public function testImportExport_regular_case(): void
 
         self::assertEquals($yamlToImport, $yamlExported);
     }
+
+    public function testImportExport_regular_case_page_snippet(): void
+    {
+        $yamlToImport = file_get_contents(__DIR__ . '/../data/Page Snippet.yaml');
+        $this->importer->import($yamlToImport, 'yaml', true, true);
+        $document = Snippet::getByPath('/footer');
+        $yamlExported = $this->exporter->export([$document], 'yaml');
+
+        self::assertEquals($yamlToImport, $yamlExported);
+    }
 }
diff --git a/tests/Integration/Import/ImporterTest.php b/tests/Integration/Import/ImporterTest.php
diff --git a/tests/Integration/data/Page Snippet.yaml b/tests/Integration/data/Page Snippet.yaml
diff --git a/tests/app/config/packages/pimcore.yaml b/tests/app/config/packages/pimcore.yaml
diff --git a/tests/app/config/services.yaml b/tests/app/config/services.yaml

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Neusta\Pimcore\ImportExportBundle\Model\Document;`
`4`	`4`
`5`		`-class Page extends PageSnippet`
	`5`	`+class Page extends Snippet`
`6`	`6`	`{`
`7`	`7`	`public ?string $title = null;`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace Neusta\Pimcore\ImportExportBundle\Model\Document;`
`4`	`4`
`5`		`-class PageSnippet extends Folder`
	`5`	`+class Snippet extends Folder`
`6`	`6`	`{`
`7`	`7`	`public ?string $controller = null;`
`8`	`8`	`/** @var array<Editable> */`