vendor/friendsofsymfony/elastica-bundle/src/Paginator/RawPaginatorAdapter.php line 177

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\Paginator;
  14. use Elastica\Query;
  15. use Elastica\ResultSet;
  16. use Elastica\SearchableInterface;
  17. use InvalidArgumentException;
  19. /**
  20.  * Allows pagination of Elastica\Query. Does not map results.
  21.  */
  22. class RawPaginatorAdapter implements PaginatorAdapterInterface
  23. {
  24.     /**
  25.      * @var SearchableInterface the object to search in
  26.      */
  27.     private $searchable;
  29.     /**
  30.      * @var Query the query to search
  31.      */
  32.     private $query;
  34.     /**
  35.      * @var array search options
  36.      */
  37.     private $options;
  39.     /**
  40.      * @var int the number of hits
  41.      */
  42.     private $totalHits;
  44.     /**
  45.      * @var array for the aggregations
  46.      */
  47.     private $aggregations;
  49.     /**
  50.      * @var array for the suggesters
  51.      */
  52.     private $suggests;
  54.     /**
  55.      * @var float
  56.      */
  57.     private $maxScore;
  59.     /**
  60.      * @see PaginatorAdapterInterface::__construct
  61.      *
  62.      * @param SearchableInterface $searchable the object to search in
  63.      * @param Query               $query      the query to search
  64.      * @param array               $options
  65.      */
  66.     public function __construct(SearchableInterface $searchable, Query $query, array $options = [])
  67.     {
  68.         $this->searchable = $searchable;
  69.         $this->query = $query;
  70.         $this->options = $options;
  71.     }
  73.     /**
  74.      * {@inheritdoc}
  75.      */
  76.     public function getResults($offset, $itemCountPerPage)
  77.     {
  78.         return new RawPartialResults($this->getElasticaResults($offset, $itemCountPerPage));
  79.     }
  81.     /**
  82.      * Returns the number of results.
  83.      *
  84.      * If genuineTotal is provided as true, total hits is returned from the
  85.      * hits.total value from the search results instead of just returning
  86.      * the requested size.
  87.      *
  88.      * {@inheritdoc}
  89.      */
  90.     public function getTotalHits($genuineTotal = false)
  91.     {
  92.         if (!isset($this->totalHits)) {
  93.             $this->totalHits = $this->searchable->count($this->query);
  94.         }
  96.         return $this->query->hasParam('size') && !$genuineTotal
  97.             ? min($this->totalHits, (int) $this->query->getParam('size'))
  98.             : $this->totalHits;
  99.     }
  101.     /**
  102.      * {@inheritdoc}
  103.      */
  104.     public function getAggregations()
  105.     {
  106.         if (!isset($this->aggregations)) {
  107.             $this->aggregations = $this->searchable->search($this->query)->getAggregations();
  108.         }
  110.         return $this->aggregations;
  111.     }
  113.     /**
  114.      * {@inheritdoc}
  115.      */
  116.     public function getSuggests()
  117.     {
  118.         if (!isset($this->suggests)) {
  119.             $this->suggests = $this->searchable->search($this->query)->getSuggests();
  120.         }
  122.         return $this->suggests;
  123.     }
  125.     /**
  126.      * @return float
  127.      */
  128.     public function getMaxScore()
  129.     {
  130.         if (!isset($this->maxScore)) {
  131.             $this->maxScore = $this->searchable->search($this->query)->getMaxScore();
  132.         }
  134.         return $this->maxScore;
  135.     }
  137.     /**
  138.      * Returns the Query.
  139.      *
  140.      * @return Query the search query
  141.      */
  142.     public function getQuery()
  143.     {
  144.         return $this->query;
  145.     }
  147.     /**
  148.      * Returns the paginated results.
  149.      *
  150.      * @param int $offset
  151.      * @param int $itemCountPerPage
  152.      *
  153.      * @throws \InvalidArgumentException
  154.      *
  155.      * @return ResultSet
  156.      */
  157.     protected function getElasticaResults($offset, $itemCountPerPage)
  158.     {
  159.         $offset = (int) $offset;
  160.         $itemCountPerPage = (int) $itemCountPerPage;
  161.         $size = $this->query->hasParam('size')
  162.             ? (int) $this->query->getParam('size')
  163.             : null;
  165.         if (null !== $size && $size < $offset + $itemCountPerPage) {
  166.             $itemCountPerPage = $size - $offset;
  167.         }
  169.         if ($itemCountPerPage < 1) {
  170.             throw new InvalidArgumentException('$itemCountPerPage must be greater than zero');
  171.         }
  173.         $query = clone $this->query;
  174.         $query->setFrom($offset);
  175.         $query->setSize($itemCountPerPage);
  177.         $resultSet = $this->searchable->search($query, $this->options);
  178.         $this->totalHits = $resultSet->getTotalHits();
  179.         $this->aggregations = $resultSet->getAggregations();
  180.         $this->suggests = $resultSet->getSuggests();
  181.         $this->maxScore = $resultSet->getMaxScore();
  183.         return $resultSet;
  184.     }
  185. }