Add sort index field for documents

Author: lukmzig

config/pimcore/config.yaml

@@ -146,6 +146,8 @@ pimcore_generic_data_index:
           type: keyword
         href:
           type: keyword
+        index:
+          type: integer
       data_object:
         published:
           type: boolean

doc/01_Installation/02_Upgrade.md

@@ -2,6 +2,12 @@
 
 Following steps are necessary during updating to newer versions.
 
+## Upgrade to 2.1.0
+- Added support for Symfony 7
+- [Indexing] Added sort index for documents
+- Execute the following command to reindex all elements to be able to use all new features:
+  ```bin/console generic-data-index:update:index -r```
+
 ## Upgrade to 2.0.0
 - [Indexing] Added inherited fields indicator to data object indexing
 - [Indexing] Added functionality to enqueue dependent items

src/Model/Search/Document/SearchResult/DocumentSearchResultItem.php

@@ -28,6 +28,8 @@ class DocumentSearchResultItem implements ElementSearchResultItemInterface
 
     private string $key;
 
+    private int $index;
+
     private bool $published;
 
     private string $path;
@@ -109,6 +111,18 @@ public function setKey(string $key): DocumentSearchResultItem
         return $this;
     }
 
+    public function getIndex(): int
+    {
+        return $this->index;
+    }
+
+    public function setIndex(int $index): DocumentSearchResultItem
+    {
+        $this->index = $index;
+
+        return $this;
+    }
+
     public function isPublished(): bool
     {
         return $this->published;

src/Service/Serializer/Denormalizer/Search/DocumentSearchResultDenormalizer.php

@@ -54,6 +54,7 @@ public function denormalize(
             ->setParentId(SystemField::PARENT_ID->getData($data))
             ->setType(SystemField::TYPE->getData($data))
             ->setKey(SystemField::KEY->getData($data))
+            ->setIndex(SystemField::INDEX->getData($data))
             ->setPath(SystemField::PATH->getData($data))
             ->setPublished(SystemField::PUBLISHED->getData($data))
             ->setFullPath(SystemField::FULL_PATH->getData($data))

src/Service/Serializer/Normalizer/DocumentNormalizer.php

@@ -97,6 +97,7 @@ private function normalizeSystemFields(Document $document, bool $skipLazyLoadedF
             SystemField::PUBLISHED->value => $document->isPublished(),
             SystemField::TYPE->value => $document->getType(),
             SystemField::KEY->value => $document->getKey(),
+            SystemField::INDEX->value => $document->getIndex(),
             SystemField::PATH->value => $document->getPath(),
             SystemField::FULL_PATH->value => $document->getRealFullPath(),
             SystemField::USER_OWNER->value => $document->getUserOwner(),