add new document adapter interface (#1498)

Author: lukmzig

doc/10_Extending_Studio/03_Documents/01_Document_types.md

@@ -226,10 +226,11 @@ Important interfaces:
 - `Pimcore\Bundle\StudioBackendBundle\Document\Data\SetterDataInterface` - The mandatory interface that must be implemented by the adapter.
 - `Pimcore\Bundle\StudioBackendBundle\Document\Data\EditableDataNormalizerInterface` - The interface that needs to be implemented if the adapter should be able to normalize editable data.
 - `Pimcore\Bundle\StudioBackendBundle\Document\Data\SettingsNormalizerInterface` - The interface that needs to be implemented if the adapter should be able to normalize document settings data.
+- `Pimcore\Bundle\StudioBackendBundle\Document\Data\SetInitialDataInterface` - Marker interface that needs to be implemented by the adapter if it there is a need to adapt this initial data on document creation.
 - `Pimcore\Bundle\StudioBackendBundle\Document\Data\Model\EditableDataInterface` - Marker interface that needs to be implemented by custom editable data model. This interface is returned by the `normalizeEditableData` method of the `EditableNormalizerInterface`.
 - `Pimcore\Bundle\StudioBackendBundle\Document\Data\Model\SettingsDataInterface` - Marker interface that needs to be implemented by custom settings data model. This interface is returned by the `normalizeSettings` method of the `SettingsNormalizerInterface`.
 
-Important data keys:
+- Important data keys:
 - `editableData` - The key for the detail data of the document (e.g., editable fields of your document).
 - `settingsData` - The key for the document settings data (e.g., document settings like title, description, prettyUrl).
 

src/Document/Data/SetInitialDataInterface.php

@@ -0,0 +1,22 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * This source file is available under the terms of the
+ * Pimcore Open Core License (POCL)
+ * Full copyright and license information is available in
+ * LICENSE.md which is distributed with this source code.
+ *
+ *  @copyright  Copyright (c) Pimcore GmbH (https://www.pimcore.com)
+ *  @license    Pimcore Open Core License (POCL)
+ */
+
+namespace Pimcore\Bundle\StudioBackendBundle\Document\Data;
+
+use Pimcore\Model\Document;
+use Pimcore\Model\UserInterface;
+
+interface SetInitialDataInterface
+{
+    public function setInitialData(Document $document, array $data, UserInterface $user): void;
+}

src/Document/Service/CreateService.php

@@ -17,6 +17,7 @@
 use Pimcore\Bundle\StaticResolverBundle\Models\Document\DocTypeResolverInterface;
 use Pimcore\Bundle\StaticResolverBundle\Models\Document\DocumentResolverInterface;
 use Pimcore\Bundle\StaticResolverBundle\Models\Element\ServiceResolverInterface;
+use Pimcore\Bundle\StudioBackendBundle\Document\Data\SetInitialDataInterface;
 use Pimcore\Bundle\StudioBackendBundle\Document\Schema\DocumentAddParameters;
 use Pimcore\Bundle\StudioBackendBundle\Document\Util\Trait\DocumentClassTrait;
 use Pimcore\Bundle\StudioBackendBundle\Element\Service\ElementSaveServiceInterface;
@@ -47,6 +48,7 @@
     public function __construct(
         private DocumentResolverInterface $documentResolver,
         private DocTypeResolverInterface $docTypeResolver,
+        private DocumentTypeServiceInterface $documentTypeService,
         private ElementSaveServiceInterface $elementSaveService,
         private ResolverInterface $classResolver,
         private ServiceResolverInterface $serviceResolver,
@@ -72,6 +74,11 @@ public function createDocument(Document $parent, DocumentAddParameters $paramete
             $this->addLanguageProperty($document, $baseTranslationDocument, $parameters->getLanguage());
         }
 
+        $adapter = $this->documentTypeService->tryTypeAdapter($document->getType());
+        if ($adapter instanceof SetInitialDataInterface) {
+            $adapter->setInitialData($document, $data, $user);
+        }
+
         try {
             $this->elementSaveService->save($document, $user);
         } catch (Exception $e) {