#27763

pending completion

Build # #27763

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/ba6b7827cb9d0f940dc49541c5162d7f571cf0c0">ba6b7827c<a href="https://github.com/api-platform/core/commit/ba6b7827cb9d0f940dc49541c5162d7f571cf0c0">">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/72e55bee37a653683030c176e3ad571327df933e">72e55bee3</a>">72e55bee3</a><a href="https://github.com/api-platform/core/commit/ba6b7827cb9d0f940dc49541c5162d7f571cf0c0"> into db5275885">db5275885</a>

Run Details

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

13313 of 16668 relevant lines covered (79.87%)

14.76 hits per line

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

72.46

/src/Symfony/Routing/IriConverter.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\Symfony\Routing;

use ApiPlatform\Api\IdentifiersExtractorInterface;
use ApiPlatform\Api\IriConverterInterface;
use ApiPlatform\Api\UriVariablesConverterInterface;
use ApiPlatform\Api\UrlGeneratorInterface;
use ApiPlatform\Core\Api\ResourceClassResolverInterface;
use ApiPlatform\Core\Util\AttributesExtractor;
use ApiPlatform\Core\Util\ResourceClassInfoTrait;
use ApiPlatform\Exception\InvalidArgumentException;
use ApiPlatform\Exception\InvalidIdentifierException;
use ApiPlatform\Exception\ItemNotFoundException;
use ApiPlatform\Exception\OperationNotFoundException;
use ApiPlatform\Exception\RuntimeException;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\State\ProviderInterface;
use ApiPlatform\State\UriVariablesResolverTrait;
use Symfony\Component\Routing\Exception\ExceptionInterface as RoutingExceptionInterface;
use Symfony\Component\Routing\RouterInterface;

/**
 * {@inheritdoc}
 *
 * @experimental
 *
 * @author Antoine Bluchet <soyuka@gmail.com>
 */
final class IriConverter implements IriConverterInterface
{
    use ResourceClassInfoTrait;
    use UriVariablesResolverTrait;

    private $stateProvider;
    private $router;
    private $identifiersExtractor;
    private $resourceMetadataCollectionFactory;
    private $decorated;

    public function __construct(ProviderInterface $stateProvider, RouterInterface $router, IdentifiersExtractorInterface $identifiersExtractor, ResourceClassResolverInterface $resourceClassResolver, ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, UriVariablesConverterInterface $uriVariablesConverter = null, \ApiPlatform\Core\Api\IriConverterInterface $decorated)
    {
        $this->stateProvider = $stateProvider;
        $this->router = $router;
        $this->uriVariablesConverter = $uriVariablesConverter;
        $this->identifiersExtractor = $identifiersExtractor;
        $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
        // For the ResourceClassInfoTrait
        $this->resourceClassResolver = $resourceClassResolver;
        $this->resourceMetadataFactory = $resourceMetadataCollectionFactory;
        $this->decorated = $decorated;
    }

    /**
     * {@inheritdoc}
     */
    public function getItemFromIri(string $iri, array $context = [])
    {
        try {
            $parameters = $this->router->match($iri);
        } catch (RoutingExceptionInterface $e) {
            throw new InvalidArgumentException(sprintf('No route matches "%s".', $iri), $e->getCode(), $e);
        }

        if (!isset($parameters['_api_resource_class'], $parameters['_api_operation_name'])) {
            throw new InvalidArgumentException(sprintf('No resource associated to "%s".', $iri));
        }

        $context['operation'] = $operation = $parameters['_api_operation'] = $this->resourceMetadataCollectionFactory->create($parameters['_api_resource_class'])->getOperation($parameters['_api_operation_name']);

        if (
            ($operation->getExtraProperties()['is_legacy_subresource'] ?? false) ||
            ($operation->getExtraProperties()['is_legacy_resource_metadata'] ?? false)
        ) {
            return $this->decorated->getItemFromIri($iri, $context);
        }

        if ($operation->isCollection()) {
            throw new InvalidArgumentException(sprintf('The iri "%s" references a collection not an item.', $iri));
        }

        $attributes = AttributesExtractor::extractAttributes($parameters);

        try {
            $identifiers = $this->getOperationIdentifiers($operation, $parameters, $attributes['resource_class']);
        } catch (InvalidIdentifierException $e) {
            throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e);
        }

        if ($item = $this->stateProvider->provide($attributes['resource_class'], $identifiers, $attributes['operation_name'], $context)) {
            return $item;
        }

        throw new ItemNotFoundException(sprintf('Item not found for "%s".', $iri));
    }

    /**
     * {@inheritdoc}
     */
    public function getIriFromItem($item, string $operationName = null, int $referenceType = UrlGeneratorInterface::ABS_PATH, array $context = []): string
    {
        $resourceClass = $this->getResourceClass($item, true);
        $operationName = $context['operation_name'] ?? $operationName;

        // These are special cases were we want to find the related operation
        // `ResourceMetadataCollection::getOperation` retrieves the first safe operation if no $operationName is given
        if (isset($context['operation'])) {
            $operation = $context['operation'];
            if (
                ($operation->getExtraProperties()['is_legacy_subresource'] ?? false) ||
                ($operation->getExtraProperties()['user_defined_uri_template'] ?? false) ||
                ($operation->getExtraProperties()['is_alternate_resource_metadata'] ?? false) ||
                ($operation->getExtraProperties()['legacy_subresource_behavior'] ?? false) ||
                // When we want the Iri from an object, we don't want the collection uriTemplate, for this we use getIriFromResourceClass
                $operation->isCollection()
            ) {
                unset($context['operation']);
                $operationName = null;
            }
        }

        try {
            $operation = $context['operation'] ?? $this->resourceMetadataCollectionFactory->create($resourceClass)->getOperation($operationName);
        } catch (OperationNotFoundException $e) {
            $resourceMetadataCollection = $this->resourceMetadataCollectionFactory->create($resourceClass);
            foreach ($resourceMetadataCollection as $resource) {
                foreach ($resource->getOperations() as $name => $operation) {
                    if ($operationName === $name && !$operation->isCollection()) {
                        break 2;
                    }
                }
            }

            if (!isset($operation)) {
                throw new InvalidArgumentException(sprintf('Unable to generate an IRI for the item of type "%s"', $resourceClass), $e->getCode(), $e);
            }
        }

        try {
            $identifiers = $this->identifiersExtractor->getIdentifiersFromItem($item, $operation->getName(), ['operation' => $operation]);

            return $this->router->generate($operation->getName(), $identifiers, $operation->getUrlGenerationStrategy() ?? $referenceType);
        } catch (RuntimeException | RoutingExceptionInterface $e) {
            throw new InvalidArgumentException(sprintf('Unable to generate an IRI for the item of type "%s"', $resourceClass), $e->getCode(), $e);
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getIriFromResourceClass(string $resourceClass, string $operationName = null, int $referenceType = UrlGeneratorInterface::ABS_PATH, array $context = []): string
    {
        // TODO: 3.0 remove the condition
        if ($context['extra_properties']['is_legacy_subresource'] ?? false) {
            trigger_deprecation('api-platform/core', '2.7', 'The IRI will change and match the first operation of the resource. Switch to an alternate resource when possible instead of using subresources.');
            $operation = $this->resourceMetadataCollectionFactory->create($resourceClass)->getOperation($context['extra_properties']['legacy_subresource_operation_name']);
        }

        $operation = $context['operation'] ?? null;

        if ($operation) {
            // TODO: 2.7 should we deprecate this behavior ? example : Entity\Foo.php should take it's own operation? As it's a custom operation can we now?
            if ($operation->getExtraProperties()['is_legacy_subresource'] ?? false) {
                trigger_deprecation('api-platform/core', '2.7', 'The IRI will change and match the first operation of the resource. Switch to an alternate resource when possible instead of using subresources.');
                $operationName = $operation->getExtraProperties()['legacy_subresource_operation_name'];
                $operation = null;
            } elseif (!($operation->getExtraProperties()['is_alternate_resource_metadata'] ?? false) && ($operation->getExtraProperties()['user_defined_uri_template'] ?? false)) {
                $operation = null;
                $operationName = null;
            }
        }

        try {
            if (!$operation) {
                $operation = $this->resourceMetadataCollectionFactory->create($resourceClass)->getOperation($operationName, $context['force_collection'] ?? true);
            }

            $identifiers = $context['identifiers_values'] ?? [];

            return $this->router->generate($operation->getName(), $identifiers, $operation->getUrlGenerationStrategy() ?? $referenceType);
        } catch (RoutingExceptionInterface | OperationNotFoundException $e) {
            throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e);
        }
    }
}

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\Symfony\Routing;
15
16	use ApiPlatform\Api\IdentifiersExtractorInterface;
17	use ApiPlatform\Api\IriConverterInterface;
18	use ApiPlatform\Api\UriVariablesConverterInterface;
19	use ApiPlatform\Api\UrlGeneratorInterface;
20	use ApiPlatform\Core\Api\ResourceClassResolverInterface;
21	use ApiPlatform\Core\Util\AttributesExtractor;
22	use ApiPlatform\Core\Util\ResourceClassInfoTrait;
23	use ApiPlatform\Exception\InvalidArgumentException;
24	use ApiPlatform\Exception\InvalidIdentifierException;
25	use ApiPlatform\Exception\ItemNotFoundException;
26	use ApiPlatform\Exception\OperationNotFoundException;
27	use ApiPlatform\Exception\RuntimeException;
28	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
29	use ApiPlatform\State\ProviderInterface;
30	use ApiPlatform\State\UriVariablesResolverTrait;
31	use Symfony\Component\Routing\Exception\ExceptionInterface as RoutingExceptionInterface;
32	use Symfony\Component\Routing\RouterInterface;
33
34	/**
35	* {@inheritdoc}
36	*
37	* @experimental
38	*
39	* @author Antoine Bluchet <soyuka@gmail.com>
40	*/
41	final class IriConverter implements IriConverterInterface
42	{
43	use ResourceClassInfoTrait;
44	use UriVariablesResolverTrait;
45
46	private $stateProvider;
47	private $router;
48	private $identifiersExtractor;
49	private $resourceMetadataCollectionFactory;
50	private $decorated;
51
52	public function __construct(ProviderInterface $stateProvider, RouterInterface $router, IdentifiersExtractorInterface $identifiersExtractor, ResourceClassResolverInterface $resourceClassResolver, ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, UriVariablesConverterInterface $uriVariablesConverter = null, \ApiPlatform\Core\Api\IriConverterInterface $decorated)
53	{
54	$this->stateProvider = $stateProvider;	42✔
55	$this->router = $router;	42✔
56	$this->uriVariablesConverter = $uriVariablesConverter;	42✔
57	$this->identifiersExtractor = $identifiersExtractor;	42✔
58	$this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;	42✔
59	// For the ResourceClassInfoTrait
60	$this->resourceClassResolver = $resourceClassResolver;	42✔
61	$this->resourceMetadataFactory = $resourceMetadataCollectionFactory;	42✔
62	$this->decorated = $decorated;	42✔
63	}	42✔
64
65	/**
66	* {@inheritdoc}
67	*/
68	public function getItemFromIri(string $iri, array $context = [])
69	{
70	try {
71	$parameters = $this->router->match($iri);	3✔
72	} catch (RoutingExceptionInterface $e) {	×
73	throw new InvalidArgumentException(sprintf('No route matches "%s".', $iri), $e->getCode(), $e);	×
74	}
75
76	if (!isset($parameters['_api_resource_class'], $parameters['_api_operation_name'])) {	3✔
77	throw new InvalidArgumentException(sprintf('No resource associated to "%s".', $iri));	×
78	}
79
80	$context['operation'] = $operation = $parameters['_api_operation'] = $this->resourceMetadataCollectionFactory->create($parameters['_api_resource_class'])->getOperation($parameters['_api_operation_name']);	3✔
81
82	if (
83	($operation->getExtraProperties()['is_legacy_subresource'] ?? false) \|\|	3✔
84	($operation->getExtraProperties()['is_legacy_resource_metadata'] ?? false)	3✔
85	) {
86	return $this->decorated->getItemFromIri($iri, $context);	×
87	}
88
89	if ($operation->isCollection()) {	3✔
90	throw new InvalidArgumentException(sprintf('The iri "%s" references a collection not an item.', $iri));	1✔
91	}
92
93	$attributes = AttributesExtractor::extractAttributes($parameters);	2✔
94
95	try {
96	$identifiers = $this->getOperationIdentifiers($operation, $parameters, $attributes['resource_class']);	2✔
97	} catch (InvalidIdentifierException $e) {	×
98	throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e);	×
99	}
100
101	if ($item = $this->stateProvider->provide($attributes['resource_class'], $identifiers, $attributes['operation_name'], $context)) {	2✔
102	return $item;	1✔
103	}
104
105	throw new ItemNotFoundException(sprintf('Item not found for "%s".', $iri));	1✔
106	}
107
108	/**
109	* {@inheritdoc}
110	*/
111	public function getIriFromItem($item, string $operationName = null, int $referenceType = UrlGeneratorInterface::ABS_PATH, array $context = []): string
112	{
113	$resourceClass = $this->getResourceClass($item, true);	13✔
114	$operationName = $context['operation_name'] ?? $operationName;	13✔
115
116	// These are special cases were we want to find the related operation
117	// `ResourceMetadataCollection::getOperation` retrieves the first safe operation if no $operationName is given
118	if (isset($context['operation'])) {	13✔
119	$operation = $context['operation'];	8✔
120	if (
121	($operation->getExtraProperties()['is_legacy_subresource'] ?? false) \|\|	8✔
122	($operation->getExtraProperties()['user_defined_uri_template'] ?? false) \|\|	8✔
123	($operation->getExtraProperties()['is_alternate_resource_metadata'] ?? false) \|\|	8✔
124	($operation->getExtraProperties()['legacy_subresource_behavior'] ?? false) \|\|	8✔
125	// When we want the Iri from an object, we don't want the collection uriTemplate, for this we use getIriFromResourceClass
126	$operation->isCollection()	8✔
127	) {
128	unset($context['operation']);	5✔
129	$operationName = null;	5✔
130	}
131	}
132
133	try {
134	$operation = $context['operation'] ?? $this->resourceMetadataCollectionFactory->create($resourceClass)->getOperation($operationName);	13✔
135	} catch (OperationNotFoundException $e) {	1✔
136	$resourceMetadataCollection = $this->resourceMetadataCollectionFactory->create($resourceClass);	1✔
137	foreach ($resourceMetadataCollection as $resource) {	1✔
138	foreach ($resource->getOperations() as $name => $operation) {	1✔
139	if ($operationName === $name && !$operation->isCollection()) {	×
140	break 2;	×
141	}
142	}
143	}
144
145	if (!isset($operation)) {	1✔
146	throw new InvalidArgumentException(sprintf('Unable to generate an IRI for the item of type "%s"', $resourceClass), $e->getCode(), $e);	1✔
147	}
148	}
149
150	try {
151	$identifiers = $this->identifiersExtractor->getIdentifiersFromItem($item, $operation->getName(), ['operation' => $operation]);	12✔
152
153	return $this->router->generate($operation->getName(), $identifiers, $operation->getUrlGenerationStrategy() ?? $referenceType);	12✔
154	} catch (RuntimeException \| RoutingExceptionInterface $e) {	×
155	throw new InvalidArgumentException(sprintf('Unable to generate an IRI for the item of type "%s"', $resourceClass), $e->getCode(), $e);	×
156	}
157	}
158
159	/**
160	* {@inheritdoc}
161	*/
162	public function getIriFromResourceClass(string $resourceClass, string $operationName = null, int $referenceType = UrlGeneratorInterface::ABS_PATH, array $context = []): string
163	{
164	// TODO: 3.0 remove the condition
165	if ($context['extra_properties']['is_legacy_subresource'] ?? false) {	24✔
166	trigger_deprecation('api-platform/core', '2.7', 'The IRI will change and match the first operation of the resource. Switch to an alternate resource when possible instead of using subresources.');	×
167	$operation = $this->resourceMetadataCollectionFactory->create($resourceClass)->getOperation($context['extra_properties']['legacy_subresource_operation_name']);	×
168	}
169
170	$operation = $context['operation'] ?? null;	24✔
171
172	if ($operation) {	24✔
173	// TODO: 2.7 should we deprecate this behavior ? example : Entity\Foo.php should take it's own operation? As it's a custom operation can we now?
174	if ($operation->getExtraProperties()['is_legacy_subresource'] ?? false) {	8✔
175	trigger_deprecation('api-platform/core', '2.7', 'The IRI will change and match the first operation of the resource. Switch to an alternate resource when possible instead of using subresources.');	×
176	$operationName = $operation->getExtraProperties()['legacy_subresource_operation_name'];	×
177	$operation = null;	×
178	} elseif (!($operation->getExtraProperties()['is_alternate_resource_metadata'] ?? false) && ($operation->getExtraProperties()['user_defined_uri_template'] ?? false)) {	8✔
179	$operation = null;	×
180	$operationName = null;	×
181	}
182	}
183
184	try {
185	if (!$operation) {	24✔
186	$operation = $this->resourceMetadataCollectionFactory->create($resourceClass)->getOperation($operationName, $context['force_collection'] ?? true);	23✔
187	}
188
189	$identifiers = $context['identifiers_values'] ?? [];	24✔
190
191	return $this->router->generate($operation->getName(), $identifiers, $operation->getUrlGenerationStrategy() ?? $referenceType);	24✔
192	} catch (RoutingExceptionInterface \| OperationNotFoundException $e) {	×
193	throw new InvalidArgumentException(sprintf('Unable to generate an IRI for "%s".', $resourceClass), $e->getCode(), $e);	×
194	}
195	}
196	}

api-platform / core / #27763

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