vendor/friendsofsymfony/elastica-bundle/src/Subscriber/PaginateElasticaQuerySubscriber.php line 33

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the FOSElasticaBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <https://friendsofsymfony.github.com/>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace FOS\ElasticaBundle\Subscriber;
  14. use FOS\ElasticaBundle\Paginator\PaginatorAdapterInterface;
  15. use FOS\ElasticaBundle\Paginator\PartialResultsInterface;
  16. use Knp\Component\Pager\Event\ItemsEvent;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. use Symfony\Component\HttpFoundation\Request;
  19. use Symfony\Component\HttpFoundation\RequestStack;
  21. class PaginateElasticaQuerySubscriber implements EventSubscriberInterface
  22. {
  23.     private RequestStack $requestStack;
  25.     public function __construct(RequestStack $requestStack)
  26.     {
  27.         $this->requestStack = $requestStack;
  28.     }
  30.     /**
  31.      * @return void
  32.      */
  33.     public function items(ItemsEvent $event)
  34.     {
  35.         if ($event->target instanceof PaginatorAdapterInterface) {
  36.             // Add sort to query
  37.             $this->setSorting($event);
  39.             /** @var PartialResultsInterface $results */
  40.             $results = $event->target->getResults($event->getOffset(), $event->getLimit());
  42.             $event->count = $results->getTotalHits();
  43.             $event->items = $results->toArray();
  44.             $aggregations = $results->getAggregations();
  45.             if (null != $aggregations) {
  46.                 $event->setCustomPaginationParameter('aggregations', $aggregations);
  47.             }
  49.             $event->stopPropagation();
  50.         }
  51.     }
  53.     public static function getSubscribedEvents(): array
  54.     {
  55.         return [
  56.             'knp_pager.items' => ['items', 1],
  57.         ];
  58.     }
  60.     /**
  61.      * Adds knp paging sort to query.
  62.      *
  63.      * @return void
  64.      */
  65.     protected function setSorting(ItemsEvent $event)
  66.     {
  67.         // Bugfix for PHP 7.4 as options can be null and generate a "Trying to access array offset on value of type null" error
  68.         // @phpstan-ignore-next-line
  69.         $options = $event->options ?? [];
  70.         $sortField = $this->getFromRequest($options['sortFieldParameterName'] ?? null);
  72.         if (!$sortField && isset($options['defaultSortFieldName'])) {
  73.             $sortField = $options['defaultSortFieldName'];
  74.         }
  76.         if (!empty($sortField)) {
  77.             $event->target->getQuery()->setSort([
  78.                 $sortField => $this->getSort($sortField, $options),
  79.             ]);
  80.         }
  81.     }
  83.     /**
  84.      * @param string               $sortField
  85.      * @param array<string, mixed> $options
  86.      *
  87.      * @return array<string, mixed>
  88.      */
  89.     protected function getSort($sortField, array $options = [])
  90.     {
  91.         $sort = [
  92.             'order' => $this->getSortDirection($sortField, $options),
  93.         ];
  95.         if (isset($options['sortNestedPath'])) {
  96.             $path = \is_callable($options['sortNestedPath']) ?
  97.                 $options['sortNestedPath']($sortField) : $options['sortNestedPath'];
  99.             if (!empty($path)) {
  100.                 $sort['nested_path'] = $path;
  101.             }
  102.         }
  104.         if (isset($options['sortNestedFilter'])) {
  105.             $filter = \is_callable($options['sortNestedFilter']) ?
  106.                 $options['sortNestedFilter']($sortField) : $options['sortNestedFilter'];
  108.             if (!empty($filter)) {
  109.                 $sort['nested_filter'] = $filter;
  110.             }
  111.         }
  113.         return $sort;
  114.     }
  116.     /**
  117.      * @param string               $sortField
  118.      * @param array<string, mixed> $options
  119.      *
  120.      * @return string
  121.      */
  122.     protected function getSortDirection($sortField, array $options = [])
  123.     {
  124.         $dir = 'asc';
  125.         $sortDirection = $this->getFromRequest($options['sortDirectionParameterName']);
  127.         if (empty($sortDirection) && isset($options['defaultSortDirection'])) {
  128.             $sortDirection = $options['defaultSortDirection'];
  129.         }
  131.         if (null !== $sortDirection && 'desc' === \strtolower($sortDirection)) {
  132.             $dir = 'desc';
  133.         }
  135.         // check if the requested sort field is in the sort whitelist
  136.         if (isset($options['sortFieldAllowList']) && !\in_array($sortField, $options['sortFieldAllowList'], true)) {
  137.             throw new \UnexpectedValueException(\sprintf('Cannot sort by: [%s] this field is not in whitelist', $sortField));
  138.         }
  140.         return $dir;
  141.     }
  143.     private function getRequest(): ?Request
  144.     {
  145.         return $this->requestStack->getCurrentRequest();
  146.     }
  148.     /**
  149.      * @return mixed|null
  150.      */
  151.     private function getFromRequest(?string $key)
  152.     {
  153.         if (null !== $key && null !== $request = $this->getRequest()) {
  154.             return $request->get($key);
  155.         }
  157.         return null;
  158.     }
  159. }