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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the FOSElasticaBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <http://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.     /**
  29.      * @param RequestStack $requestStack
  30.      */
  31.     public function __construct(RequestStack $requestStack)
  32.     {
  33.         $this->requestStack = $requestStack;
  34.     }
  36.     /**
  37.      * @param ItemsEvent $event
  38.      */
  39.     public function items(ItemsEvent $event)
  40.     {
  41.         if ($event->target instanceof PaginatorAdapterInterface) {
  42.             // Add sort to query
  43.             $this->setSorting($event);
  45.             /** @var $results PartialResultsInterface */
  46.             $results = $event->target->getResults($event->getOffset(), $event->getLimit());
  48.             $event->count = $results->getTotalHits();
  49.             $event->items = $results->toArray();
  50.             $aggregations = $results->getAggregations();
  51.             if (null != $aggregations) {
  52.                 $event->setCustomPaginationParameter('aggregations', $aggregations);
  53.             }
  55.             $event->stopPropagation();
  56.         }
  57.     }
  59.     /**
  60.      * @return array
  61.      */
  62.     public static function getSubscribedEvents()
  63.     {
  64.         return [
  65.             'knp_pager.items' => ['items', 1],
  66.         ];
  67.     }
  69.     /**
  70.      * Adds knp paging sort to query.
  71.      *
  72.      * @param ItemsEvent $event
  73.      */
  74.     protected function setSorting(ItemsEvent $event)
  75.     {
  76.         $options = $event->options;
  77.         $sortField = $this->getFromRequest($options['sortFieldParameterName'] ?? null);
  79.         if (!$sortField && isset($options['defaultSortFieldName'])) {
  80.             $sortField = $options['defaultSortFieldName'];
  81.         }
  83.         if (!empty($sortField)) {
  84.             $event->target->getQuery()->setSort([
  85.                 $sortField => $this->getSort($sortField, $options),
  86.             ]);
  87.         }
  88.     }
  90.     protected function getSort($sortField, array $options = [])
  91.     {
  92.         $sort = [
  93.             'order' => $this->getSortDirection($sortField, $options),
  94.         ];
  96.         if (isset($options['sortNestedPath'])) {
  97.             $path = is_callable($options['sortNestedPath']) ?
  98.                 $options['sortNestedPath']($sortField) : $options['sortNestedPath'];
  100.             if (!empty($path)) {
  101.                 $sort['nested_path'] = $path;
  102.             }
  103.         }
  105.         if (isset($options['sortNestedFilter'])) {
  106.             $filter = is_callable($options['sortNestedFilter']) ?
  107.                 $options['sortNestedFilter']($sortField) : $options['sortNestedFilter'];
  109.             if (!empty($filter)) {
  110.                 $sort['nested_filter'] = $filter;
  111.             }
  112.         }
  114.         return $sort;
  115.     }
  117.     protected function getSortDirection($sortField, array $options = [])
  118.     {
  119.         $dir = 'asc';
  120.         $sortDirection = $this->getFromRequest($options['sortDirectionParameterName']);
  122.         if (empty($sortDirection) && isset($options['defaultSortDirection'])) {
  123.             $sortDirection = $options['defaultSortDirection'];
  124.         }
  126.         if ('desc' === strtolower($sortDirection)) {
  127.             $dir = 'desc';
  128.         }
  130.         // check if the requested sort field is in the sort whitelist
  131.         if (isset($options['sortFieldWhitelist']) && !in_array($sortField, $options['sortFieldWhitelist'])) {
  132.             throw new \UnexpectedValueException(sprintf('Cannot sort by: [%s] this field is not in whitelist', $sortField));
  133.         }
  135.         return $dir;
  136.     }
  138.     /**
  139.      * @return Request|null
  140.      */
  141.     private function getRequest()
  142.     {
  143.         return $this->requestStack->getCurrentRequest();
  144.     }
  146.     /**
  147.      * @param string|null $key
  148.      * @return mixed|null
  149.      */
  150.     private function getFromRequest(?string $key)
  151.     {
  152.         if (null !== $key && null !== $request = $this->getRequest()) {
  153.             return $request->get($key);
  154.         }
  156.         return null;
  157.     }
  158. }