18089937549

Committed 29 Sep 2025 07:56AM UTC coverage: 21.764% (-0.3%) from 22.093%

Build # 18089937549

Build Type

Pull #7416

github

Committed by

web-flow

Commit Message

Merge 061bcc790 into abe0438be

Pull Request Pull Request #7416: fix(laravel): serializer attributes on Eloquent methods

Run Details

0 of 151 new or added lines in 11 files covered. (0.0%)

5028 existing lines in 173 files now uncovered.

11889 of 54626 relevant lines covered (21.76%)

25.32 hits per line

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

80.85

/src/State/ParameterProvider/ReadLinkParameterProvider.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\State\ParameterProvider;

use ApiPlatform\Metadata\GraphQl\Operation as GraphQlOperation;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\Link;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Parameter;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\State\Exception\ProviderNotFoundException;
use ApiPlatform\State\ParameterProviderInterface;
use ApiPlatform\State\ProviderInterface;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

/**
 * Checks if the linked resources have security attributes and prepares them for access checking.
 *
 * @experimental
 */
final class ReadLinkParameterProvider implements ParameterProviderInterface
{
    /**
     * @param ProviderInterface<object> $locator
     */
    public function __construct(
        private readonly ProviderInterface $locator,
        private readonly ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory,
    ) {
    }

    public function provide(Parameter $parameter, array $parameters = [], array $context = []): ?Operation
    {
        $operation = $context['operation'];
        $extraProperties = $parameter->getExtraProperties();

        if ($parameter instanceof Link) {
            $linkClass = $parameter->getFromClass() ?? $parameter->getToClass();
            $securityObjectName = $parameter->getSecurityObjectName() ?? $parameter->getToProperty() ?? $parameter->getFromProperty();
        }

        $securityObjectName ??= $parameter->getKey();

        $linkClass ??= $extraProperties['resource_class'] ?? $operation->getClass();

        if (!$linkClass) {
            return $operation;
        }

        $linkOperation = $this->resourceMetadataCollectionFactory
            ->create($linkClass)
            ->getOperation($operation->getExtraProperties()['parent_uri_template'] ?? $extraProperties['uri_template'] ?? null);

        $value = $parameter->getValue();

        if (\is_array($value) && array_is_list($value)) {
            $relation = [];

            foreach ($value as $v) {
                try {
                    $relation[] = $this->locator->provide($linkOperation, $this->getUriVariables($v, $parameter, $linkOperation), $context);
                } catch (ProviderNotFoundException) {
                }
            }
        } else {
            try {
                $relation = $this->locator->provide($linkOperation, $this->getUriVariables($value, $parameter, $linkOperation), $context);
            } catch (ProviderNotFoundException) {
                $relation = null;
            }
        }

        $parameter->setValue($relation);

        if (null === $relation && true === ($extraProperties['throw_not_found'] ?? true)) {
            throw new NotFoundHttpException('Relation for link security not found.');
        }

        $context['request']?->attributes->set($securityObjectName, $relation);

        if ($parameter instanceof Link) {
            $uriVariables = $operation->getUriVariables();
            $uriVariables[$parameter->getKey()] = $parameter;
            $operation = $operation->withUriVariables($uriVariables);
        }

        return $operation;
    }

    /**
     * @return array<string, string>
     */
    private function getUriVariables(mixed $value, Parameter $parameter, Operation $operation): array
    {
        $extraProperties = $parameter->getExtraProperties();

        if ($operation instanceof HttpOperation) {
            $links = $operation->getUriVariables();
        } elseif ($operation instanceof GraphQlOperation) {
            $links = $operation->getLinks();
        } else {
            $links = [];
        }

        if (!\is_array($value)) {
            $uriVariables = [];

            foreach ($links as $key => $link) {
                if (!\is_string($key)) {
                    $key = $link->getParameterName() ?? $extraProperties['uri_variable'] ?? $link->getFromProperty();
                }

                if (!$key || !\is_string($key)) {
                    continue;
                }

                $uriVariables[$key] = $value;
            }

            return $uriVariables;
        }

        return $value;
    }
}

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\State\ParameterProvider;
15
16	use ApiPlatform\Metadata\GraphQl\Operation as GraphQlOperation;
17	use ApiPlatform\Metadata\HttpOperation;
18	use ApiPlatform\Metadata\Link;
19	use ApiPlatform\Metadata\Operation;
20	use ApiPlatform\Metadata\Parameter;
21	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
22	use ApiPlatform\State\Exception\ProviderNotFoundException;
23	use ApiPlatform\State\ParameterProviderInterface;
24	use ApiPlatform\State\ProviderInterface;
25	use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
26
27	/**
28	* Checks if the linked resources have security attributes and prepares them for access checking.
29	*
30	* @experimental
31	*/
32	final class ReadLinkParameterProvider implements ParameterProviderInterface
33	{
34	/**
35	* @param ProviderInterface<object> $locator
36	*/
37	public function __construct(
38	private readonly ProviderInterface $locator,
39	private readonly ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory,
40	) {
41	}	14✔
42
43	public function provide(Parameter $parameter, array $parameters = [], array $context = []): ?Operation
44	{
45	$operation = $context['operation'];	14✔
46	$extraProperties = $parameter->getExtraProperties();	14✔
47
48	if ($parameter instanceof Link) {	14✔
49	$linkClass = $parameter->getFromClass() ?? $parameter->getToClass();	6✔
50	$securityObjectName = $parameter->getSecurityObjectName() ?? $parameter->getToProperty() ?? $parameter->getFromProperty();	6✔
51	}
52
53	$securityObjectName ??= $parameter->getKey();	14✔
54
55	$linkClass ??= $extraProperties['resource_class'] ?? $operation->getClass();	14✔
56
57	if (!$linkClass) {	14✔
58	return $operation;	×
59	}
60
61	$linkOperation = $this->resourceMetadataCollectionFactory	14✔
62	->create($linkClass)	14✔
63	->getOperation($operation->getExtraProperties()['parent_uri_template'] ?? $extraProperties['uri_template'] ?? null);	14✔
64
65	$value = $parameter->getValue();	14✔
66
67	if (\is_array($value) && array_is_list($value)) {	14✔
68	$relation = [];	2✔
69
70	foreach ($value as $v) {	2✔
71	try {
72	$relation[] = $this->locator->provide($linkOperation, $this->getUriVariables($v, $parameter, $linkOperation), $context);	2✔
73	} catch (ProviderNotFoundException) {	×
74	}
75	}
76	} else {
77	try {
78	$relation = $this->locator->provide($linkOperation, $this->getUriVariables($value, $parameter, $linkOperation), $context);	12✔
79	} catch (ProviderNotFoundException) {	×
80	$relation = null;	×
81	}
82	}
83
84	$parameter->setValue($relation);	14✔
85
86	if (null === $relation && true === ($extraProperties['throw_not_found'] ?? true)) {	14✔
87	throw new NotFoundHttpException('Relation for link security not found.');	2✔
88	}
89
90	$context['request']?->attributes->set($securityObjectName, $relation);	12✔
91
92	if ($parameter instanceof Link) {	12✔
93	$uriVariables = $operation->getUriVariables();	6✔
94	$uriVariables[$parameter->getKey()] = $parameter;	6✔
95	$operation = $operation->withUriVariables($uriVariables);	6✔
96	}
97
98	return $operation;	12✔
99	}
100
101	/**
102	* @return array<string, string>
103	*/
104	private function getUriVariables(mixed $value, Parameter $parameter, Operation $operation): array
105	{
106	$extraProperties = $parameter->getExtraProperties();	14✔
107
108	if ($operation instanceof HttpOperation) {	14✔
109	$links = $operation->getUriVariables();	14✔
UNCOV 110	} elseif ($operation instanceof GraphQlOperation) {	×
UNCOV 111	$links = $operation->getLinks();	×
112	} else {
UNCOV 113	$links = [];	×
114	}
115
116	if (!\is_array($value)) {	14✔
117	$uriVariables = [];	14✔
118
119	foreach ($links as $key => $link) {	14✔
120	if (!\is_string($key)) {	14✔
UNCOV 121	$key = $link->getParameterName() ?? $extraProperties['uri_variable'] ?? $link->getFromProperty();	×
122	}
123
124	if (!$key \|\| !\is_string($key)) {	14✔
UNCOV 125	continue;	×
126	}
127
128	$uriVariables[$key] = $value;	14✔
129	}
130
131	return $uriVariables;	14✔
132	}
133
134	return $value;	2✔
135	}
136	}

api-platform / core / 18089937549

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