Feature/import export multiple pages

README.md

@@ -3,18 +3,18 @@
 ## Installation
 
 1.  **Require the bundle**
-
+   
     ```shell
     composer require teamneusta/pimcore-import-export-bundle
     ```
 
-2. **Enable the bundle**
+2.  **Enable the bundle**
 
     Add the Bundle to your `config/bundles.php`:
 
-   ```php
-   Neusta\Pimcore\ImportExportBundle\NeustaPimcoreImportExportBundle::class => ['all' => true],
-   ```
+    ```php
+    Neusta\Pimcore\ImportExportBundle\NeustaPimcoreImportExportBundle::class => ['all' => true],
+    ```
 
 ## Usage
 
@@ -25,7 +25,9 @@ After enabling the bundle you should see a new menu item in the context menu of
 (german translation)
 
 ### Page Export
+
 The selected page will be exported into YAML format:
+
 ```yaml
 page:
     id: 123
@@ -43,7 +45,7 @@ page:
         main:
             type: areablock
             name: main
-            data: [{ key: '1', type: text-editor, hidden: false }]
+            data: [ { key: '1', type: text-editor, hidden: false } ]
 ...
 ```  
 
@@ -53,7 +55,23 @@ In the same way you can re-import your yaml file again by selecting: `Import fro
 
 ### Page Import
 
-The import process will create a new page with the given data.
+The import process will create pages with the given data.
+
+The following rule applies:
+
+If the parseYaml method of the `PageImporter` is not called with `forcedSave`, the data from the provided YAML will be
+adopted, regardless of whether it makes sense or not, and without checking whether the page could be saved that way.
+
+If `forcedSave` is set to `true`, the ID will be retained (Caution – this can overwrite an existing page).
+If a `parentId` is specified, the corresponding document will be searched for.
+If it exists, it will be set as the parent (Note: This may override the `path` specification).
+If the `parentId` does not exist, an attempt will be made to find a parent using the `path` specification.
+If such a parent exists, the `parentId` will be set accordingly and saved.
+
+If neither is found, an InvalidArgumentException will be thrown, and the save operation will be aborted.
+
+If multiple pages are imported and a path specification changes py the applied rules, this path specification will be
+replaced with the new, correct path specification in all provided page configurations.
 
 ## Contribution
 

compose.yaml

@@ -16,7 +16,7 @@ services:
       timeout: 10s
 
   php:
-    image: pimcore/pimcore:php8.3-latest
+    image: pimcore/pimcore:php8.3-debug-latest
     volumes:
       - ./:/var/www/html/
     environment:

composer.json

@@ -25,6 +25,7 @@
     "phpstan/phpstan-symfony": "^1.3.8",
     "phpunit/phpunit": "^9.5",
     "pimcore/admin-ui-classic-bundle": "^1.6",
+    "spatie/phpunit-snapshot-assertions": "^4.2",
     "teamneusta/pimcore-testing-framework": "^0.12"
   },
   "autoload": {

config/converters_populators.yaml

@@ -0,0 +1,63 @@
+services:
+  _defaults:
+    autowire: true
+    autoconfigure: true
+
+  ###########################################################
+  # Import Populator (YamlExportPage -> Page)
+  ###########################################################
+  Neusta\Pimcore\ImportExportBundle\Documents\Import\PageImportPopulator: ~
+
+  Neusta\Pimcore\ImportExportBundle\Documents\Import\PageImporter:
+    arguments:
+      $yamlToPageConverter: '@neusta_pimcore_import_export.import_page'
+
+  ###########################################################
+  # Export Converter (Document -> YamlExportPage)
+  ###########################################################
+  neusta_pimcore_import_export.export_document:
+      class: Neusta\Pimcore\ImportExportBundle\Documents\Export\Converter\DocumentTypeStrategyConverter
+      arguments:
+        $type2ConverterMap:
+          Pimcore\Model\Document\Page: '@neusta_pimcore_import_export.export_page'
+          Pimcore\Model\Document\Snippet: '@neusta_pimcore_import_export.export_page_snippet'
+          Pimcore\Model\Document\Folder: '@neusta_pimcore_import_export.export_folder'
+
+
+  ###########################################################
+  # Export Populator (Page -> YamlExportPage)
+  ###########################################################
+  neusta_pimcore_import_export.page.editables.populator:
+    class: Neusta\ConverterBundle\Populator\ArrayConvertingPopulator
+    arguments:
+      $converter: '@neusta_pimcore_import_export.editable_converter'
+      $sourceArrayPropertyName: 'editables'
+      $targetPropertyName: 'editables'
+
+  neusta_pimcore_import_export.page.property.language.populator:
+    class: Neusta\Pimcore\ImportExportBundle\PimcoreConverter\Populator\PropertyBasedMappingPopulator
+    arguments:
+      $propertyKey: 'language'
+      $targetProperty: 'language'
+      $skipNull: true
+
+  neusta_pimcore_import_export.page.property.navigation_title.populator:
+    class: Neusta\Pimcore\ImportExportBundle\PimcoreConverter\Populator\PropertyBasedMappingPopulator
+    arguments:
+      $propertyKey: 'navigation_title'
+      $targetProperty: 'navigation_title'
+      $skipNull: true
+
+  neusta_pimcore_import_export.page.property.navigation_name.populator:
+    class: Neusta\Pimcore\ImportExportBundle\PimcoreConverter\Populator\PropertyBasedMappingPopulator
+    arguments:
+      $propertyKey: 'navigation_name'
+      $targetProperty: 'navigation_name'
+      $skipNull: true
+
+  ###########################################################
+  # Export Populator (Editable -> YamlExportEditable)
+  ###########################################################
+  neusta_pimcore_import_export.editable.data.populator:
+    class: Neusta\Pimcore\ImportExportBundle\Documents\Export\Populator\EditableDataPopulator
+

config/pimcore/config.yaml

@@ -31,10 +31,28 @@ neusta_converter:
         path:
           source: path
           default: '/'
+          skip_null: true
         parentId:
           source: parentId
           default: 0
 
+    ###########################################################
+    # Export Converter (Folder -> YamlExportPage)
+    ###########################################################
+    neusta_pimcore_import_export.export_folder:
+      target: Neusta\Pimcore\ImportExportBundle\Documents\Export\YamlExportPage
+      populators:
+        - neusta_pimcore_import_export.page.property.language.populator
+        - neusta_pimcore_import_export.page.property.navigation_title.populator
+        - neusta_pimcore_import_export.page.property.navigation_name.populator
+      properties:
+        id: ~
+        key: ~
+        type: ~
+        published: ~
+        path: ~
+        parentId: ~
+
     ###########################################################
     # Export Converter (Page -> YamlExportPage)
     ###########################################################
@@ -55,9 +73,29 @@ neusta_converter:
         path: ~
         parentId: ~
 
+    ###########################################################
+    # Export Converter (Snippet -> YamlExportPage)
+    ###########################################################
+    neusta_pimcore_import_export.export_page_snippet:
+      target: Neusta\Pimcore\ImportExportBundle\Documents\Export\YamlExportPage
+      populators:
+        - neusta_pimcore_import_export.page.property.language.populator
+        - neusta_pimcore_import_export.page.property.navigation_title.populator
+        - neusta_pimcore_import_export.page.property.navigation_name.populator
+        - neusta_pimcore_import_export.page.editables.populator
+      properties:
+        id: ~
+        key: ~
+        controller: ~
+        type: ~
+        published: ~
+        path: ~
+        parentId: ~
+
     neusta_pimcore_import_export.editable_converter:
       target: Neusta\Pimcore\ImportExportBundle\Documents\Export\YamlExportEditable
+      populators:
+        - neusta_pimcore_import_export.editable.data.populator
       properties:
         type: ~
         name: ~
-        data: ~

config/services.yaml

@@ -1,3 +1,6 @@
+imports:
+  - { resource: 'converters_populators.yaml' }
+
 services:
   _defaults:
     autowire: true
@@ -6,9 +9,16 @@ services:
   Neusta\Pimcore\ImportExportBundle\Toolbox\:
     resource: '../src/Toolbox'
 
-  ###########################################################
-  # Controller
-  ###########################################################
+  ############
+  # Commands #
+  ############
+  Neusta\Pimcore\ImportExportBundle\Command\ExportAllPagesCommand:
+    public: true
+    tags: [ 'console.command' ]
+
+  ##############
+  # Controller #
+  ##############
   Neusta\Pimcore\ImportExportBundle\Controller\Admin\PageExportController:
     public: true
     tags: [ 'controller.service_arguments' ]
@@ -17,47 +27,16 @@ services:
     public: true
     tags: [ 'controller.service_arguments' ]
 
-  ###########################################################
-  # Import Populator (YamlExportPage -> Page)
-  ###########################################################
-  Neusta\Pimcore\ImportExportBundle\Documents\Import\PageImportPopulator: ~
-
-  Neusta\Pimcore\ImportExportBundle\Documents\Import\PageImporter:
-    arguments:
-      $yamlToPageConverter: '@neusta_pimcore_import_export.import_page'
-
-  ###########################################################
-  # Export Populator (Page -> YamlExportPage)
-  ###########################################################
-  neusta_pimcore_import_export.page.editables.populator:
-    class: Neusta\ConverterBundle\Populator\ArrayConvertingPopulator
-    arguments:
-      $converter: '@neusta_pimcore_import_export.editable_converter'
-      $sourceArrayPropertyName: 'editables'
-      $targetPropertyName: 'editables'
-
-  neusta_pimcore_import_export.page.property.language.populator:
-    class: Neusta\Pimcore\ImportExportBundle\PimcoreConverter\Populator\PropertyBasedMappingPopulator
-    arguments:
-      $propertyKey: 'language'
-      $targetProperty: 'language'
-
-  neusta_pimcore_import_export.page.property.navigation_title.populator:
-    class: Neusta\Pimcore\ImportExportBundle\PimcoreConverter\Populator\PropertyBasedMappingPopulator
-    arguments:
-      $propertyKey: 'navigation_title'
-      $targetProperty: 'navigation_title'
-
-  neusta_pimcore_import_export.page.property.navigation_name.populator:
-    class: Neusta\Pimcore\ImportExportBundle\PimcoreConverter\Populator\PropertyBasedMappingPopulator
-    arguments:
-      $propertyKey: 'navigation_name'
-      $targetProperty: 'navigation_name'
-
+  #############
+  # Documents #
+  #############
   Neusta\Pimcore\ImportExportBundle\Documents\Export\PageExporter:
     arguments:
-      $pageToYamlConverter: '@neusta_pimcore_import_export.export_page'
+      $pageToYamlConverter: '@neusta_pimcore_import_export.export_document'
 
+  #################
+  # EventListener #
+  #################
   Neusta\Pimcore\ImportExportBundle\EventListener\PimcoreAdminListener:
     tags:
       - { name: kernel.event_listener, event: pimcore.bundle_manager.paths.js, method: addJSFiles }

public/js/exportPage.js

@@ -8,6 +8,7 @@ neusta_pimcore_import_export.plugin.page.export = Class.create({
     onPrepareDocumentTreeContextMenu: function (e) {
         let menu = e.detail.menu;
         let document = e.detail.document;
+
         // Export page into yaml file
         menu.add("-");
         menu.add(new Ext.menu.Item({
@@ -17,6 +18,15 @@ neusta_pimcore_import_export.plugin.page.export = Class.create({
                 pimcore.helpers.download(Routing.generate('neusta_pimcore_import_export_page_export', {page_id: document.data.id}));
             }
         }));
+
+        // Export page and children into yaml file
+        menu.add(new Ext.menu.Item({
+            text: t('neusta_pimcore_import_export_export_with_children_menu_label'),
+            iconCls: "pimcore_icon_export",
+            handler: function () {
+                pimcore.helpers.download(Routing.generate('neusta_pimcore_import_export_page_export_with_children', {page_id: document.data.id}));
+            }
+        }));
     },
 
 });