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

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