src/Core/Framework/DataAbstractionLayer/Dbal/EntitySearcher.php line 98

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\DataAbstractionLayer\Dbal;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Framework\Context;
  7. use Shopware\Core\Framework\DataAbstractionLayer\EntityDefinition;
  8. use Shopware\Core\Framework\DataAbstractionLayer\Field\AutoIncrementField;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\PrimaryKey;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Field\ReferenceVersionField;
  11. use Shopware\Core\Framework\DataAbstractionLayer\Field\StorageAware;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Field\VersionField;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearcherInterface;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\IdSearchResult;
  16. use Shopware\Core\Framework\Log\Package;
  17. use Shopware\Core\System\NumberRange\DataAbstractionLayer\NumberRangeField;
  19. /**
  20.  * Used for all search operations in the system.
  21.  * The dbal entity searcher only joins and select fields which defined in sorting, filter or query classes.
  22.  * Fields which are not necessary to determines which ids are affected are not fetched.
  23.  *
  24.  * @internal
  25.  */
  26. #[Package('core')]
  27. class EntitySearcher implements EntitySearcherInterface
  28. {
  29.     public function __construct(
  30.         private readonly Connection $connection,
  31.         private readonly EntityDefinitionQueryHelper $queryHelper,
  32.         private readonly CriteriaQueryBuilder $criteriaQueryBuilder
  33.     ) {
  34.     }
  36.     public function search(EntityDefinition $definition, Criteria $criteria, Context $context): IdSearchResult
  37.     {
  38.         if ($criteria->getLimit() === 0) {
  39.             return new IdSearchResult(0, [], $criteria, $context);
  40.         }
  42.         $table = $definition->getEntityName();
  44.         $query = new QueryBuilder($this->connection);
  46.         $fields = [];
  47.         foreach ($definition->getFields() as $field) {
  48.             if (!$field instanceof StorageAware || $field instanceof ReferenceVersionField || $field instanceof VersionField) {
  49.                 continue;
  50.             }
  51.             if ($field instanceof NumberRangeField) {
  52.                 $fields[$field->getStorageName()] = $field;
  54.                 continue;
  55.             }
  56.             if ($field instanceof AutoIncrementField) {
  57.                 $fields[$field->getStorageName()] = $field;
  59.                 continue;
  60.             }
  61.             if ($field->is(PrimaryKey::class)) {
  62.                 $fields[$field->getStorageName()] = $field;
  63.             }
  64.         }
  66.         /** @var StorageAware $field */
  67.         foreach ($fields as $field) {
  68.             $query->addSelect(
  69.                 EntityDefinitionQueryHelper::escape($table) . '.' . EntityDefinitionQueryHelper::escape($field->getStorageName())
  70.             );
  71.         }
  73.         $query = $this->criteriaQueryBuilder->build($query, $definition, $criteria, $context);
  75.         if (!empty($criteria->getIds())) {
  76.             $this->queryHelper->addIdCondition($criteria, $definition, $query);
  77.         }
  79.         $this->addGroupBy($definition, $criteria, $context, $query, $table);
  81.         //add pagination
  82.         if ($criteria->getOffset() !== null) {
  83.             $query->setFirstResult($criteria->getOffset());
  84.         }
  85.         if ($criteria->getLimit() !== null) {
  86.             $query->setMaxResults($criteria->getLimit());
  87.         }
  89.         $this->addTotalCountMode($criteria, $query);
  91.         if ($criteria->getTitle()) {
  92.             $query->setTitle($criteria->getTitle() . '::search-ids');
  93.         }
  95.         //execute and fetch ids
  96.         $rows = $query->executeQuery()->fetchAllAssociative();
  98.         $total = $this->getTotalCount($criteria, $query, $rows);
  100.         if ($criteria->getTotalCountMode() === Criteria::TOTAL_COUNT_MODE_NEXT_PAGES) {
  101.             $rows = \array_slice($rows, 0, $criteria->getLimit());
  102.         }
  104.         $converted = [];
  106.         foreach ($rows as $row) {
  107.             $pk = [];
  108.             $data = [];
  110.             foreach ($row as $storageName => $value) {
  111.                 $field = $fields[$storageName] ?? null;
  113.                 if (!$field) {
  114.                     $data[$storageName] = $value;
  116.                     continue;
  117.                 }
  119.                 $value = $field->getSerializer()->decode($field, $value);
  121.                 $data[$field->getPropertyName()] = $value;
  123.                 if (!$field->is(PrimaryKey::class)) {
  124.                     continue;
  125.                 }
  127.                 $pk[$field->getPropertyName()] = $value;
  128.             }
  130.             $arrayKey = implode('-', $pk);
  132.             if (\count($pk) === 1) {
  133.                 $pk = array_shift($pk);
  134.             }
  136.             $converted[$arrayKey] = [
  137.                 'primaryKey' => $pk,
  138.                 'data' => $data,
  139.             ];
  140.         }
  142.         if ($criteria->useIdSorting()) {
  143.             $converted = $this->sortByIdArray($criteria->getIds(), $converted);
  144.         }
  146.         return new IdSearchResult($total, $converted, $criteria, $context);
  147.     }
  149.     private function addTotalCountMode(Criteria $criteria, QueryBuilder $query): void
  150.     {
  151.         if ($criteria->getTotalCountMode() !== Criteria::TOTAL_COUNT_MODE_NEXT_PAGES) {
  152.             return;
  153.         }
  155.         $query->setMaxResults($criteria->getLimit() * 6 + 1);
  156.     }
  158.     private function getTotalCount(Criteria $criteria, QueryBuilder $query, array $data): int
  159.     {
  160.         if ($criteria->getTotalCountMode() !== Criteria::TOTAL_COUNT_MODE_EXACT) {
  161.             return \count($data);
  162.         }
  164.         $query->resetQueryPart('orderBy');
  165.         $query->setMaxResults(null);
  166.         $query->setFirstResult(0);
  168.         $total = new QueryBuilder($query->getConnection());
  169.         $total->select(['COUNT(*)'])
  170.             ->from(sprintf('(%s) total', $query->getSQL()))
  171.             ->setParameters($query->getParameters(), $query->getParameterTypes());
  173.         return (int) $total->executeQuery()->fetchOne();
  174.     }
  176.     private function addGroupBy(EntityDefinition $definition, Criteria $criteria, Context $context, QueryBuilder $query, string $table): void
  177.     {
  178.         if ($criteria->getGroupFields()) {
  179.             foreach ($criteria->getGroupFields() as $grouping) {
  180.                 $accessor = $this->queryHelper->getFieldAccessor($grouping->getField(), $definition, $definition->getEntityName(), $context);
  182.                 $query->addGroupBy($accessor);
  183.             }
  185.             return;
  186.         }
  188.         if ($query->hasState(EntityDefinitionQueryHelper::HAS_TO_MANY_JOIN)) {
  189.             $query->addGroupBy(
  190.                 EntityDefinitionQueryHelper::escape($table) . '.' . EntityDefinitionQueryHelper::escape('id')
  191.             );
  192.         }
  193.     }
  195.     private function sortByIdArray(array $ids, array $data): array
  196.     {
  197.         $sorted = [];
  199.         foreach ($ids as $id) {
  200.             if (\is_array($id)) {
  201.                 $id = implode('-', $id);
  202.             }
  204.             if (\array_key_exists($id, $data)) {
  205.                 $sorted[$id] = $data[$id];
  206.             }
  207.         }
  209.         return $sorted;
  210.     }
  211. }