src/Event/PaginationHeadersListener.php line 24

Open in your IDE?
  1. <?php
  2. namespace App\Event;
  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 $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 = (int) $data->getCurrentPage();
  32.         $response->headers->set('Pagination-Current-Page'$currentPage);
  33.         $response->headers->set('Pagination-Items-Per-Page', (int) $data->getItemsPerPage());
  34.         if (!$data instanceof PaginatorInterface) {
  35.             return;
  36.         }
  37.         $response->headers->set('X-Total-Count'$data->getTotalItems());
  38.         $lastPage = (int) $data->getLastPage();
  39.         $response->headers->set('Pagination-Last-Page'$lastPage);
  40.         $response->headers->set('Pagination-Total-Items', (int) $data->getTotalItems());
  41.         $linkProvider $request->attributes->get('_links', new GenericLinkProvider());
  42.         foreach ($this->collectLinks($request$currentPage$lastPage) as $rel => $url) {
  43.             $linkProvider $linkProvider->withLink(new Link($rel$url));
  44.         }
  45.         $request->attributes->set('_links'$linkProvider);
  46.     }
  47.     public static function getSubscribedEvents(): array
  48.     {
  49.         return [
  50.             KernelEvents::RESPONSE => ['onKernelResponse'],
  51.         ];
  52.     }
  53.     private function collectLinks(Request $requestint $currentPageint $lastPage): array
  54.     {
  55.         $links = [];
  56.         $parsed IriHelper::parseIri($request->getUri(), $this->paginationParameterName);
  57.         $links['first'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->paginationParameterName1);
  58.         $links['last'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->paginationParameterName$lastPage);
  59.         if (!== $currentPage) {
  60.             $links['prev'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->paginationParameterName$currentPage 1);
  61.         }
  62.         if ($currentPage !== $lastPage) {
  63.             $links['next'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->paginationParameterName$currentPage 1);
  64.         }
  65.         return $links;
  66.     }
  67. }