15133993414

Committed 20 May 2025 09:30AM UTC coverage: 26.313% (-1.2%) from 27.493%

Build # 15133993414

Build Type

Pull #7161

github

Committed by

web-flow

Commit Message

Merge e2c03d45f into 5459ba375

Pull Request Pull Request #7161: fix(metadata): infer parameter string type from schema

Run Details

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

11019 existing lines in 363 files now uncovered.

12898 of 49018 relevant lines covered (26.31%)

34.33 hits per line

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

32.56

/src/Doctrine/Orm/State/LinksHandlerTrait.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\Doctrine\Orm\State;

use ApiPlatform\Doctrine\Common\State\LinksHandlerTrait as CommonLinksHandlerTrait;
use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
use ApiPlatform\Metadata\Link;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\State\Util\StateOptionsTrait;
use Doctrine\ORM\Mapping\ClassMetadata;
use Doctrine\ORM\QueryBuilder;
use Doctrine\Persistence\ManagerRegistry;

/**
 * @internal
 */
trait LinksHandlerTrait
{
    use CommonLinksHandlerTrait;
    use StateOptionsTrait;

    private ManagerRegistry $managerRegistry;

    private function handleLinks(QueryBuilder $queryBuilder, array $identifiers, QueryNameGeneratorInterface $queryNameGenerator, array $context, string $entityClass, Operation $operation): void
    {
        if (!$identifiers) {
            return;
        }

        $manager = $this->managerRegistry->getManagerForClass($entityClass);
        $doctrineClassMetadata = $manager->getClassMetadata($entityClass);
        $alias = $queryBuilder->getRootAliases()[0];

        $links = $this->getLinks($entityClass, $operation, $context);

        if (!$links) {
            return;
        }

        $previousAlias = $alias;
        $previousJoinProperties = $doctrineClassMetadata->getIdentifierFieldNames();
        $expressions = [];
        $identifiers = array_reverse($identifiers);

        foreach (array_reverse($links) as $link) {
            if (null !== $link->getExpandedValue() || !$link->getFromClass()) {
                continue;
            }

            $fromClass = $link->getFromClass();
            if (!$this->managerRegistry->getManagerForClass($fromClass)) {
                $fromClass = $this->getLinkFromClass($link, $operation);
            }

            $fromClassMetadata = $manager->getClassMetadata($fromClass);
            $identifierProperties = $link->getIdentifiers();
            $hasCompositeIdentifiers = 1 < \count($identifierProperties);

            if (!$link->getFromProperty() && !$link->getToProperty()) {
                $currentAlias = $fromClass === $entityClass ? $alias : $queryNameGenerator->generateJoinAlias($alias);

                foreach ($identifierProperties as $identifierProperty) {
                    $placeholder = $queryNameGenerator->generateParameterName($identifierProperty);
                    $queryBuilder->andWhere("$currentAlias.$identifierProperty = :$placeholder");
                    $queryBuilder->setParameter($placeholder, $this->getIdentifierValue($identifiers, $hasCompositeIdentifiers ? $identifierProperty : null), $fromClassMetadata->getTypeOfField($identifierProperty));
                }

                $previousAlias = $currentAlias;
                $previousJoinProperties = $fromClassMetadata->getIdentifierFieldNames();
                continue;
            }

            $joinProperties = $doctrineClassMetadata->getIdentifierFieldNames();

            if ($link->getFromProperty() && !$link->getToProperty()) {
                $joinAlias = $queryNameGenerator->generateJoinAlias('m');
                $associationMapping = $fromClassMetadata->getAssociationMapping($link->getFromProperty()); // @phpstan-ignore-line
                $relationType = $associationMapping['type'];

                if ($relationType & ClassMetadata::TO_MANY) {
                    $nextAlias = $queryNameGenerator->generateJoinAlias($alias);
                    $whereClause = [];
                    foreach ($identifierProperties as $identifierProperty) {
                        $placeholder = $queryNameGenerator->generateParameterName($identifierProperty);
                        $whereClause[] = "$nextAlias.{$identifierProperty} = :$placeholder";
                        $queryBuilder->setParameter($placeholder, $this->getIdentifierValue($identifiers, $hasCompositeIdentifiers ? $identifierProperty : null), $fromClassMetadata->getTypeOfField($identifierProperty));
                    }

                    $property = $associationMapping['mappedBy'] ?? $joinProperties[0];
                    $select = isset($associationMapping['mappedBy']) ? "IDENTITY($joinAlias.$property)" : "$joinAlias.$property";
                    $expressions["$previousAlias.{$property}"] = "SELECT $select FROM {$fromClass} $nextAlias INNER JOIN $nextAlias.{$associationMapping['fieldName']} $joinAlias WHERE ".implode(' AND ', $whereClause);
                    $previousAlias = $nextAlias;
                    continue;
                }

                // A single-valued association path expression to an inverse side is not supported in DQL queries.
                if ($relationType & ClassMetadata::TO_ONE && !($associationMapping['isOwningSide'] ?? true)) {
                    $queryBuilder->innerJoin("$previousAlias.".$associationMapping['mappedBy'], $joinAlias);
                } else {
                    $queryBuilder->join(
                        $fromClass,
                        $joinAlias,
                        'WITH',
                        "$previousAlias.{$previousJoinProperties[0]} = $joinAlias.{$associationMapping['fieldName']}"
                    );
                }

                foreach ($identifierProperties as $identifierProperty) {
                    $placeholder = $queryNameGenerator->generateParameterName($identifierProperty);
                    $queryBuilder->andWhere("$joinAlias.$identifierProperty = :$placeholder");
                    $queryBuilder->setParameter($placeholder, $this->getIdentifierValue($identifiers, $hasCompositeIdentifiers ? $identifierProperty : null), $fromClassMetadata->getTypeOfField($identifierProperty));
                }

                $previousAlias = $joinAlias;
                $previousJoinProperties = $joinProperties;
                continue;
            }

            $joinAlias = $queryNameGenerator->generateJoinAlias($alias);
            $queryBuilder->join("{$previousAlias}.{$link->getToProperty()}", $joinAlias);

            foreach ($identifierProperties as $identifierProperty) {
                $placeholder = $queryNameGenerator->generateParameterName($identifierProperty);
                $queryBuilder->andWhere("$joinAlias.$identifierProperty = :$placeholder");
                $queryBuilder->setParameter($placeholder, $this->getIdentifierValue($identifiers, $hasCompositeIdentifiers ? $identifierProperty : null), $fromClassMetadata->getTypeOfField($identifierProperty));
            }

            $previousAlias = $joinAlias;
            $previousJoinProperties = $joinProperties;
        }

        if ($expressions) {
            $i = 0;
            $clause = '';
            foreach ($expressions as $alias => $expression) {
                if (0 === $i) {
                    $clause .= "$alias IN (".$expression;
                    ++$i;
                    continue;
                }

                $clause .= " AND $alias IN (".$expression;
                ++$i;
            }

            $queryBuilder->andWhere($clause.str_repeat(')', $i));
        }
    }

    private function getLinkFromClass(Link $link, Operation $operation): string
    {
        $fromClass = $link->getFromClass();
        if ($fromClass === $operation->getClass() && $entityClass = $this->getStateOptionsClass($operation, $operation->getClass(), Options::class)) {
            return $entityClass;
        }

        $operation = $this->resourceMetadataCollectionFactory->create($fromClass)->getOperation();

        return $this->getStateOptionsClass($operation, $operation->getClass(), Options::class);
    }
}

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\Doctrine\Orm\State;
15
16	use ApiPlatform\Doctrine\Common\State\LinksHandlerTrait as CommonLinksHandlerTrait;
17	use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
18	use ApiPlatform\Metadata\Link;
19	use ApiPlatform\Metadata\Operation;
20	use ApiPlatform\State\Util\StateOptionsTrait;
21	use Doctrine\ORM\Mapping\ClassMetadata;
22	use Doctrine\ORM\QueryBuilder;
23	use Doctrine\Persistence\ManagerRegistry;
24
25	/**
26	* @internal
27	*/
28	trait LinksHandlerTrait
29	{
30	use CommonLinksHandlerTrait;
31	use StateOptionsTrait;
32
33	private ManagerRegistry $managerRegistry;
34
35	private function handleLinks(QueryBuilder $queryBuilder, array $identifiers, QueryNameGeneratorInterface $queryNameGenerator, array $context, string $entityClass, Operation $operation): void
36	{
UNCOV 37	if (!$identifiers) {	115✔
UNCOV 38	return;	103✔
39	}
40
UNCOV 41	$manager = $this->managerRegistry->getManagerForClass($entityClass);	19✔
UNCOV 42	$doctrineClassMetadata = $manager->getClassMetadata($entityClass);	19✔
UNCOV 43	$alias = $queryBuilder->getRootAliases()[0];	19✔
44
UNCOV 45	$links = $this->getLinks($entityClass, $operation, $context);	19✔
46
UNCOV 47	if (!$links) {	19✔
48	return;	×
49	}
50
UNCOV 51	$previousAlias = $alias;	19✔
UNCOV 52	$previousJoinProperties = $doctrineClassMetadata->getIdentifierFieldNames();	19✔
UNCOV 53	$expressions = [];	19✔
UNCOV 54	$identifiers = array_reverse($identifiers);	19✔
55
UNCOV 56	foreach (array_reverse($links) as $link) {	19✔
UNCOV 57	if (null !== $link->getExpandedValue() \|\| !$link->getFromClass()) {	19✔
58	continue;	×
59	}
60
UNCOV 61	$fromClass = $link->getFromClass();	19✔
UNCOV 62	if (!$this->managerRegistry->getManagerForClass($fromClass)) {	19✔
63	$fromClass = $this->getLinkFromClass($link, $operation);	×
64	}
65
UNCOV 66	$fromClassMetadata = $manager->getClassMetadata($fromClass);	19✔
UNCOV 67	$identifierProperties = $link->getIdentifiers();	19✔
UNCOV 68	$hasCompositeIdentifiers = 1 < \count($identifierProperties);	19✔
69
UNCOV 70	if (!$link->getFromProperty() && !$link->getToProperty()) {	19✔
UNCOV 71	$currentAlias = $fromClass === $entityClass ? $alias : $queryNameGenerator->generateJoinAlias($alias);	19✔
72
UNCOV 73	foreach ($identifierProperties as $identifierProperty) {	19✔
UNCOV 74	$placeholder = $queryNameGenerator->generateParameterName($identifierProperty);	19✔
UNCOV 75	$queryBuilder->andWhere("$currentAlias.$identifierProperty = :$placeholder");	19✔
UNCOV 76	$queryBuilder->setParameter($placeholder, $this->getIdentifierValue($identifiers, $hasCompositeIdentifiers ? $identifierProperty : null), $fromClassMetadata->getTypeOfField($identifierProperty));	19✔
77	}
78
UNCOV 79	$previousAlias = $currentAlias;	19✔
UNCOV 80	$previousJoinProperties = $fromClassMetadata->getIdentifierFieldNames();	19✔
UNCOV 81	continue;	19✔
82	}
83
84	$joinProperties = $doctrineClassMetadata->getIdentifierFieldNames();	×
85
86	if ($link->getFromProperty() && !$link->getToProperty()) {	×
87	$joinAlias = $queryNameGenerator->generateJoinAlias('m');	×
88	$associationMapping = $fromClassMetadata->getAssociationMapping($link->getFromProperty()); // @phpstan-ignore-line	×
89	$relationType = $associationMapping['type'];	×
90
91	if ($relationType & ClassMetadata::TO_MANY) {	×
92	$nextAlias = $queryNameGenerator->generateJoinAlias($alias);	×
93	$whereClause = [];	×
94	foreach ($identifierProperties as $identifierProperty) {	×
95	$placeholder = $queryNameGenerator->generateParameterName($identifierProperty);	×
96	$whereClause[] = "$nextAlias.{$identifierProperty} = :$placeholder";	×
97	$queryBuilder->setParameter($placeholder, $this->getIdentifierValue($identifiers, $hasCompositeIdentifiers ? $identifierProperty : null), $fromClassMetadata->getTypeOfField($identifierProperty));	×
98	}
99
100	$property = $associationMapping['mappedBy'] ?? $joinProperties[0];	×
101	$select = isset($associationMapping['mappedBy']) ? "IDENTITY($joinAlias.$property)" : "$joinAlias.$property";	×
102	$expressions["$previousAlias.{$property}"] = "SELECT $select FROM {$fromClass} $nextAlias INNER JOIN $nextAlias.{$associationMapping['fieldName']} $joinAlias WHERE ".implode(' AND ', $whereClause);	×
103	$previousAlias = $nextAlias;	×
104	continue;	×
105	}
106
107	// A single-valued association path expression to an inverse side is not supported in DQL queries.
108	if ($relationType & ClassMetadata::TO_ONE && !($associationMapping['isOwningSide'] ?? true)) {	×
109	$queryBuilder->innerJoin("$previousAlias.".$associationMapping['mappedBy'], $joinAlias);	×
110	} else {
111	$queryBuilder->join(	×
112	$fromClass,	×
113	$joinAlias,	×
114	'WITH',	×
115	"$previousAlias.{$previousJoinProperties[0]} = $joinAlias.{$associationMapping['fieldName']}"	×
116	);	×
117	}
118
119	foreach ($identifierProperties as $identifierProperty) {	×
120	$placeholder = $queryNameGenerator->generateParameterName($identifierProperty);	×
121	$queryBuilder->andWhere("$joinAlias.$identifierProperty = :$placeholder");	×
122	$queryBuilder->setParameter($placeholder, $this->getIdentifierValue($identifiers, $hasCompositeIdentifiers ? $identifierProperty : null), $fromClassMetadata->getTypeOfField($identifierProperty));	×
123	}
124
125	$previousAlias = $joinAlias;	×
126	$previousJoinProperties = $joinProperties;	×
127	continue;	×
128	}
129
130	$joinAlias = $queryNameGenerator->generateJoinAlias($alias);	×
131	$queryBuilder->join("{$previousAlias}.{$link->getToProperty()}", $joinAlias);	×
132
133	foreach ($identifierProperties as $identifierProperty) {	×
134	$placeholder = $queryNameGenerator->generateParameterName($identifierProperty);	×
135	$queryBuilder->andWhere("$joinAlias.$identifierProperty = :$placeholder");	×
136	$queryBuilder->setParameter($placeholder, $this->getIdentifierValue($identifiers, $hasCompositeIdentifiers ? $identifierProperty : null), $fromClassMetadata->getTypeOfField($identifierProperty));	×
137	}
138
139	$previousAlias = $joinAlias;	×
140	$previousJoinProperties = $joinProperties;	×
141	}
142
UNCOV 143	if ($expressions) {	19✔
144	$i = 0;	×
145	$clause = '';	×
146	foreach ($expressions as $alias => $expression) {	×
147	if (0 === $i) {	×
148	$clause .= "$alias IN (".$expression;	×
149	++$i;	×
150	continue;	×
151	}
152
153	$clause .= " AND $alias IN (".$expression;	×
154	++$i;	×
155	}
156
157	$queryBuilder->andWhere($clause.str_repeat(')', $i));	×
158	}
159	}
160
161	private function getLinkFromClass(Link $link, Operation $operation): string
162	{
163	$fromClass = $link->getFromClass();	×
164	if ($fromClass === $operation->getClass() && $entityClass = $this->getStateOptionsClass($operation, $operation->getClass(), Options::class)) {	×
165	return $entityClass;	×
166	}
167
168	$operation = $this->resourceMetadataCollectionFactory->create($fromClass)->getOperation();	×
169
170	return $this->getStateOptionsClass($operation, $operation->getClass(), Options::class);	×
171	}
172	}

api-platform / core / 15133993414

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