#27813

pending completion

Build # #27813

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/<a class="double-link" href="https://git"><a class=hub.com/api-platform/core/commit/<a class="double-link" href="https://git"><a class=hub.com/api-platform/core/commit/1bee33cd2119fbbe3e43cbf0fec613a121127218">1bee33cd2<a href="https://github.com/api-platform/core/commit/1bee33cd2119fbbe3e43cbf0fec613a121127218">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/api-platform/core/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/api-platform/core/commit/1bee33cd2119fbbe3e43cbf0fec613a121127218&quot;&gt;1bee33cd2&lt;/a&gt;&lt;a href=&quot;https://github.com/api-platform/core/commit/1bee33cd2119fbbe3e43cbf0fec613a121127218&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/api-platform/core/commit/1bee33cd2119fbbe3e43cbf0fec613a1&lt;/a&gt;21127218">&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/1e3b1f966e00ebd5f8838dabffa4a37f9851e326">1e3b1f966</a><a href="https://github.com/api-platform/core/commit/1bee33cd2119fbbe3e43cbf0fec613a121127218">&amp;quot;&amp;gt;1e3b1f966&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;1e3b1f966&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/api-platform/core/commit/1bee33cd2119fbbe3e43cbf0fec613a121127&lt;/a&gt;218&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/594e4bfa8">594e4bfa8">594e4bfa8</a>

Run Details

108 of 108 new or added lines in 5 files covered. (100.0%)

13432 of 16854 relevant lines covered (79.7%)

14.81 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.88

/src/Bridge/Doctrine/Orm/State/ItemProvider.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Bridge\Doctrine\Orm\State;

use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryItemExtensionInterface;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultItemExtensionInterface;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
use ApiPlatform\Exception\RuntimeException;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\State\ProviderInterface;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\QueryBuilder;
use Doctrine\Persistence\ManagerRegistry;
use Doctrine\Persistence\Mapping\ClassMetadata;

/**
 * Item state provider using the Doctrine ORM.
 *
 * @author Kévin Dunglas <kevin@dunglas.fr>
 * @author Samuel ROZE <samuel.roze@gmail.com>
 */
final class ItemProvider implements ProviderInterface
{
    private $resourceMetadataCollectionFactory;
    private $managerRegistry;
    private $itemExtensions;

    /**
     * @param QueryItemExtensionInterface[] $itemExtensions
     */
    public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, ManagerRegistry $managerRegistry, iterable $itemExtensions = [])
    {
        $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
        $this->managerRegistry = $managerRegistry;
        $this->itemExtensions = $itemExtensions;
    }

    public function provide(string $resourceClass, array $identifiers = [], ?string $operationName = null, array $context = [])
    {
        /** @var EntityManagerInterface $manager */
        $manager = $this->managerRegistry->getManagerForClass($resourceClass);

        $fetchData = $context['fetch_data'] ?? true;
        if (!$fetchData) {
            return $manager->getReference($resourceClass, $identifiers);
        }

        $repository = $manager->getRepository($resourceClass);
        if (!method_exists($repository, 'createQueryBuilder')) {
            throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');
        }

        $queryBuilder = $repository->createQueryBuilder('o');
        $queryNameGenerator = new QueryNameGenerator();
        $doctrineClassMetadata = $manager->getClassMetadata($resourceClass);

        $this->addWhereForIdentifiers($identifiers, $queryBuilder, $doctrineClassMetadata);

        foreach ($this->itemExtensions as $extension) {
            $extension->applyToItem($queryBuilder, $queryNameGenerator, $resourceClass, $identifiers, $operationName, $context);

            if ($extension instanceof QueryResultItemExtensionInterface && $extension->supportsResult($resourceClass, $operationName, $context)) {
                return $extension->getResult($queryBuilder, $resourceClass, $operationName, $context);
            }
        }

        return $queryBuilder->getQuery()->getOneOrNullResult();
    }

    public function supports(string $resourceClass, array $identifiers = [], ?string $operationName = null, array $context = []): bool
    {
        if (!$this->managerRegistry->getManagerForClass($resourceClass) instanceof EntityManagerInterface) {
            return false;
        }

        $operation = $context['operation'] ?? $this->resourceMetadataCollectionFactory->create($resourceClass)->getOperation($operationName);

        return !($operation->isCollection() ?? false);
    }

    /**
     * Add WHERE conditions to the query for one or more identifiers (simple or composite).
     */
    private function addWhereForIdentifiers(array $identifiers, QueryBuilder $queryBuilder, ClassMetadata $classMetadata)
    {
        $alias = $queryBuilder->getRootAliases()[0];
        foreach ($identifiers as $identifier => $value) {
            $placeholder = ':id_'.$identifier;
            $expression = $queryBuilder->expr()->eq(
                "{$alias}.{$identifier}",
                $placeholder
            );

            $queryBuilder->andWhere($expression);

            $queryBuilder->setParameter($placeholder, $value, $classMetadata->getTypeOfField($identifier));
        }
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Bridge\Doctrine\Orm\State;
15
16	use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryItemExtensionInterface;
17	use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultItemExtensionInterface;
18	use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
19	use ApiPlatform\Exception\RuntimeException;
20	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
21	use ApiPlatform\State\ProviderInterface;
22	use Doctrine\ORM\EntityManagerInterface;
23	use Doctrine\ORM\QueryBuilder;
24	use Doctrine\Persistence\ManagerRegistry;
25	use Doctrine\Persistence\Mapping\ClassMetadata;
26
27	/**
28	* Item state provider using the Doctrine ORM.
29	*
30	* @author Kévin Dunglas <kevin@dunglas.fr>
31	* @author Samuel ROZE <samuel.roze@gmail.com>
32	*/
33	final class ItemProvider implements ProviderInterface
34	{
35	private $resourceMetadataCollectionFactory;
36	private $managerRegistry;
37	private $itemExtensions;
38
39	/**
40	* @param QueryItemExtensionInterface[] $itemExtensions
41	*/
42	public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, ManagerRegistry $managerRegistry, iterable $itemExtensions = [])
43	{
44	$this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;	7✔
45	$this->managerRegistry = $managerRegistry;	7✔
46	$this->itemExtensions = $itemExtensions;	7✔
47	}	7✔
48
49	public function provide(string $resourceClass, array $identifiers = [], ?string $operationName = null, array $context = [])
50	{
51	/** @var EntityManagerInterface $manager */
52	$manager = $this->managerRegistry->getManagerForClass($resourceClass);	4✔
53
54	$fetchData = $context['fetch_data'] ?? true;	4✔
55	if (!$fetchData) {	4✔
56	return $manager->getReference($resourceClass, $identifiers);	×
57	}
58
59	$repository = $manager->getRepository($resourceClass);	4✔
60	if (!method_exists($repository, 'createQueryBuilder')) {	4✔
61	throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');	1✔
62	}
63
64	$queryBuilder = $repository->createQueryBuilder('o');	3✔
65	$queryNameGenerator = new QueryNameGenerator();	3✔
66	$doctrineClassMetadata = $manager->getClassMetadata($resourceClass);	3✔
67
68	$this->addWhereForIdentifiers($identifiers, $queryBuilder, $doctrineClassMetadata);	3✔
69
70	foreach ($this->itemExtensions as $extension) {	3✔
71	$extension->applyToItem($queryBuilder, $queryNameGenerator, $resourceClass, $identifiers, $operationName, $context);	3✔
72
73	if ($extension instanceof QueryResultItemExtensionInterface && $extension->supportsResult($resourceClass, $operationName, $context)) {	3✔
74	return $extension->getResult($queryBuilder, $resourceClass, $operationName, $context);	1✔
75	}
76	}
77
78	return $queryBuilder->getQuery()->getOneOrNullResult();	2✔
79	}
80
81	public function supports(string $resourceClass, array $identifiers = [], ?string $operationName = null, array $context = []): bool
82	{
83	if (!$this->managerRegistry->getManagerForClass($resourceClass) instanceof EntityManagerInterface) {	3✔
84	return false;	1✔
85	}
86
87	$operation = $context['operation'] ?? $this->resourceMetadataCollectionFactory->create($resourceClass)->getOperation($operationName);	2✔
88
89	return !($operation->isCollection() ?? false);	2✔
90	}
91
92	/**
93	* Add WHERE conditions to the query for one or more identifiers (simple or composite).
94	*/
95	private function addWhereForIdentifiers(array $identifiers, QueryBuilder $queryBuilder, ClassMetadata $classMetadata)
96	{
97	$alias = $queryBuilder->getRootAliases()[0];	3✔
98	foreach ($identifiers as $identifier => $value) {	3✔
99	$placeholder = ':id_'.$identifier;	3✔
100	$expression = $queryBuilder->expr()->eq(	3✔
101	"{$alias}.{$identifier}",	3✔
102	$placeholder
103	);
104
105	$queryBuilder->andWhere($expression);	3✔
106
107	$queryBuilder->setParameter($placeholder, $value, $classMetadata->getTypeOfField($identifier));	3✔
108	}
109	}	3✔
110	}

api-platform / core / #27813

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous