QueryService::findOne() - Code Metrics - Inspection of "Feature 0.2.0" - alex-patterson-webdev/doctrine-entity-repository - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#8)

by Alex

created 2021-03-31 21:44 UTC

QueryService::findOne() A

↳ Parent: QueryService

Complexity

Conditions	3
Paths	4

Size

Total Lines	22
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	14
c	1
b	0
f	0
dl	0
loc	22
rs	9.7998
cc	3
nc	4
nop	2

<?php

declare(strict_types=1);

namespace Arp\DoctrineEntityRepository\Query;

use Arp\DoctrineEntityRepository\Constant\QueryServiceOption;
use Arp\DoctrineEntityRepository\Query\Exception\QueryServiceException;
use Arp\Entity\EntityInterface;
use Doctrine\ORM\AbstractQuery;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Query;
use Doctrine\ORM\QueryBuilder;
use Psr\Log\LoggerInterface;

/**
 * @author  Alex Patterson <[email protected]>
 * @package Arp\DoctrineEntityRepository\Query
 */
class QueryService implements QueryServiceInterface
{
    /**
     * @var string
     */
    protected string $entityName;

    /**
     * @var EntityManagerInterface
     */
    protected EntityManagerInterface $entityManager;

    /**
     * @var LoggerInterface
     */
    protected LoggerInterface $logger;

    /**
     * @param string                 $entityName
     * @param EntityManagerInterface $entityManager
     * @param LoggerInterface        $logger
     */
    public function __construct(string $entityName, EntityManagerInterface $entityManager, LoggerInterface $logger)
    {
        $this->entityName = $entityName;
        $this->entityManager = $entityManager;
        $this->logger = $logger;
    }

    /**
     * @return string
     */
    public function getEntityName(): string
    {
        return $this->entityName;
    }

    /**
     * Return a new query builder instance.
     *
     * @param string|null $alias The optional query builder alias.
     *
     * @return QueryBuilder
     */
    public function createQueryBuilder(string $alias = null): QueryBuilder
    {
        $queryBuilder = $this->entityManager->createQueryBuilder();

        if (null !== $alias) {
            $queryBuilder->select($alias)->from($this->entityName, $alias);
        }

        return $queryBuilder;
    }

    /**
     * @param AbstractQuery|QueryBuilder $queryOrBuilder
     * @param array<string, mixed>       $options
     *
     * @return EntityInterface|null|array<mixed>
     *
     * @throws QueryServiceException
     */
    public function getSingleResultOrNull($queryOrBuilder, array $options = [])
    {
        $result = $this->execute($queryOrBuilder, $options);

        if (empty($result)) {
            return null;
        }

        if (!is_array($result)) {
            return $result;
        }

        if (count($result) > 1) {
            return null;
        }

        return array_shift($result);
    }

    /**
     * Construct and execute the query.
     *
     * @param AbstractQuery|QueryBuilder|mixed $queryOrBuilder
     * @param array<string, mixed>             $options
     *
     * @return mixed
     *
     * @throws QueryServiceException
     */
    public function execute($queryOrBuilder, array $options = [])
    {
        if ($queryOrBuilder instanceof QueryBuilder) {
            $this->prepareQueryBuilder($queryOrBuilder, $options);

            $queryOrBuilder = $queryOrBuilder->getQuery();
        }

        if (!$queryOrBuilder instanceof AbstractQuery) {
            throw new QueryServiceException(
                sprintf(
                    'Query provided must be of type \'%s\'; \'%s\' provided in \'%s\'.',
                    AbstractQuery::class,
                    (is_object($queryOrBuilder) ? get_class($queryOrBuilder) : gettype($queryOrBuilder)),
                    __METHOD__
                )
            );
        }

        try {
            $query = $this->prepareQuery($queryOrBuilder, $options);

            return $query->execute();
        } catch (\Throwable $e) {
            $message = sprintf('Failed to execute query : %s', $e->getMessage());

            $this->logger->error($message, ['exception' => $e]);

            throw new QueryServiceException($message, $e->getCode(), $e);
        }
    }

    /**
     * Find a single entity matching the provided identity.
     *
     * @param mixed                $id      The identity of the entity to match.
     * @param array<string, mixed> $options The optional query options.
     *
     * @return EntityInterface|null
     *
     * @throws QueryServiceException
     */
    public function findOneById($id, array $options = []): ?EntityInterface
    {
        return $this->findOne(compact('id'), $options);
    }

    /**
     * Find a single entity matching the provided criteria.
     *
     * @param array<string, mixed> $criteria The search criteria that should be matched on.
     * @param array<string, mixed> $options  The optional query options.
     *
     * @return EntityInterface|null
     *
     * @throws QueryServiceException
     */
    public function findOne(array $criteria, array $options = []): ?EntityInterface
    {
        try {
            $persist = $this->entityManager->getUnitOfWork()->getEntityPersister($this->entityName);

            $entity = $persist->load(
                $criteria,
                $options[QueryServiceOption::ENTITY] ?? null,
                $options[QueryServiceOption::ASSOCIATION] ?? null,
                $options[QueryServiceOption::HINTS] ?? [],
                $options[QueryServiceOption::LOCK_MODE] ?? null,
                1,
                $options[QueryServiceOption::ORDER_BY] ?? null
            );

            return ($entity instanceof EntityInterface) ? $entity : null;
        } catch (\Throwable $e) {
            $message = sprintf('Failed to execute \'findOne\' query: %s', $e->getMessage());

            $this->logger->error($message, ['exception' => $e, 'criteria' => $criteria, 'options' => $options]);

            throw new QueryServiceException($message, $e->getCode(), $e);
        }
    }

    /**
     * Find a collection of entities that match the provided criteria.
     *
     * @param array<string, mixed> $criteria The search criteria that should be matched on.
     * @param array<string, mixed> $options  The optional query options.
     *
     * @return iterable<EntityInterface>
     *
     * @throws QueryServiceException
     */
    public function findMany(array $criteria, array $options = []): iterable
    {
        try {
            $persister = $this->entityManager->getUnitOfWork()->getEntityPersister($this->entityName);

            return $persister->loadAll(
                $criteria,
                $options[QueryServiceOption::ORDER_BY] ?? null,
                $options[QueryServiceOption::LIMIT] ?? null,
                $options[QueryServiceOption::OFFSET] ?? null
            );
        } catch (\Throwable $e) {
            $message = sprintf('Failed to execute \'findMany\' query: %s', $e->getMessage());

            $this->logger->error($message, ['exception' => $e, 'criteria' => $criteria, 'options' => $options]);

            throw new QueryServiceException($message, $e->getCode(), $e);
        }
    }

    /**
     * Return the result set count.
     *
     * @param array<string, mixed> $criteria
     *
     * @return mixed
     */
    public function count(array $criteria)
    {
        $unitOfWork = $this->entityManager->getUnitOfWork();

        return $unitOfWork->getEntityPersister($this->entityName)->count($criteria);
    }

    /**
     * Set the query builder options.
     *
     * @param QueryBuilder         $queryBuilder The query builder to update.
     * @param array<string, mixed> $options      The query builder options to set.
     *
     * @return QueryBuilder
     */
    protected function prepareQueryBuilder(QueryBuilder $queryBuilder, array $options = []): QueryBuilder
    {
        if (array_key_exists(QueryServiceOption::FIRST_RESULT, $options)) {
            $queryBuilder->setFirstResult($options[QueryServiceOption::FIRST_RESULT]);
        }

        if (array_key_exists(QueryServiceOption::MAX_RESULTS, $options)) {
            $queryBuilder->setMaxResults($options[QueryServiceOption::MAX_RESULTS]);
        }

        if (
            array_key_exists(QueryServiceOption::ORDER_BY, $options)
            && is_array($options[QueryServiceOption::ORDER_BY])
        ) {
            foreach ($options[QueryServiceOption::ORDER_BY] as $fieldName => $orderDirection) {
                $queryBuilder->addOrderBy(
                    $fieldName,
                    ('DESC' === strtoupper($orderDirection) ? 'DESC' : 'ASC')
                );
            }
        }

        return $queryBuilder;
    }

    /**
     * Prepare the provided query by setting the $options.
     *
     * @param AbstractQuery        $query
     * @param array<string, mixed> $options
     *
     * @return AbstractQuery
     *
     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
     * @todo Reduce cyclomatic complexity
     */
    protected function prepareQuery(AbstractQuery $query, array $options = []): AbstractQuery
    {
        if (array_key_exists('params', $options)) {
            $query->setParameters($options['params']);
        }

        if (array_key_exists(QueryServiceOption::HYDRATION_MODE, $options)) {
            $query->setHydrationMode($options[QueryServiceOption::HYDRATION_MODE]);
        }

        if (array_key_exists('result_set_mapping', $options)) {
            $query->setResultSetMapping($options['result_set_mapping']);
        }

        if (isset($options[QueryServiceOption::HINTS]) && is_array($options[QueryServiceOption::HINTS])) {
            foreach ($options[QueryServiceOption::HINTS] as $hint => $hintValue) {
                $query->setHint($hint, $hintValue);
            }
        }

        if (!empty($options[QueryServiceOption::DQL]) && $query instanceof Query) {
            $query->setDQL($options[QueryServiceOption::DQL]);
        }

        return $query;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Arp\DoctrineEntityRepository\Query;
6
7			use Arp\DoctrineEntityRepository\Constant\QueryServiceOption;
8			use Arp\DoctrineEntityRepository\Query\Exception\QueryServiceException;
9			use Arp\Entity\EntityInterface;
10			use Doctrine\ORM\AbstractQuery;
11			use Doctrine\ORM\EntityManagerInterface;
12			use Doctrine\ORM\Query;
13			use Doctrine\ORM\QueryBuilder;
14			use Psr\Log\LoggerInterface;
15
16			/**
17			* @author Alex Patterson <[email protected]>
18			* @package Arp\DoctrineEntityRepository\Query
19			*/
20			class QueryService implements QueryServiceInterface
21			{
22			/**
23			* @var string
24			*/
25			protected string $entityName;
26
27			/**
28			* @var EntityManagerInterface
29			*/
30			protected EntityManagerInterface $entityManager;
31
32			/**
33			* @var LoggerInterface
34			*/
35			protected LoggerInterface $logger;
36
37			/**
38			* @param string $entityName
39			* @param EntityManagerInterface $entityManager
40			* @param LoggerInterface $logger
41			*/
42			public function __construct(string $entityName, EntityManagerInterface $entityManager, LoggerInterface $logger)
43			{
44			$this->entityName = $entityName;
45			$this->entityManager = $entityManager;
46			$this->logger = $logger;
47			}
48
49			/**
50			* @return string
51			*/
52			public function getEntityName(): string
53			{
54			return $this->entityName;
55			}
56
57			/**
58			* Return a new query builder instance.
59			*
60			* @param string\|null $alias The optional query builder alias.
61			*
62			* @return QueryBuilder
63			*/
64			public function createQueryBuilder(string $alias = null): QueryBuilder
65			{
66			$queryBuilder = $this->entityManager->createQueryBuilder();
67
68			if (null !== $alias) {
69			$queryBuilder->select($alias)->from($this->entityName, $alias);
70			}
71
72			return $queryBuilder;
73			}
74
75			/**
76			* @param AbstractQuery\|QueryBuilder $queryOrBuilder
77			* @param array<string, mixed> $options
78			*
79			* @return EntityInterface\|null\|array<mixed>
80			*
81			* @throws QueryServiceException
82			*/
83			public function getSingleResultOrNull($queryOrBuilder, array $options = [])
84			{
85			$result = $this->execute($queryOrBuilder, $options);
86
87			if (empty($result)) {
88			return null;
89			}
90
91			if (!is_array($result)) {
92			return $result;
93			}
94
95			if (count($result) > 1) {
96			return null;
97			}
98
99			return array_shift($result);
100			}
101
102			/**
103			* Construct and execute the query.
104			*
105			* @param AbstractQuery\|QueryBuilder\|mixed $queryOrBuilder
106			* @param array<string, mixed> $options
107			*
108			* @return mixed
109			*
110			* @throws QueryServiceException
111			*/
112			public function execute($queryOrBuilder, array $options = [])
113			{
114			if ($queryOrBuilder instanceof QueryBuilder) {
115			$this->prepareQueryBuilder($queryOrBuilder, $options);
116
117			$queryOrBuilder = $queryOrBuilder->getQuery();
118			}
119
120			if (!$queryOrBuilder instanceof AbstractQuery) {
121			throw new QueryServiceException(
122			sprintf(
123			'Query provided must be of type \'%s\'; \'%s\' provided in \'%s\'.',
124			AbstractQuery::class,
125			(is_object($queryOrBuilder) ? get_class($queryOrBuilder) : gettype($queryOrBuilder)),
126			__METHOD__
127			)
128			);
129			}
130
131			try {
132			$query = $this->prepareQuery($queryOrBuilder, $options);
133
134			return $query->execute();
135			} catch (\Throwable $e) {
136			$message = sprintf('Failed to execute query : %s', $e->getMessage());
137
138			$this->logger->error($message, ['exception' => $e]);
139
140			throw new QueryServiceException($message, $e->getCode(), $e);
141			}
142			}
143
144			/**
145			* Find a single entity matching the provided identity.
146			*
147			* @param mixed $id The identity of the entity to match.
148			* @param array<string, mixed> $options The optional query options.
149			*
150			* @return EntityInterface\|null
151			*
152			* @throws QueryServiceException
153			*/
154			public function findOneById($id, array $options = []): ?EntityInterface
155			{
156			return $this->findOne(compact('id'), $options);
157			}
158
159			/**
160			* Find a single entity matching the provided criteria.
161			*
162			* @param array<string, mixed> $criteria The search criteria that should be matched on.
163			* @param array<string, mixed> $options The optional query options.
164			*
165			* @return EntityInterface\|null
166			*
167			* @throws QueryServiceException
168			*/
169			public function findOne(array $criteria, array $options = []): ?EntityInterface
170			{
171			try {
172			$persist = $this->entityManager->getUnitOfWork()->getEntityPersister($this->entityName);
173
174			$entity = $persist->load(
175			$criteria,
176			$options[QueryServiceOption::ENTITY] ?? null,
177			$options[QueryServiceOption::ASSOCIATION] ?? null,
178			$options[QueryServiceOption::HINTS] ?? [],
179			$options[QueryServiceOption::LOCK_MODE] ?? null,
180			1,
181			$options[QueryServiceOption::ORDER_BY] ?? null
182			);
183
184			return ($entity instanceof EntityInterface) ? $entity : null;
185			} catch (\Throwable $e) {
186			$message = sprintf('Failed to execute \'findOne\' query: %s', $e->getMessage());
187
188			$this->logger->error($message, ['exception' => $e, 'criteria' => $criteria, 'options' => $options]);
189
190			throw new QueryServiceException($message, $e->getCode(), $e);
191			}
192			}
193
194			/**
195			* Find a collection of entities that match the provided criteria.
196			*
197			* @param array<string, mixed> $criteria The search criteria that should be matched on.
198			* @param array<string, mixed> $options The optional query options.
199			*
200			* @return iterable<EntityInterface>
201			*
202			* @throws QueryServiceException
203			*/
204			public function findMany(array $criteria, array $options = []): iterable
205			{
206			try {
207			$persister = $this->entityManager->getUnitOfWork()->getEntityPersister($this->entityName);
208
209			return $persister->loadAll(
210			$criteria,
211			$options[QueryServiceOption::ORDER_BY] ?? null,
212			$options[QueryServiceOption::LIMIT] ?? null,
213			$options[QueryServiceOption::OFFSET] ?? null
214			);
215			} catch (\Throwable $e) {
216			$message = sprintf('Failed to execute \'findMany\' query: %s', $e->getMessage());
217
218			$this->logger->error($message, ['exception' => $e, 'criteria' => $criteria, 'options' => $options]);
219
220			throw new QueryServiceException($message, $e->getCode(), $e);
221			}
222			}
223
224			/**
225			* Return the result set count.
226			*
227			* @param array<string, mixed> $criteria
228			*
229			* @return mixed
230			*/
231			public function count(array $criteria)
232			{
233			$unitOfWork = $this->entityManager->getUnitOfWork();
234
235			return $unitOfWork->getEntityPersister($this->entityName)->count($criteria);
236			}
237
238			/**
239			* Set the query builder options.
240			*
241			* @param QueryBuilder $queryBuilder The query builder to update.
242			* @param array<string, mixed> $options The query builder options to set.
243			*
244			* @return QueryBuilder
245			*/
246			protected function prepareQueryBuilder(QueryBuilder $queryBuilder, array $options = []): QueryBuilder
247			{
248			if (array_key_exists(QueryServiceOption::FIRST_RESULT, $options)) {
249			$queryBuilder->setFirstResult($options[QueryServiceOption::FIRST_RESULT]);
250			}
251
252			if (array_key_exists(QueryServiceOption::MAX_RESULTS, $options)) {
253			$queryBuilder->setMaxResults($options[QueryServiceOption::MAX_RESULTS]);
254			}
255
256			if (
257			array_key_exists(QueryServiceOption::ORDER_BY, $options)
258			&& is_array($options[QueryServiceOption::ORDER_BY])
259			) {
260			foreach ($options[QueryServiceOption::ORDER_BY] as $fieldName => $orderDirection) {
261			$queryBuilder->addOrderBy(
262			$fieldName,
263			('DESC' === strtoupper($orderDirection) ? 'DESC' : 'ASC')
264			);
265			}
266			}
267
268			return $queryBuilder;
269			}
270
271			/**
272			* Prepare the provided query by setting the $options.
273			*
274			* @param AbstractQuery $query
275			* @param array<string, mixed> $options
276			*
277			* @return AbstractQuery
278			*
279			* @SuppressWarnings(PHPMD.CyclomaticComplexity)
280			* @todo Reduce cyclomatic complexity
281			*/
282			protected function prepareQuery(AbstractQuery $query, array $options = []): AbstractQuery
283			{
284			if (array_key_exists('params', $options)) {
285			$query->setParameters($options['params']);
286			}
287
288			if (array_key_exists(QueryServiceOption::HYDRATION_MODE, $options)) {
289			$query->setHydrationMode($options[QueryServiceOption::HYDRATION_MODE]);
290			}
291
292			if (array_key_exists('result_set_mapping', $options)) {
293			$query->setResultSetMapping($options['result_set_mapping']);
294			}
295
296			if (isset($options[QueryServiceOption::HINTS]) && is_array($options[QueryServiceOption::HINTS])) {
297			foreach ($options[QueryServiceOption::HINTS] as $hint => $hintValue) {
298			$query->setHint($hint, $hintValue);
299			}
300			}
301
302			if (!empty($options[QueryServiceOption::DQL]) && $query instanceof Query) {
303			$query->setDQL($options[QueryServiceOption::DQL]);
304			}
305
306			return $query;
307			}
308			}
309

alex-patterson-webdev / doctrine-entity-repository

Pull Request — master (#8)

QueryService::findOne() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like