13897184482

Committed 17 Mar 2025 10:29AM UTC coverage: 17.371% (+8.6%) from 8.768%

Build # 13897184482

Build Type

Pull #7027

github

Committed by

web-flow

Commit Message

Merge 6b496c593 into ba5cea729

Pull Request Pull Request #7027: fix(laravel): json api default parameters

Run Details

0 of 18 new or added lines in 2 files covered. (0.0%)

545 existing lines in 58 files now uncovered.

4729 of 27224 relevant lines covered (17.37%)

78.16 hits per line

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

30.77

/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 Doctrine\ORM\Mapping\ClassMetadata;
use Doctrine\ORM\QueryBuilder;
use Doctrine\Persistence\ManagerRegistry;

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

    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->getStateOptionsEntityClass($operation)) {
            return $entityClass;
        }

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

        if ($entityClass = $this->getStateOptionsEntityClass($operation)) {
            return $entityClass;
        }

        throw new \Exception('Can not found a doctrine class for this link.');
    }

    private function getStateOptionsEntityClass(Operation $operation): ?string
    {
        if (($options = $operation->getStateOptions()) && $options instanceof Options && $entityClass = $options->getEntityClass()) {
            return $entityClass;
        }

        return null;
    }
}

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

api-platform / core / 13897184482

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