vendor/friendsofsymfony/elastica-bundle/Subscriber/PaginateElasticaQuerySubscriber.php line 34

Open in your IDE?
  1. <?php
  3. namespace FOS\ElasticaBundle\Subscriber;
  5. use FOS\ElasticaBundle\Paginator\PaginatorAdapterInterface;
  6. use FOS\ElasticaBundle\Paginator\PartialResultsInterface;
  7. use Knp\Component\Pager\Event\ItemsEvent;
  8. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  9. use Symfony\Component\HttpFoundation\Request;
  10. use Symfony\Component\HttpFoundation\RequestStack;
  12. class PaginateElasticaQuerySubscriber implements EventSubscriberInterface
  13. {
  14.     /**
  15.      * @var Request
  16.      */
  17.     private $request;
  19.     /**
  20.      * @param RequestStack|Request $requestStack
  21.      */
  22.     public function setRequest($requestStack)
  23.     {
  24.         if ($requestStack instanceof Request) {
  25.             $this->request = $requestStack;
  26.         } elseif ($requestStack instanceof RequestStack) {
  27.             $this->request = $requestStack->getMasterRequest();
  28.         }
  29.     }
  31.     /**
  32.      * @param ItemsEvent $event
  33.      */
  34.     public function items(ItemsEvent $event)
  35.     {
  36.         if ($event->target instanceof PaginatorAdapterInterface) {
  37.             // Add sort to query
  38.             $this->setSorting($event);
  40.             /** @var $results PartialResultsInterface */
  41.             $results = $event->target->getResults($event->getOffset(), $event->getLimit());
  43.             $event->count = $results->getTotalHits();
  44.             $event->items = $results->toArray();
  45.             $aggregations = $results->getAggregations();
  46.             if (null != $aggregations) {
  47.                 $event->setCustomPaginationParameter('aggregations', $aggregations);
  48.             }
  50.             $event->stopPropagation();
  51.         }
  52.     }
  54.     /**
  55.      * Adds knp paging sort to query.
  56.      *
  57.      * @param ItemsEvent $event
  58.      */
  59.     protected function setSorting(ItemsEvent $event)
  60.     {
  61.         $options = $event->options;
  62.         $sortField = $this->request->get($options['sortFieldParameterName']);
  64.         if (!$sortField && isset($options['defaultSortFieldName'])) {
  65.             $sortField = $options['defaultSortFieldName'];
  66.         }
  68.         if (!empty($sortField)) {
  69.             $event->target->getQuery()->setSort(array(
  70.                 $sortField => $this->getSort($sortField, $options),
  71.             ));
  72.         }
  73.     }
  75.     protected function getSort($sortField, array $options = [])
  76.     {
  77.         $sort = [
  78.             'order' => $this->getSortDirection($sortField, $options),
  79.         ];
  81.         if (isset($options['sortNestedPath'])) {
  82.             $path = is_callable($options['sortNestedPath']) ?
  83.                 $options['sortNestedPath']($sortField) : $options['sortNestedPath'];
  85.             if (!empty($path)) {
  86.                 $sort['nested_path'] = $path;
  87.             }
  88.         }
  90.         if (isset($options['sortNestedFilter'])) {
  91.             $filter = is_callable($options['sortNestedFilter']) ?
  92.                 $options['sortNestedFilter']($sortField) : $options['sortNestedFilter'];
  94.             if (!empty($filter)) {
  95.                 $sort['nested_filter'] = $filter;
  96.             }
  97.         }
  99.         return $sort;
  100.     }
  102.     protected function getSortDirection($sortField, array $options = [])
  103.     {
  104.         $dir = 'asc';
  105.         $sortDirection = $this->request->get($options['sortDirectionParameterName']);
  107.         if (empty($sortDirection) && isset($options['defaultSortDirection'])) {
  108.             $sortDirection = $options['defaultSortDirection'];
  109.         }
  111.         if ('desc' === strtolower($sortDirection)) {
  112.             $dir = 'desc';
  113.         }
  115.         // check if the requested sort field is in the sort whitelist
  116.         if (isset($options['sortFieldWhitelist']) && !in_array($sortField, $options['sortFieldWhitelist'])) {
  117.             throw new \UnexpectedValueException(sprintf('Cannot sort by: [%s] this field is not in whitelist', $sortField));
  118.         }
  120.         return $dir;
  121.     }
  123.     /**
  124.      * @return array
  125.      */
  126.     public static function getSubscribedEvents()
  127.     {
  128.         return array(
  129.             'knp_pager.items' => array('items', 1),
  130.         );
  131.     }
  132. }