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

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\Log\Package;
  10. use Shopware\Core\Framework\Struct\StateAwareTrait;
  12. /**
  13.  * @final
  14.  *
  15.  * @extends EntityCollection<Entity>
  16.  */
  17. #[Package('core')]
  18. class EntitySearchResult extends EntityCollection
  19. {
  20.     use StateAwareTrait;
  22.     /**
  23.      * @var string
  24.      */
  25.     protected $entity;
  27.     /**
  28.      * @var int
  29.      */
  30.     protected $total;
  32.     /**
  33.      * @var EntityCollection<Entity>
  34.      */
  35.     protected $entities;
  37.     /**
  38.      * @var AggregationResultCollection
  39.      */
  40.     protected $aggregations;
  42.     /**
  43.      * @var Criteria
  44.      */
  45.     protected $criteria;
  47.     /**
  48.      * @var Context
  49.      */
  50.     protected $context;
  52.     /**
  53.      * @var int
  54.      */
  55.     protected $page;
  57.     /**
  58.      * @var int|null
  59.      */
  60.     protected $limit;
  62.     /**
  63.      * @phpstan-ignore-next-line -> we can't generalize the type of EntityCollection here
  64.      */
  65.     final public function __construct(
  66.         string $entity,
  67.         int $total,
  68.         EntityCollection $entities,
  69.         ?AggregationResultCollection $aggregations,
  70.         Criteria $criteria,
  71.         Context $context
  72.     ) {
  73.         $this->entities = $entities;
  74.         $this->total = $total;
  75.         $this->aggregations = $aggregations ?? new AggregationResultCollection();
  76.         $this->criteria = $criteria;
  77.         $this->context = $context;
  78.         $this->limit = $criteria->getLimit();
  79.         $this->page = !$criteria->getLimit() ? 1 : (int) ceil((($criteria->getOffset() ?? 0) + 1) / $criteria->getLimit());
  81.         parent::__construct($entities);
  82.         $this->entity = $entity;
  83.     }
  85.     public function filter(\Closure $closure)
  86.     {
  87.         return $this->createNew($this->entities->filter($closure));
  88.     }
  90.     public function slice(int $offset, ?int $length = null)
  91.     {
  92.         return $this->createNew($this->entities->slice($offset, $length));
  93.     }
  95.     public function getTotal(): int
  96.     {
  97.         return $this->total;
  98.     }
  100.     /**
  101.      * @return EntityCollection<Entity>
  102.      */
  103.     public function getEntities(): EntityCollection
  104.     {
  105.         return $this->entities;
  106.     }
  108.     public function getAggregations(): AggregationResultCollection
  109.     {
  110.         return $this->aggregations;
  111.     }
  113.     public function getCriteria(): Criteria
  114.     {
  115.         return $this->criteria;
  116.     }
  118.     public function getContext(): Context
  119.     {
  120.         return $this->context;
  121.     }
  123.     public function clear(): void
  124.     {
  125.         parent::clear();
  127.         $this->entities->clear();
  128.     }
  130.     public function add($entity): void
  131.     {
  132.         parent::add($entity);
  134.         $this->entities->add($entity);
  135.     }
  137.     public function jsonSerialize(): array
  138.     {
  139.         $vars = get_object_vars($this);
  141.         unset($vars['criteria']);
  142.         unset($vars['context']);
  143.         unset($vars['entities']);
  145.         $this->convertDateTimePropertiesToJsonStringRepresentation($vars);
  147.         return $vars;
  148.     }
  150.     public function getApiAlias(): string
  151.     {
  152.         return 'dal_entity_search_result';
  153.     }
  155.     public function getPage(): ?int
  156.     {
  157.         return $this->page;
  158.     }
  160.     public function setPage(int $page): void
  161.     {
  162.         $this->page = $page;
  163.     }
  165.     public function getLimit(): ?int
  166.     {
  167.         return $this->limit;
  168.     }
  170.     public function setLimit(int $limit): void
  171.     {
  172.         $this->limit = $limit;
  173.     }
  175.     public function getEntity(): string
  176.     {
  177.         return $this->entity;
  178.     }
  180.     public function setEntity(string $entity): void
  181.     {
  182.         $this->entity = $entity;
  183.     }
  185.     /**
  186.      * @return Entity|null
  187.      */
  188.     public function getAt(int $position)
  189.     {
  190.         return $this->entities->getAt($position);
  191.     }
  193.     /**
  194.      * @return static
  195.      *
  196.      * @deprecated tag:v6.6.0  - reason:return-type-change - Return type will be changed to `static`
  197.      */
  198.     protected function createNew(iterable $elements = [])
  199.     {
  200.         if (!($elements instanceof EntityCollection)) {
  201.             $elements = new EntityCollection($elements);
  202.         }
  204.         return new static(
  205.             $this->entity,
  206.             $elements->count(),
  207.             $elements,
  208.             $this->aggregations,
  209.             $this->criteria,
  210.             $this->context
  211.         );
  212.     }
  213. }