[Data Objects] Inherited fields

src/Enum/SearchIndex/FieldCategory.php

@@ -24,4 +24,5 @@ enum FieldCategory: string
     case SYSTEM_FIELDS = 'system_fields';
     case STANDARD_FIELDS = 'standard_fields';
     case CUSTOM_FIELDS = 'custom_fields';
+    case INHERITED_FIELDS = '_inherited_fields';
 }

src/Enum/SearchIndex/FieldCategory/StandardField.php

@@ -0,0 +1,29 @@
+<?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\GenericDataIndexBundle\Enum\SearchIndex\FieldCategory;
+
+use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\FieldCategory\SystemField\SystemFieldTrait;
+
+/**
+ * @internal
+ */
+enum StandardField: string
+{
+    use SystemFieldTrait;
+
+    case LOCALIZED_FIELDS = 'localizedfields';
+}

src/Enum/SearchIndex/FieldCategory/SystemField.php

@@ -16,14 +16,14 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\FieldCategory;
 
-use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\FieldCategory;
+use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\FieldCategory\SystemField\SystemFieldTrait;
 
 /**
  * @internal
  */
 enum SystemField: string
 {
-    use FieldCategory\SystemField\SystemFieldTrait;
+    use SystemFieldTrait;
 
     case ID = 'id';
     case ELEMENT_TYPE = 'elementType';

src/Model/Search/DataObject/SearchResult/DataObjectSearchResultItem.php

@@ -17,6 +17,7 @@
 namespace Pimcore\Bundle\GenericDataIndexBundle\Model\Search\DataObject\SearchResult;
 
 use Pimcore\Bundle\GenericDataIndexBundle\Enum\SearchIndex\ElementType;
+use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\DataObject\SearchResult\SearchResultItem\InheritedData;
 use Pimcore\Bundle\GenericDataIndexBundle\Model\Search\Interfaces\ElementSearchResultItemInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Permission\DataObjectPermissions;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\Search\SearchResultItem\LazyLoading\DataObjectLazyLoadingHandlerInterface;
@@ -63,6 +64,8 @@ class DataObjectSearchResultItem implements ElementSearchResultItemInterface
 
     private DataObjectPermissions $permissions;
 
+    private array $inheritedFields = [];
+
     private DataObjectLazyLoadingHandlerInterface $lazyLoadingHandler;
 
     public function getElementType(): ElementType
@@ -322,6 +325,24 @@ public function setPermissions(DataObjectPermissions $permissions): DataObjectSe
         return $this;
     }
 
+    /**
+     * @return InheritedData[]
+     */
+    public function getInheritedFields(): array
+    {
+        return $this->inheritedFields;
+    }
+
+    /**
+     * @param InheritedData[] $inheritedFields
+     */
+    public function setInheritedFields(array $inheritedFields): DataObjectSearchResultItem
+    {
+        $this->inheritedFields = $inheritedFields;
+
+        return $this;
+    }
+
     public function withLazyLoadingHandler(
         ?DataObjectLazyLoadingHandlerInterface $lazyLoadingHandler
     ): DataObjectSearchResultItem {

src/Model/Search/DataObject/SearchResult/SearchResultItem/InheritedData.php

@@ -0,0 +1,37 @@
+<?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\GenericDataIndexBundle\Model\Search\DataObject\SearchResult\SearchResultItem;
+
+final readonly class InheritedData
+{
+    public function __construct(
+        private string $key,
+        private int $originId
+    ) {
+
+    }
+
+    public function getKey(): string
+    {
+        return $this->key;
+    }
+
+    public function getOriginId(): int
+    {
+        return $this->originId;
+    }
+}

src/SearchIndexAdapter/DataObject/AdapterInterface.php

@@ -16,7 +16,9 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\DataObject;
 
+use Exception;
 use Pimcore\Model\DataObject\ClassDefinition\Data;
+use Pimcore\Model\DataObject\Concrete;
 
 /**
  * @internal
@@ -35,4 +37,16 @@ public function getIndexAttributeName(): string;
      * Used to normalize the data for the search index
      */
     public function normalize(mixed $value): mixed;
+
+    /**
+     * @throws Exception
+     */
+    public function getInheritedData(
+        Concrete $dataObject,
+        int $objectId,
+        mixed $value,
+        string $key,
+        ?string $language = null,
+        callable $callback = null
+    ): array;
 }

src/SearchIndexAdapter/DataObject/FieldDefinitionServiceInterface.php

@@ -16,7 +16,10 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\DataObject;
 
+use Exception;
 use Pimcore\Model\DataObject\ClassDefinition;
+use Pimcore\Model\DataObject\ClassDefinition\Data;
+use Pimcore\Model\DataObject\Concrete;
 
 /**
  * @internal
@@ -26,4 +29,14 @@ interface FieldDefinitionServiceInterface
     public function getFieldDefinitionAdapter(ClassDefinition\Data $fieldDefinition): ?AdapterInterface;
 
     public function normalizeValue(?ClassDefinition\Data $fieldDefinition, mixed $value): mixed;
+
+    /**
+     * @throws Exception
+     */
+    public function getInheritedFieldData(
+        ?Data $fieldDefinition,
+        Concrete $dataObject,
+        string $key,
+        mixed $value
+    ): array;
 }

src/SearchIndexAdapter/OpenSearch/DataObject/FieldDefinitionAdapter/AbstractAdapter.php

@@ -16,10 +16,12 @@
 
 namespace Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\OpenSearch\DataObject\FieldDefinitionAdapter;
 
+use Exception;
 use Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\DataObject\AdapterInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\SearchIndexAdapter\DataObject\FieldDefinitionServiceInterface;
 use Pimcore\Bundle\GenericDataIndexBundle\Service\SearchIndex\SearchIndexConfigServiceInterface;
 use Pimcore\Model\DataObject\ClassDefinition\Data;
+use Pimcore\Model\DataObject\Concrete;
 use Pimcore\Normalizer\NormalizerInterface;
 
 abstract class AbstractAdapter implements AdapterInterface
@@ -64,4 +66,37 @@ public function normalize(mixed $value): mixed
 
         return $value;
     }
+
+    /**
+     * @throws Exception
+     */
+    public function getInheritedData(
+        Concrete $dataObject,
+        int $objectId,
+        mixed $value,
+        string $key,
+        ?string $language = null,
+        callable $callback = null
+    ): array {
+        if (!$this->fieldDefinition->isEmpty($value)) {
+            return [];
+        }
+
+        $path = $key;
+        if ($language !== null) {
+            $path .= '.' . $language;
+        }
+
+        $parent = $dataObject->getNextParentForInheritance();
+        if ($parent === null) {
+            return $objectId === $dataObject->getId() ? [] : [$path => ['originId' => $dataObject->getId()]];
+        }
+
+        $parentValue = $callback ? $callback($parent, $key, $language) : $parent->get($key, $language);
+        if (!$this->fieldDefinition->isEmpty($parentValue)) {
+            return [$path => ['originId' => $parent->getId()]];
+        }
+
+        return $this->getInheritedData($parent, $objectId, $value, $key, $language, $callback);
+    }
 }