src/EventSubscriber/PaginationHeadersListener.php line 25

Open in your IDE?
  1. <?php
  2. namespace App\EventSubscriber;
  3. use ApiPlatform\Core\DataProvider\PaginatorInterface;
  4. use ApiPlatform\Core\DataProvider\PartialPaginatorInterface;
  5. use ApiPlatform\Core\Util\IriHelper;
  6. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  7. use Symfony\Component\HttpFoundation\Request;
  8. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  9. use Symfony\Component\HttpKernel\HttpKernelInterface;
  10. use Symfony\Component\HttpKernel\KernelEvents;
  11. use Symfony\Component\WebLink\GenericLinkProvider;
  12. use Symfony\Component\WebLink\Link;
  13. class PaginationHeadersListener implements EventSubscriberInterface
  14. {
  15.     private string $paginationParameterName;
  16.     public function __construct(string $paginationParameterName 'page')
  17.     {
  18.         $this->paginationParameterName $paginationParameterName;
  19.     }
  20.     public function onKernelResponse(ResponseEvent $event): void
  21.     {
  22.         if (HttpKernelInterface::MAIN_REQUEST !== $event->getRequestType()) {
  23.             return;
  24.         }
  25.         $request $event->getRequest();
  26.         $response $event->getResponse();
  27.         $data $request->attributes->get('data');
  28.         if (!$data instanceof PartialPaginatorInterface) {
  29.             return;
  30.         }
  31.         $currentPage = (string) $data->getCurrentPage();
  32.         $response->headers->set('Pagination-Current-Page'$currentPage);
  33.         $response->headers->set('Pagination-Items-Per-Page', (string) $data->getItemsPerPage());
  34.         if (!$data instanceof PaginatorInterface) {
  35.             return;
  36.         }
  37.         $lastPage = (string) $data->getLastPage();
  38.         $response->headers->set('Pagination-Last-Page'$lastPage);
  39.         $response->headers->set('Pagination-Total-Items', (string) $data->getTotalItems());
  40.         $linkProvider $request->attributes->get('_links', new GenericLinkProvider());
  41.         foreach ($this->collectLinks($request, (int) $currentPage, (int) $lastPage) as $rel => $url) {
  42.             $linkProvider $linkProvider->withLink(new Link($rel$url));
  43.         }
  44.         $request->attributes->set('_links'$linkProvider);
  45.     }
  46.     public static function getSubscribedEvents(): array
  47.     {
  48.         return [
  49.             KernelEvents::RESPONSE => ['onKernelResponse'],
  50.         ];
  51.     }
  52.     /**
  53.      * @return array<string>
  54.      */
  55.     private function collectLinks(Request $requestint $currentPageint $lastPage): array
  56.     {
  57.         $links = [];
  58.         $parsed IriHelper::parseIri($request->getUri(), $this->paginationParameterName);
  59.         $links['first'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->paginationParameterName1);
  60.         $links['last'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->paginationParameterName$lastPage);
  61.         if (!== $currentPage) {
  62.             $links['prev'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->paginationParameterName, (float) $currentPage 1);
  63.         }
  64.         if ($currentPage !== $lastPage) {
  65.             $links['next'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->paginationParameterName$currentPage 1);
  66.         }
  67.         return $links;
  68.     }
  69. }