Improve pagination support in API (#5073)

src/API/BaseApiController.php

@@ -13,6 +13,7 @@ use App\Entity\User;
 use App\Repository\Query\BaseQuery;
 use App\Timesheet\DateTimeFactory;
 use App\Utils\Pagination;
+use FOS\RestBundle\Request\ParamFetcherInterface;
 use FOS\RestBundle\View\View;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\Form\Extension\Core\Type\DateTimeType;
@@ -52,6 +53,46 @@ abstract class BaseApiController extends AbstractController
         return DateTimeFactory::createByUser($user);
     }
 
+    protected function prepareQuery(BaseQuery $query, ParamFetcherInterface $paramFetcher): void
+    {
+        $query->setIsApiCall(true);
+        $query->setCurrentUser($this->getUser());
+
+        // there is no function has() in ParamFetcherInterface, so we need to use all() and check for the key
+        $all = $paramFetcher->all(true);
+
+        if (\array_key_exists('page', $all)) {
+            $page = $all['page'];
+            if (is_numeric($page)) {
+                $query->setPage((int) $page);
+            }
+        }
+
+        if (\array_key_exists('size', $all)) {
+            $size = $all['size'];
+            if (is_numeric($size)) {
+                $query->setPageSize((int) $size);
+            }
+        }
+
+        if (\array_key_exists('pageSize', $all)) {
+            $size = $all['pageSize'];
+            if (is_numeric($size)) {
+                $query->setPageSize((int) $size);
+            }
+        }
+    }
+
+    protected function createPaginatedView(Pagination $pagination): View
+    {
+        $results = (array) $pagination->getCurrentPageResults();
+
+        $view = new View($results, 200);
+        $this->addPagination($view, $pagination);
+
+        return $view;
+    }
+
     protected function addPagination(View $view, Pagination $pagination): void
     {
         $view->setHeader('X-Page', (string) $pagination->getCurrentPage());