EntitySearcher::addTotalCountMode() - Code Metrics - shopware/platform - Measure and Improve Code Quality continuously with Scrutinizer

EntitySearcher::addTotalCountMode() A
last analyzed 2023-10-09 11:00 UTC

↳ Parent: EntitySearcher

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	3
nc	2
nop	2
dl	0
loc	7
rs	10
c	0
b	0
f	0

<?php declare(strict_types=1);

namespace Shopware\Core\Framework\DataAbstractionLayer\Dbal;

use Doctrine\DBAL\Connection;
use Shopware\Core\Framework\Context;
use Shopware\Core\Framework\DataAbstractionLayer\EntityDefinition;
use Shopware\Core\Framework\DataAbstractionLayer\Field\AutoIncrementField;
use Shopware\Core\Framework\DataAbstractionLayer\Field\Flag\PrimaryKey;
use Shopware\Core\Framework\DataAbstractionLayer\Field\ReferenceVersionField;
use Shopware\Core\Framework\DataAbstractionLayer\Field\StorageAware;
use Shopware\Core\Framework\DataAbstractionLayer\Field\VersionField;
use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearcherInterface;
use Shopware\Core\Framework\DataAbstractionLayer\Search\IdSearchResult;
use Shopware\Core\Framework\Log\Package;
use Shopware\Core\System\NumberRange\DataAbstractionLayer\NumberRangeField;

/**
 * Used for all search operations in the system.
 * The dbal entity searcher only joins and select fields which defined in sorting, filter or query classes.
 * Fields which are not necessary to determines which ids are affected are not fetched.
 *
 * @internal
 */
#[Package('core')]
class EntitySearcher implements EntitySearcherInterface
{
    public function __construct(
        private readonly Connection $connection,
        private readonly EntityDefinitionQueryHelper $queryHelper,
        private readonly CriteriaQueryBuilder $criteriaQueryBuilder
    ) {
    }

    public function search(EntityDefinition $definition, Criteria $criteria, Context $context): IdSearchResult
    {
        if ($criteria->getLimit() === 0) {
            return new IdSearchResult(0, [], $criteria, $context);
        }

        $table = $definition->getEntityName();

        $query = new QueryBuilder($this->connection);

        $fields = [];
        foreach ($definition->getFields() as $field) {
            if (!$field instanceof StorageAware || $field instanceof ReferenceVersionField || $field instanceof VersionField) {
                continue;
            }
            if ($field instanceof NumberRangeField) {
                $fields[$field->getStorageName()] = $field;

                continue;
            }
            if ($field instanceof AutoIncrementField) {
                $fields[$field->getStorageName()] = $field;

                continue;
            }
            if ($field->is(PrimaryKey::class)) {
                $fields[$field->getStorageName()] = $field;
            }
        }

        /** @var StorageAware $field */
        foreach ($fields as $field) {
            $query->addSelect(
                EntityDefinitionQueryHelper::escape($table) . '.' . EntityDefinitionQueryHelper::escape($field->getStorageName())
            );
        }

        $query = $this->criteriaQueryBuilder->build($query, $definition, $criteria, $context);

        if (!empty($criteria->getIds())) {
            $this->queryHelper->addIdCondition($criteria, $definition, $query);
        }

        $this->addGroupBy($definition, $criteria, $context, $query, $table);

        // add pagination
        if ($criteria->getOffset() !== null) {
            $query->setFirstResult($criteria->getOffset());
        }
        if ($criteria->getLimit() !== null) {
            $query->setMaxResults($criteria->getLimit());
        }

        $this->addTotalCountMode($criteria, $query);

        if ($criteria->getTitle()) {
            $query->setTitle($criteria->getTitle() . '::search-ids');
        }

        // execute and fetch ids
        $rows = $query->executeQuery()->fetchAllAssociative();

        $total = $this->getTotalCount($criteria, $query, $rows);

        if ($criteria->getTotalCountMode() === Criteria::TOTAL_COUNT_MODE_NEXT_PAGES) {
            $rows = \array_slice($rows, 0, $criteria->getLimit());
        }

        $converted = [];

        foreach ($rows as $row) {
            $pk = [];
            $data = [];

            foreach ($row as $storageName => $value) {
                $field = $fields[$storageName] ?? null;

                if (!$field) {
                    $data[$storageName] = $value;

                    continue;
                }

                $value = $field->getSerializer()->decode($field, $value);

                $data[$field->getPropertyName()] = $value;

                if (!$field->is(PrimaryKey::class)) {
                    continue;
                }

                $pk[$field->getPropertyName()] = $value;
            }

            $arrayKey = implode('-', $pk);

            if (\count($pk) === 1) {
                $pk = array_shift($pk);
            }

            $converted[$arrayKey] = [
                'primaryKey' => $pk,
                'data' => $data,
            ];
        }

        if ($criteria->useIdSorting()) {
            $converted = $this->sortByIdArray($criteria->getIds(), $converted);
        }

        return new IdSearchResult($total, $converted, $criteria, $context);
    }

    private function addTotalCountMode(Criteria $criteria, QueryBuilder $query): void
    {
        if ($criteria->getTotalCountMode() !== Criteria::TOTAL_COUNT_MODE_NEXT_PAGES) {
            return;
        }

        $query->setMaxResults($criteria->getLimit() * 6 + 1);
    }

    private function getTotalCount(Criteria $criteria, QueryBuilder $query, array $data): int
    {
        if ($criteria->getTotalCountMode() !== Criteria::TOTAL_COUNT_MODE_EXACT) {
            return \count($data);
        }

        $query->resetQueryPart('orderBy');
        $query->setMaxResults(null);
        $query->setFirstResult(0);

        $total = new QueryBuilder($this->connection);
        $total->select(['COUNT(*)'])
            ->from(sprintf('(%s) total', $query->getSQL()))
            ->setParameters($query->getParameters(), $query->getParameterTypes());

        return (int) $total->executeQuery()->fetchOne();
    }

    private function addGroupBy(EntityDefinition $definition, Criteria $criteria, Context $context, QueryBuilder $query, string $table): void
    {
        if ($criteria->getGroupFields()) {
            foreach ($criteria->getGroupFields() as $grouping) {
                $accessor = $this->queryHelper->getFieldAccessor($grouping->getField(), $definition, $definition->getEntityName(), $context);

                $query->addGroupBy($accessor);
            }

            return;
        }

        if ($query->hasState(EntityDefinitionQueryHelper::HAS_TO_MANY_JOIN)) {
            $query->addGroupBy(
                EntityDefinitionQueryHelper::escape($table) . '.' . EntityDefinitionQueryHelper::escape('id')
            );
        }
    }

    private function sortByIdArray(array $ids, array $data): array
    {
        $sorted = [];

        foreach ($ids as $id) {
            if (\is_array($id)) {
                $id = implode('-', $id);
            }

            if (\array_key_exists($id, $data)) {
                $sorted[$id] = $data[$id];
            }
        }

        return $sorted;
    }
}


1			<?php declare(strict_types=1);
2
3			namespace Shopware\Core\Framework\DataAbstractionLayer\Dbal;
4
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;
18
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			}
35
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			}
41
42			$table = $definition->getEntityName();
43
44			$query = new QueryBuilder($this->connection);
45
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;
53
54			continue;
55			}
56			if ($field instanceof AutoIncrementField) {
57			$fields[$field->getStorageName()] = $field;
58
59			continue;
60			}
61			if ($field->is(PrimaryKey::class)) {
62			$fields[$field->getStorageName()] = $field;
63			}
64			}
65
66			/** @var StorageAware $field */
67			foreach ($fields as $field) {
68			$query->addSelect(
69			EntityDefinitionQueryHelper::escape($table) . '.' . EntityDefinitionQueryHelper::escape($field->getStorageName())
70			);
71			}
72
73			$query = $this->criteriaQueryBuilder->build($query, $definition, $criteria, $context);
74
75			if (!empty($criteria->getIds())) {
76			$this->queryHelper->addIdCondition($criteria, $definition, $query);
77			}
78
79			$this->addGroupBy($definition, $criteria, $context, $query, $table);
80
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			}
88
89			$this->addTotalCountMode($criteria, $query);
90
91			if ($criteria->getTitle()) {
92			$query->setTitle($criteria->getTitle() . '::search-ids');
93			}
94
95			// execute and fetch ids
96			$rows = $query->executeQuery()->fetchAllAssociative();
97
98			$total = $this->getTotalCount($criteria, $query, $rows);
99
100			if ($criteria->getTotalCountMode() === Criteria::TOTAL_COUNT_MODE_NEXT_PAGES) {
101			$rows = \array_slice($rows, 0, $criteria->getLimit());
102			}
103
104			$converted = [];
105
106			foreach ($rows as $row) {
107			$pk = [];
108			$data = [];
109
110			foreach ($row as $storageName => $value) {
111			$field = $fields[$storageName] ?? null;
112
113			if (!$field) {
114			$data[$storageName] = $value;
115
116			continue;
117			}
118
119			$value = $field->getSerializer()->decode($field, $value);
120
121			$data[$field->getPropertyName()] = $value;
122
123			if (!$field->is(PrimaryKey::class)) {
124			continue;
125			}
126
127			$pk[$field->getPropertyName()] = $value;
128			}
129
130			$arrayKey = implode('-', $pk);
131
132			if (\count($pk) === 1) {
133			$pk = array_shift($pk);
134			}
135
136			$converted[$arrayKey] = [
137			'primaryKey' => $pk,
138			'data' => $data,
139			];
140			}
141
142			if ($criteria->useIdSorting()) {
143			$converted = $this->sortByIdArray($criteria->getIds(), $converted);
144			}
145
146			return new IdSearchResult($total, $converted, $criteria, $context);
147			}
148
149			private function addTotalCountMode(Criteria $criteria, QueryBuilder $query): void
150			{
151			if ($criteria->getTotalCountMode() !== Criteria::TOTAL_COUNT_MODE_NEXT_PAGES) {
152			return;
153			}
154
155			$query->setMaxResults($criteria->getLimit() * 6 + 1);
156			}
157
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			}
163
164			$query->resetQueryPart('orderBy');
165			$query->setMaxResults(null);
166			$query->setFirstResult(0);
167
168			$total = new QueryBuilder($this->connection);
169			$total->select(['COUNT(*)'])
170			->from(sprintf('(%s) total', $query->getSQL()))
171			->setParameters($query->getParameters(), $query->getParameterTypes());
172
173			return (int) $total->executeQuery()->fetchOne();
174			}
175
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);
181
182			$query->addGroupBy($accessor);
183			}
184
185			return;
186			}
187
188			if ($query->hasState(EntityDefinitionQueryHelper::HAS_TO_MANY_JOIN)) {
189			$query->addGroupBy(
190			EntityDefinitionQueryHelper::escape($table) . '.' . EntityDefinitionQueryHelper::escape('id')
191			);
192			}
193			}
194
195			private function sortByIdArray(array $ids, array $data): array
196			{
197			$sorted = [];
198
199			foreach ($ids as $id) {
200			if (\is_array($id)) {
201			$id = implode('-', $id);
202			}
203
204			if (\array_key_exists($id, $data)) {
205			$sorted[$id] = $data[$id];
206			}
207			}
208
209			return $sorted;
210			}
211			}
212

shopware / platform

EntitySearcher::addTotalCountMode() A last analyzed 2023-10-09 11:00 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

EntitySearcher::addTotalCountMode() A
last analyzed 2023-10-09 11:00 UTC