vendor/ibexa/core/src/contracts/Repository/Values/Content/Search/SearchResult.php line 19

Open in your IDE?
  1. <?php
  3. /**
  4.  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  5.  * @license For full copyright and license information view LICENSE file distributed with this source code.
  6.  */
  7. declare(strict_types=1);
  9. namespace Ibexa\Contracts\Core\Repository\Values\Content\Search;
  11. use ArrayIterator;
  12. use Ibexa\Contracts\Core\Repository\Values\ValueObject;
  13. use Iterator;
  14. use IteratorAggregate;
  16. /**
  17.  * This class represents a search result.
  18.  */
  19. class SearchResult extends ValueObject implements IteratorAggregate, AggregationResultAwareInterface
  20. {
  21.     /**
  22.      * The facets for this search.
  23.      *
  24.      * @var \Ibexa\Contracts\Core\Repository\Values\Content\Search\Facet[]
  25.      *
  26.      * @deprecated since eZ Platform 3.2.0, to be removed in Ibexa 4.0.0.
  27.      */
  28.     public $facets = [];
  30.     /**
  31.      * @var \Ibexa\Contracts\Core\Repository\Values\Content\Search\AggregationResultCollection
  32.      */
  33.     public $aggregations;
  35.     /**
  36.      * The value objects found for the query.
  37.      *
  38.      * @var \Ibexa\Contracts\Core\Repository\Values\Content\Search\SearchHit[]
  39.      */
  40.     public $searchHits = [];
  42.     /**
  43.      * If spellcheck is on this field contains a collated query suggestion where in the appropriate
  44.      * criterions the wrong spelled value is replaced by a corrected one (TBD).
  45.      *
  46.      * @var \Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion
  47.      *
  48.      * @deprecated since Ibexa 4.6.0, to be removed in Ibexa 5.0.0.
  49.      */
  50.     public $spellSuggestion;
  52.     public ?SpellcheckResult $spellcheck = null;
  54.     /**
  55.      * The duration of the search processing in ms.
  56.      *
  57.      * @var int
  58.      */
  59.     public $time;
  61.     /**
  62.      * Indicates if the search has timed out.
  63.      *
  64.      * @var bool
  65.      */
  66.     public $timedOut;
  68.     /**
  69.      * The maximum score of this query.
  70.      *
  71.      * @var float
  72.      */
  73.     public $maxScore;
  75.     /**
  76.      * The total number of searchHits.
  77.      *
  78.      * `null` if Query->performCount was set to false and search engine avoids search lookup.
  79.      *
  80.      * @var int|null
  81.      */
  82.     public $totalCount;
  84.     public function __construct(array $properties = [])
  85.     {
  86.         if (!isset($properties['aggregations'])) {
  87.             $properties['aggregations'] = new AggregationResultCollection();
  88.         }
  90.         parent::__construct($properties);
  91.     }
  93.     public function getSpellcheck(): ?SpellcheckResult
  94.     {
  95.         return $this->spellcheck;
  96.     }
  98.     public function getAggregations(): ?AggregationResultCollection
  99.     {
  100.         return $this->aggregations;
  101.     }
  103.     public function getIterator(): Iterator
  104.     {
  105.         return new ArrayIterator($this->searchHits);
  106.     }
  107. }
  109. class_alias(SearchResult::class, 'eZ\Publish\API\Repository\Values\Content\Search\SearchResult');