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.     /**
  24.      * @var RequestStack
  25.      */
  26.     private $requestStack;
  28.     public function __construct(RequestStack $requestStack)
  29.     {
  30.         $this->requestStack = $requestStack;
  31.     }
  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.     /**
  54.      * @return array
  55.      */
  56.     public static function getSubscribedEvents()
  57.     {
  58.         return [
  59.             'knp_pager.items' => ['items', 1],
  60.         ];
  61.     }
  63.     /**
  64.      * Adds knp paging sort to query.
  65.      */
  66.     protected function setSorting(ItemsEvent $event)
  67.     {
  68.         // Bugfix for PHP 7.4 as options can be null and generate a "Trying to access array offset on value of type null" error
  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.     protected function getSort($sortField, array $options = [])
  84.     {
  85.         $sort = [
  86.             'order' => $this->getSortDirection($sortField, $options),
  87.         ];
  89.         if (isset($options['sortNestedPath'])) {
  90.             $path = \is_callable($options['sortNestedPath']) ?
  91.                 $options['sortNestedPath']($sortField) : $options['sortNestedPath'];
  93.             if (!empty($path)) {
  94.                 $sort['nested_path'] = $path;
  95.             }
  96.         }
  98.         if (isset($options['sortNestedFilter'])) {
  99.             $filter = \is_callable($options['sortNestedFilter']) ?
  100.                 $options['sortNestedFilter']($sortField) : $options['sortNestedFilter'];
  102.             if (!empty($filter)) {
  103.                 $sort['nested_filter'] = $filter;
  104.             }
  105.         }
  107.         return $sort;
  108.     }
  110.     protected function getSortDirection($sortField, array $options = [])
  111.     {
  112.         $dir = 'asc';
  113.         $sortDirection = $this->getFromRequest($options['sortDirectionParameterName']);
  115.         if (empty($sortDirection) && isset($options['defaultSortDirection'])) {
  116.             $sortDirection = $options['defaultSortDirection'];
  117.         }
  119.         if (null !== $sortDirection && 'desc' === \strtolower($sortDirection)) {
  120.             $dir = 'desc';
  121.         }
  123.         // check if the requested sort field is in the sort whitelist
  124.         if (isset($options['sortFieldAllowList']) && !\in_array($sortField, $options['sortFieldAllowList'], true)) {
  125.             throw new \UnexpectedValueException(\sprintf('Cannot sort by: [%s] this field is not in whitelist', $sortField));
  126.         }
  128.         return $dir;
  129.     }
  131.     private function getRequest(): ?Request
  132.     {
  133.         return $this->requestStack->getCurrentRequest();
  134.     }
  136.     /**
  137.      * @return mixed|null
  138.      */
  139.     private function getFromRequest(?string $key)
  140.     {
  141.         if (null !== $key && null !== $request = $this->getRequest()) {
  142.             return $request->get($key);
  143.         }
  145.         return null;
  146.     }
  147. }