Add groupByFields to DoctrineListRepresentationFactory (#11)

handcraftedinthealps · Nov 7, 2022 · 15506a9 · 15506a9
1 parent 47c716f
commit 15506a9
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 12 deletions.
diff --git a/ListRepresentation/DoctrineListRepresentationFactory.php b/ListRepresentation/DoctrineListRepresentationFactory.php
@@ -46,15 +46,17 @@ public function __construct(
     }
 
     /**
-     * @param mixed[] $filters
-     * @param mixed[] $parameters
+     * @param array<string, mixed> $filters
+     * @param array<string, mixed> $parameters
      * @param string[] $includedFields
+     * @param string[] $groupByFields
      */
     public function createDoctrineListRepresentation(
         string $resourceKey,
         array $filters = [],
         array $parameters = [],
-        array $includedFields = []
+        array $includedFields = [],
+        array $groupByFields = []
     ): PaginatedRepresentation {
         /** @var DoctrineFieldDescriptor[] $fieldDescriptors */
         $fieldDescriptors = $this->fieldDescriptorFactory->getFieldDescriptors($resourceKey);
@@ -74,6 +76,10 @@ public function createDoctrineListRepresentation(
             $listBuilder->addSelectField($fieldDescriptors[$field]);
         }
 
+        foreach ($groupByFields as $field) {
+            $listBuilder->addGroupBy($fieldDescriptors[$field]);
+        }
+
         $items = $listBuilder->execute();
 
         // sort the items to reflect the order of the given ids if the list was requested to include specific ids

diff --git a/ListRepresentation/DoctrineListRepresentationFactoryInterface.php b/ListRepresentation/DoctrineListRepresentationFactoryInterface.php
@@ -9,14 +9,16 @@
 interface DoctrineListRepresentationFactoryInterface
 {
     /**
-     * @param mixed[] $filters
-     * @param mixed[] $parameters
+     * @param array<string, mixed> $filters
+     * @param array<string, mixed> $parameters
      * @param string[] $includedFields
+     * @param string[] $groupByFields
      */
     public function createDoctrineListRepresentation(
         string $resourceKey,
         array $filters = [],
         array $parameters = [],
-        array $includedFields = []
+        array $includedFields = [],
+        array $groupByFields = []
     ): PaginatedRepresentation;
 }
diff --git a/ListRepresentation/DoctrineNestedListRepresentationFactory.php b/ListRepresentation/DoctrineNestedListRepresentationFactory.php
@@ -47,17 +47,21 @@ public function __construct(
     }
 
     /**
-     * @param mixed[] $filters
-     * @param mixed[] $parameters
+     * @param array<string, mixed> $filters
+     * @param array<string, mixed> $parameters
      * @param int|string|null $parentId
      * @param int[]|string[] $expandedIds
+     * @param string[] $includedFields
+     * @param string[] $groupByFields
      */
     public function createDoctrineListRepresentation(
         string $resourceKey,
         array $filters = [],
         array $parameters = [],
         $parentId = null,
-        array $expandedIds = []
+        array $expandedIds = [],
+        array $includedFields = [],
+        array $groupByFields = []
     ): CollectionRepresentation {
         /** @var DoctrineFieldDescriptor[] $fieldDescriptors */
         $fieldDescriptors = $this->fieldDescriptorFactory->getFieldDescriptors($resourceKey);
@@ -72,6 +76,14 @@ public function createDoctrineListRepresentation(
             $listBuilder->where($fieldDescriptors[$key], $value);
         }
 
+        foreach ($includedFields as $field) {
+            $listBuilder->addSelectField($fieldDescriptors[$field]);
+        }
+
+        foreach ($groupByFields as $field) {
+            $listBuilder->addGroupBy($fieldDescriptors[$field]);
+        }
+
         // disable pagination to simplify tree handling and select tree related properties that are used below
         $listBuilder->limit(\PHP_INT_MAX);
         $listBuilder->addSelectField($fieldDescriptors['lft']);

diff --git a/ListRepresentation/DoctrineNestedListRepresentationFactoryInterface.php b/ListRepresentation/DoctrineNestedListRepresentationFactoryInterface.php
@@ -9,16 +9,20 @@
 interface DoctrineNestedListRepresentationFactoryInterface
 {
     /**
-     * @param mixed[] $filters
-     * @param mixed[] $parameters
+     * @param array<string, mixed> $filters
+     * @param array<string, mixed> $parameters
      * @param int|string|null $parentId
      * @param int[]|string[] $expandedIds
+     * @param string[] $includedFields
+     * @param string[] $groupByFields
      */
     public function createDoctrineListRepresentation(
         string $resourceKey,
         array $filters = [],
         array $parameters = [],
         $parentId = null,
-        array $expandedIds = []
+        array $expandedIds = [],
+        array $includedFields = [],
+        array $groupByFields = []
     ): CollectionRepresentation;
 }