Enhancements for query parameters (#311)

apigee · Oct 16, 2023 · fe7267d · fe7267d
1 parent d9b6ec1
commit fe7267d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/src/Api/ApigeeX/Controller/PaginatedEntityListingControllerInterface.php b/src/Api/ApigeeX/Controller/PaginatedEntityListingControllerInterface.php
@@ -43,8 +43,11 @@ interface PaginatedEntityListingControllerInterface extends PaginatedEntityContr
      *   Pager.
      * @param string $key_provider
      *   Getter method on the entity that should provide a unique array key.
+     * @param array $queryparams
+     *   Query parameters passed to the generator as $options['query']. This may
+     *   be modified if there are extra parameters not used as route variables.
      *
      * @return \Apigee\Edge\Entity\EntityInterface[]
      */
-    public function getEntities(PagerInterface $pager = null, string $key_provider = 'id'): array;
+    public function getEntities(PagerInterface $pager = null, string $key_provider = 'id', $queryparams = []): array;
 }
diff --git a/src/Api/ApigeeX/Controller/PaginatedEntityListingControllerTrait.php b/src/Api/ApigeeX/Controller/PaginatedEntityListingControllerTrait.php
@@ -32,9 +32,9 @@ trait PaginatedEntityListingControllerTrait
      *
      * @return \Apigee\Edge\Entity\EntityInterface[]
      */
-    public function getEntities(PagerInterface $pager = null, string $key_provider = 'id'): array
+    public function getEntities(PagerInterface $pager = null, string $key_provider = 'id', $queryparams = []): array
     {
-        return $this->listEntities($pager, [], $key_provider);
+        return $this->listEntities($pager, $queryparams, $key_provider);
     }
 
     /**