#26365

pending completion

Build # #26365

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/5d117b91fad001f9fbcbe836f0dd74002a576245">5d117b91f<a href="https://github.com/api-platform/core/commit/5d117b91fad001f9fbcbe836f0dd74002a576245">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/5aa84f7c2a43be46a896b0fb2cbd36e159ddd55f">5aa84f7c2</a>">5aa84f7c2</a><a href="https://github.com/api-platform/core/commit/5d117b91fad001f9fbcbe836f0dd74002a576245"> into 6682c1880">6682c1880</a>

Run Details

12 of 12 new or added lines in 3 files covered. (100.0%)

9453 of 11414 relevant lines covered (82.82%)

14.84 hits per line

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

94.44

/src/Bridge/Doctrine/Orm/ItemDataProvider.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\Core\Bridge\Doctrine\Orm;

use ApiPlatform\Core\Bridge\Doctrine\Common\Util\IdentifierManagerTrait;
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\Core\DataProvider\DenormalizedIdentifiersAwareItemDataProviderInterface;
use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
use ApiPlatform\Core\Exception\RuntimeException;
use ApiPlatform\Core\Identifier\IdentifierConverterInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\QueryBuilder;
use Doctrine\Persistence\ManagerRegistry;
use Doctrine\Persistence\Mapping\ClassMetadata;

/**
 * Item data provider for the Doctrine ORM.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 * @author Samuel ROZE <samuel.roze@gmail.com>
 * @final
 */
class ItemDataProvider implements DenormalizedIdentifiersAwareItemDataProviderInterface, RestrictedDataProviderInterface
{
    use IdentifierManagerTrait;

    private $managerRegistry;
    private $itemExtensions;

    /**
     * @param QueryItemExtensionInterface[] $itemExtensions
     */
    public function __construct(ManagerRegistry $managerRegistry, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, iterable $itemExtensions = [], ResourceMetadataFactoryInterface $resourceMetadataFactory = null)
    {
        $this->managerRegistry = $managerRegistry;
        $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
        $this->propertyMetadataFactory = $propertyMetadataFactory;
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->itemExtensions = $itemExtensions;
    }

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

    /**
     * {@inheritdoc}
     *
     * The context may contain a `fetch_data` key representing whether the value should be fetched by Doctrine or if we should return a reference.
     *
     * @throws RuntimeException
     */
    public function getItem(string $resourceClass, $id, string $operationName = null, array $context = [])
    {
        /** @var EntityManagerInterface $manager */
        $manager = $this->managerRegistry->getManagerForClass($resourceClass);

        if ((\is_int($id) || \is_string($id)) && !($context[IdentifierConverterInterface::HAS_IDENTIFIER_CONVERTER] ?? false)) {
            $id = $this->normalizeIdentifiers($id, $manager, $resourceClass);
        }
        if (!\is_array($id)) {
            throw new \InvalidArgumentException(sprintf('$id must be array when "%s" key is set to true in the $context', IdentifierConverterInterface::HAS_IDENTIFIER_CONVERTER));
        }
        $identifiers = $id;

        $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();
    }

    /**
     * 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\Core\Bridge\Doctrine\Orm;
15
16	use ApiPlatform\Core\Bridge\Doctrine\Common\Util\IdentifierManagerTrait;
17	use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryItemExtensionInterface;
18	use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultItemExtensionInterface;
19	use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
20	use ApiPlatform\Core\DataProvider\DenormalizedIdentifiersAwareItemDataProviderInterface;
21	use ApiPlatform\Core\DataProvider\RestrictedDataProviderInterface;
22	use ApiPlatform\Core\Exception\RuntimeException;
23	use ApiPlatform\Core\Identifier\IdentifierConverterInterface;
24	use ApiPlatform\Core\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
25	use ApiPlatform\Core\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
26	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
27	use Doctrine\ORM\EntityManagerInterface;
28	use Doctrine\ORM\QueryBuilder;
29	use Doctrine\Persistence\ManagerRegistry;
30	use Doctrine\Persistence\Mapping\ClassMetadata;
31
32	/**
33	* Item data provider for the Doctrine ORM.
34	*
35	* @author Kévin Dunglas <dunglas@gmail.com>
36	* @author Samuel ROZE <samuel.roze@gmail.com>
37	* @final
38	*/
39	class ItemDataProvider implements DenormalizedIdentifiersAwareItemDataProviderInterface, RestrictedDataProviderInterface
40	{
41	use IdentifierManagerTrait;
42
43	private $managerRegistry;
44	private $itemExtensions;
45
46	/**
47	* @param QueryItemExtensionInterface[] $itemExtensions
48	*/
49	public function __construct(ManagerRegistry $managerRegistry, PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, iterable $itemExtensions = [], ResourceMetadataFactoryInterface $resourceMetadataFactory = null)
50	{
51	$this->managerRegistry = $managerRegistry;	8✔
52	$this->propertyNameCollectionFactory = $propertyNameCollectionFactory;	8✔
53	$this->propertyMetadataFactory = $propertyMetadataFactory;	8✔
54	$this->resourceMetadataFactory = $resourceMetadataFactory;	8✔
55	$this->itemExtensions = $itemExtensions;	8✔
56	}	8✔
57
58	public function supports(string $resourceClass, string $operationName = null, array $context = []): bool
59	{
60	return $this->managerRegistry->getManagerForClass($resourceClass) instanceof EntityManagerInterface;	2✔
61	}
62
63	/**
64	* {@inheritdoc}
65	*
66	* The context may contain a `fetch_data` key representing whether the value should be fetched by Doctrine or if we should return a reference.
67	*
68	* @throws RuntimeException
69	*/
70	public function getItem(string $resourceClass, $id, string $operationName = null, array $context = [])
71	{
72	/** @var EntityManagerInterface $manager */
73	$manager = $this->managerRegistry->getManagerForClass($resourceClass);	6✔
74
75	if ((\is_int($id) \|\| \is_string($id)) && !($context[IdentifierConverterInterface::HAS_IDENTIFIER_CONVERTER] ?? false)) {	6✔
76	$id = $this->normalizeIdentifiers($id, $manager, $resourceClass);	1✔
77	}
78	if (!\is_array($id)) {	5✔
79	throw new \InvalidArgumentException(sprintf('$id must be array when "%s" key is set to true in the $context', IdentifierConverterInterface::HAS_IDENTIFIER_CONVERTER));	×
80	}
81	$identifiers = $id;	5✔
82
83	$fetchData = $context['fetch_data'] ?? true;	5✔
84	if (!$fetchData) {	5✔
85	return $manager->getReference($resourceClass, $identifiers);	×
86	}
87
88	$repository = $manager->getRepository($resourceClass);	5✔
89	if (!method_exists($repository, 'createQueryBuilder')) {	5✔
90	throw new RuntimeException('The repository class must have a "createQueryBuilder" method.');	1✔
91	}
92
93	$queryBuilder = $repository->createQueryBuilder('o');	4✔
94	$queryNameGenerator = new QueryNameGenerator();	4✔
95	$doctrineClassMetadata = $manager->getClassMetadata($resourceClass);	4✔
96
97	$this->addWhereForIdentifiers($identifiers, $queryBuilder, $doctrineClassMetadata);	4✔
98
99	foreach ($this->itemExtensions as $extension) {	4✔
100	$extension->applyToItem($queryBuilder, $queryNameGenerator, $resourceClass, $identifiers, $operationName, $context);	4✔
101
102	if ($extension instanceof QueryResultItemExtensionInterface && $extension->supportsResult($resourceClass, $operationName, $context)) {	4✔
103	return $extension->getResult($queryBuilder, $resourceClass, $operationName, $context);	1✔
104	}
105	}
106
107	return $queryBuilder->getQuery()->getOneOrNullResult();	3✔
108	}
109
110	/**
111	* Add WHERE conditions to the query for one or more identifiers (simple or composite).
112	*/
113	private function addWhereForIdentifiers(array $identifiers, QueryBuilder $queryBuilder, ClassMetadata $classMetadata)
114	{
115	$alias = $queryBuilder->getRootAliases()[0];	4✔
116	foreach ($identifiers as $identifier => $value) {	4✔
117	$placeholder = ':id_'.$identifier;	4✔
118	$expression = $queryBuilder->expr()->eq(	4✔
119	"{$alias}.{$identifier}",	4✔
120	$placeholder
121	);
122
123	$queryBuilder->andWhere($expression);	4✔
124
125	$queryBuilder->setParameter($placeholder, $value, $classMetadata->getTypeOfField($identifier));	4✔
126	}
127	}	4✔
128	}

api-platform / core / #26365

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