vendor/shopware/core/Framework/DataAbstractionLayer/Search/EntitySearchResult.php line 16

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\DataAbstractionLayer\Search;
  5. use Shopware\Core\Framework\Context;
  6. use Shopware\Core\Framework\DataAbstractionLayer\Entity;
  7. use Shopware\Core\Framework\DataAbstractionLayer\EntityCollection;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Search\AggregationResult\AggregationResultCollection;
  9. use Shopware\Core\Framework\Struct\StateAwareTrait;
  11. /**
  12.  * @final
  13.  *
  14.  * @extends EntityCollection<Entity>
  15.  */
  16. class EntitySearchResult extends EntityCollection
  17. {
  18.     use StateAwareTrait;
  20.     /**
  21.      * @var string
  22.      */
  23.     protected $entity;
  25.     /**
  26.      * @var int
  27.      */
  28.     protected $total;
  30.     /**
  31.      * @var EntityCollection<Entity>
  32.      */
  33.     protected $entities;
  35.     /**
  36.      * @var AggregationResultCollection
  37.      */
  38.     protected $aggregations;
  40.     /**
  41.      * @var Criteria
  42.      */
  43.     protected $criteria;
  45.     /**
  46.      * @var Context
  47.      */
  48.     protected $context;
  50.     /**
  51.      * @var int
  52.      */
  53.     protected $page;
  55.     /**
  56.      * @var int|null
  57.      */
  58.     protected $limit;
  60.     /**
  61.      * @phpstan-ignore-next-line -> we can't generalize the type of EntityCollection here
  62.      */
  63.     final public function __construct(
  64.         string $entity,
  65.         int $total,
  66.         EntityCollection $entities,
  67.         ?AggregationResultCollection $aggregations,
  68.         Criteria $criteria,
  69.         Context $context
  70.     ) {
  71.         $this->entities = $entities;
  72.         $this->total = $total;
  73.         $this->aggregations = $aggregations ?? new AggregationResultCollection();
  74.         $this->criteria = $criteria;
  75.         $this->context = $context;
  76.         $this->limit = $criteria->getLimit();
  77.         $this->page = !$criteria->getLimit() ? 1 : (int) ceil((($criteria->getOffset() ?? 0) + 1) / $criteria->getLimit());
  79.         parent::__construct($entities);
  80.         $this->entity = $entity;
  81.     }
  83.     public function filter(\Closure $closure)
  84.     {
  85.         return $this->createNew($this->entities->filter($closure));
  86.     }
  88.     public function slice(int $offset, ?int $length = null)
  89.     {
  90.         return $this->createNew($this->entities->slice($offset, $length));
  91.     }
  93.     public function getTotal(): int
  94.     {
  95.         return $this->total;
  96.     }
  98.     /**
  99.      * @return EntityCollection<Entity>
  100.      */
  101.     public function getEntities(): EntityCollection
  102.     {
  103.         return $this->entities;
  104.     }
  106.     public function getAggregations(): AggregationResultCollection
  107.     {
  108.         return $this->aggregations;
  109.     }
  111.     public function getCriteria(): Criteria
  112.     {
  113.         return $this->criteria;
  114.     }
  116.     public function getContext(): Context
  117.     {
  118.         return $this->context;
  119.     }
  121.     public function clear(): void
  122.     {
  123.         parent::clear();
  125.         $this->entities->clear();
  126.     }
  128.     public function add($entity): void
  129.     {
  130.         parent::add($entity);
  132.         $this->entities->add($entity);
  133.     }
  135.     public function jsonSerialize(): array
  136.     {
  137.         $vars = get_object_vars($this);
  139.         unset($vars['criteria']);
  140.         unset($vars['context']);
  141.         unset($vars['entities']);
  143.         $this->convertDateTimePropertiesToJsonStringRepresentation($vars);
  145.         return $vars;
  146.     }
  148.     public function getApiAlias(): string
  149.     {
  150.         return 'dal_entity_search_result';
  151.     }
  153.     public function getPage(): ?int
  154.     {
  155.         return $this->page;
  156.     }
  158.     public function setPage(int $page): void
  159.     {
  160.         $this->page = $page;
  161.     }
  163.     public function getLimit(): ?int
  164.     {
  165.         return $this->limit;
  166.     }
  168.     public function setLimit(int $limit): void
  169.     {
  170.         $this->limit = $limit;
  171.     }
  173.     public function getEntity(): string
  174.     {
  175.         return $this->entity;
  176.     }
  178.     public function setEntity(string $entity): void
  179.     {
  180.         $this->entity = $entity;
  181.     }
  183.     /**
  184.      * @return Entity|null
  185.      */
  186.     public function getAt(int $position)
  187.     {
  188.         return $this->entities->getAt($position);
  189.     }
  191.     protected function createNew(iterable $elements = [])
  192.     {
  193.         return new static(
  194.             $this->entity,
  195.             $this->total,
  196.             $elements,
  197.             $this->aggregations,
  198.             $this->criteria,
  199.             $this->context
  200.         );
  201.     }
  202. }