#27141

pending completion

Build # #27141

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/c58d17be1d580bcec91755cd9b4c21ef2bd95578">c58d17be1<a href="https://github.com/api-platform/core/commit/c58d17be1d580bcec91755cd9b4c21ef2bd95578">">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/46816918590e2c86d5533049ea8684f20be432f3">468169185</a>">468169185</a><a href="https://github.com/api-platform/core/commit/c58d17be1d580bcec91755cd9b4c21ef2bd95578"> into b5fe96f95">b5fe96f95</a>

Run Details

2 of 2 new or added lines in 1 file covered. (100.0%)

9716 of 11641 relevant lines covered (83.46%)

14.66 hits per line

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

94.29

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

api-platform / core / #27141

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