Fixed issue #QE-769: REST API survey list pagination (#3722)

LimeSurvey · Feb 5, 2024 · 05c0ce6 · 05c0ce6
1 parent 16225b5
commit 05c0ce6
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/application/libraries/Api/Command/V1/SurveyList.php b/application/libraries/Api/Command/V1/SurveyList.php
@@ -62,7 +62,11 @@ public function run(Request $request)
 
         $dataProvider = $this->survey
             ->with('defaultlanguage')
-            ->search();
+            ->search([
+                'pageSize' => $request->getData('pageSize'),
+                // Yii pagination is zero based - so we must add 1
+                'currentPage' => $request->getData('page') + 1,
+            ]);
 
         $data = $this->transformerOutputSurvey
             ->transformAll($dataProvider->getData());

diff --git a/application/models/Survey.php b/application/models/Survey.php
@@ -1508,15 +1508,26 @@ public function getButtons(): string
     }
 
     /**
+     * Search
+     *
+     * $options = [
+     *  'pageSize' => 10,
+     *  'currentPage' => 1
+     * ];
+     *
+     * @param array $options
      * @return CActiveDataProvider
      */
-    public function search()
+    public function search($options = [])
     {
+        $options = $options ?? [];
         // Flush cache to get proper counts for partial/complete/total responses
         if (method_exists(Yii::app()->cache, 'flush')) {
             Yii::app()->cache->flush();
         }
-        $pageSize = Yii::app()->user->getState('pageSize', Yii::app()->params['defaultPageSize']);
+        $pageSizeUser = Yii::app()->user->getState('pageSize', Yii::app()->params['defaultPageSize']);
+        $pageSize = $options['pageSize'] ?? $pageSizeUser;
+        $currentPage = $options['currentPage'] ?? null;
 
         $sort = new CSort();
         $sort->attributes = array(
@@ -1644,6 +1655,7 @@ public function search()
             'criteria' => $criteria,
             'pagination' => array(
                 'pageSize' => $pageSize,
+                'currentPage' => $currentPage
             ),
         ));