src/EventSubscriber/PaginationHeadersSubscriber.php line 22

  1. <?php
  3. namespace App\EventSubscriber;
  5. use ApiPlatform\State\Pagination\PaginatorInterface;
  6. use ApiPlatform\State\Pagination\PartialPaginatorInterface;
  7. use ApiPlatform\Util\IriHelper;
  8. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  9. use Symfony\Component\HttpFoundation\Request;
  10. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  11. use Symfony\Component\HttpKernel\HttpKernelInterface;
  12. use Symfony\Component\HttpKernel\KernelEvents;
  13. use Symfony\Component\WebLink\GenericLinkProvider;
  14. use Symfony\Component\WebLink\Link;
  16. class PaginationHeadersSubscriber implements EventSubscriberInterface
  17. {
  18.     public function __construct(private readonly string $paginationParameterName = 'page')
  19.     {
  20.     }
  22.     public function onKernelResponse(ResponseEvent $event): void
  23.     {
  24.         if (HttpKernelInterface::MAIN_REQUEST !== $event->getRequestType()) {
  25.             return;
  26.         }
  28.         $request = $event->getRequest();
  29.         $response = $event->getResponse();
  30.         $data = $request->attributes->get('data');
  32.         if (!$data instanceof PartialPaginatorInterface) {
  33.             return;
  34.         }
  36.         $currentPage = (string) $data->getCurrentPage();
  38.         $response->headers->set('Pagination-Current-Page', $currentPage);
  39.         $response->headers->set('Pagination-Items-Per-Page', (string) $data->getItemsPerPage());
  41.         if (!$data instanceof PaginatorInterface) {
  42.             return;
  43.         }
  45.         $lastPage = (string) $data->getLastPage();
  47.         $response->headers->set('Pagination-Last-Page', $lastPage);
  48.         $response->headers->set('Pagination-Total-Items', (string) $data->getTotalItems());
  50.         $linkProvider = $request->attributes->get('_links', new GenericLinkProvider());
  52.         foreach ($this->collectLinks($request, (int) $currentPage, (int) $lastPage) as $rel => $url) {
  53.             $linkProvider = $linkProvider->withLink(new Link($rel, $url));
  54.         }
  56.         $request->attributes->set('_links', $linkProvider);
  57.     }
  59.     public static function getSubscribedEvents(): array
  60.     {
  61.         return [
  62.             KernelEvents::RESPONSE => ['onKernelResponse'],
  63.         ];
  64.     }
  66.     /**
  67.      * @return array<string>
  68.      */
  69.     private function collectLinks(Request $request, int $currentPage, int $lastPage): array
  70.     {
  71.         $links = [];
  72.         $parsed = IriHelper::parseIri($request->getUri(), $this->paginationParameterName);
  74.         $links['first'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->paginationParameterName, 1);
  75.         $links['last'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->paginationParameterName, $lastPage);
  77.         if (1 !== $currentPage) {
  78.             $links['prev'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->paginationParameterName, (float) $currentPage - 1);
  79.         }
  81.         if ($currentPage !== $lastPage) {
  82.             $links['next'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->paginationParameterName, $currentPage + 1);
  83.         }
  85.         return $links;
  86.     }
  87. }