#24940

pending completion

Build # #24940

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/3640ad206a61457b2eb5ae4faf731115acbd8f5c">3640ad206<a href="https://github.com/api-platform/core/commit/3640ad206a61457b2eb5ae4faf731115acbd8f5c">">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/f0713a3d2a3c57ca906b8cddc8f294341ac7bdf1">f0713a3d2</a>">f0713a3d2</a><a href="https://github.com/api-platform/core/commit/3640ad206a61457b2eb5ae4faf731115acbd8f5c"> into cfc05d1ce">cfc05d1ce</a>

Run Details

19 of 19 new or added lines in 4 files covered. (100.0%)

6201 of 11147 relevant lines covered (55.63%)

67.09 hits per line

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

0.0

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

use ApiPlatform\Core\Api\OperationType;
use ApiPlatform\Core\Exception\RuntimeException;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouterInterface;

/**
 * Resolves the HTTP method associated with an operation, extended for Symfony routing.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 * @author Teoh Han Hui <teohhanhui@gmail.com>
 *
 * @deprecated since API Platform 2.5, use the "method" attribute instead
 */
final class OperationMethodResolver implements OperationMethodResolverInterface
{
    private $router;
    private $resourceMetadataFactory;

    public function __construct(RouterInterface $router, ResourceMetadataFactoryInterface $resourceMetadataFactory)
    {
        @trigger_error(sprintf('The "%s" class is deprecated since API Platform 2.5, use the "method" attribute instead.', __CLASS__), E_USER_DEPRECATED);

        $this->router = $router;
        $this->resourceMetadataFactory = $resourceMetadataFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function getCollectionOperationMethod(string $resourceClass, string $operationName): string
    {
        return $this->getOperationMethod($resourceClass, $operationName, OperationType::COLLECTION);
    }

    /**
     * {@inheritdoc}
     */
    public function getItemOperationMethod(string $resourceClass, string $operationName): string
    {
        return $this->getOperationMethod($resourceClass, $operationName, OperationType::ITEM);
    }

    /**
     * {@inheritdoc}
     */
    public function getCollectionOperationRoute(string $resourceClass, string $operationName): Route
    {
        return $this->getOperationRoute($resourceClass, $operationName, OperationType::COLLECTION);
    }

    /**
     * {@inheritdoc}
     */
    public function getItemOperationRoute(string $resourceClass, string $operationName): Route
    {
        return $this->getOperationRoute($resourceClass, $operationName, OperationType::ITEM);
    }

    /**
     * @throws RuntimeException
     */
    private function getOperationMethod(string $resourceClass, string $operationName, string $operationType): string
    {
        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);

        if (OperationType::ITEM === $operationType) {
            $method = $resourceMetadata->getItemOperationAttribute($operationName, 'method');
        } else {
            $method = $resourceMetadata->getCollectionOperationAttribute($operationName, 'method');
        }

        if (null !== $method) {
            return strtoupper($method);
        }

        if (null === $routeName = $this->getRouteName($resourceMetadata, $operationName, $operationType)) {
            throw new RuntimeException(sprintf('Either a "route_name" or a "method" operation attribute must exist for the operation "%s" of the resource "%s".', $operationName, $resourceClass));
        }

        return $this->getRoute($routeName)->getMethods()[0] ?? 'GET';
    }

    /**
     * Gets the route related to the given operation.
     *
     * @throws RuntimeException
     */
    private function getOperationRoute(string $resourceClass, string $operationName, string $operationType): Route
    {
        $routeName = $this->getRouteName($this->resourceMetadataFactory->create($resourceClass), $operationName, $operationType);
        if (null !== $routeName) {
            return $this->getRoute($routeName);
        }

        $operationNameKey = sprintf('_api_%s_operation_name', $operationType);

        foreach ($this->router->getRouteCollection()->all() as $routeName => $route) {
            $currentResourceClass = $route->getDefault('_api_resource_class');
            $currentOperationName = $route->getDefault($operationNameKey);

            if ($resourceClass === $currentResourceClass && $operationName === $currentOperationName) {
                return $route;
            }
        }

        throw new RuntimeException(sprintf('No route found for operation "%s" for type "%s".', $operationName, $resourceClass));
    }

    /**
     * Gets the route name or null if not defined.
     */
    private function getRouteName(ResourceMetadata $resourceMetadata, string $operationName, string $operationType): ?string
    {
        if (OperationType::ITEM === $operationType) {
            return $resourceMetadata->getItemOperationAttribute($operationName, 'route_name');
        }

        return $resourceMetadata->getCollectionOperationAttribute($operationName, 'route_name');
    }

    /**
     * Gets the route with the given name.
     *
     * @throws RuntimeException
     */
    private function getRoute(string $routeName): Route
    {
        foreach ($this->router->getRouteCollection() as $name => $route) {
            if ($routeName === $name) {
                return $route;
            }
        }

        throw new RuntimeException(sprintf('The route "%s" does not exist.', $routeName));
    }
}

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\Symfony\Routing;
15
16	use ApiPlatform\Core\Api\OperationType;
17	use ApiPlatform\Core\Exception\RuntimeException;
18	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
19	use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
20	use Symfony\Component\Routing\Route;
21	use Symfony\Component\Routing\RouterInterface;
22
23	/**
24	* Resolves the HTTP method associated with an operation, extended for Symfony routing.
25	*
26	* @author Kévin Dunglas <dunglas@gmail.com>
27	* @author Teoh Han Hui <teohhanhui@gmail.com>
28	*
29	* @deprecated since API Platform 2.5, use the "method" attribute instead
30	*/
31	final class OperationMethodResolver implements OperationMethodResolverInterface
32	{
33	private $router;
34	private $resourceMetadataFactory;
35
36	public function __construct(RouterInterface $router, ResourceMetadataFactoryInterface $resourceMetadataFactory)
37	{	×
38	@trigger_error(sprintf('The "%s" class is deprecated since API Platform 2.5, use the "method" attribute instead.', __CLASS__), E_USER_DEPRECATED);	×
39
40	$this->router = $router;	×
41	$this->resourceMetadataFactory = $resourceMetadataFactory;	×
42	}	×
43
44	/**
45	* {@inheritdoc}
46	*/
47	public function getCollectionOperationMethod(string $resourceClass, string $operationName): string
48	{	×
49	return $this->getOperationMethod($resourceClass, $operationName, OperationType::COLLECTION);	×
50	}	×
51
52	/**
53	* {@inheritdoc}
54	*/
55	public function getItemOperationMethod(string $resourceClass, string $operationName): string
56	{	×
57	return $this->getOperationMethod($resourceClass, $operationName, OperationType::ITEM);	×
58	}	×
59
60	/**
61	* {@inheritdoc}
62	*/
63	public function getCollectionOperationRoute(string $resourceClass, string $operationName): Route
64	{	×
65	return $this->getOperationRoute($resourceClass, $operationName, OperationType::COLLECTION);	×
66	}	×
67
68	/**
69	* {@inheritdoc}
70	*/
71	public function getItemOperationRoute(string $resourceClass, string $operationName): Route
72	{	×
73	return $this->getOperationRoute($resourceClass, $operationName, OperationType::ITEM);	×
74	}	×
75
76	/**
77	* @throws RuntimeException
78	*/
79	private function getOperationMethod(string $resourceClass, string $operationName, string $operationType): string
80	{	×
81	$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);	×
82
83	if (OperationType::ITEM === $operationType) {	×
84	$method = $resourceMetadata->getItemOperationAttribute($operationName, 'method');	×
85	} else {	×
86	$method = $resourceMetadata->getCollectionOperationAttribute($operationName, 'method');	×
87	}	×
88
89	if (null !== $method) {	×
90	return strtoupper($method);	×
91	}	×
92
93	if (null === $routeName = $this->getRouteName($resourceMetadata, $operationName, $operationType)) {	×
94	throw new RuntimeException(sprintf('Either a "route_name" or a "method" operation attribute must exist for the operation "%s" of the resource "%s".', $operationName, $resourceClass));	×
95	}	×
96
97	return $this->getRoute($routeName)->getMethods()[0] ?? 'GET';	×
98	}	×
99
100	/**
101	* Gets the route related to the given operation.
102	*
103	* @throws RuntimeException
104	*/
105	private function getOperationRoute(string $resourceClass, string $operationName, string $operationType): Route
106	{	×
107	$routeName = $this->getRouteName($this->resourceMetadataFactory->create($resourceClass), $operationName, $operationType);	×
108	if (null !== $routeName) {	×
109	return $this->getRoute($routeName);	×
110	}	×
111
112	$operationNameKey = sprintf('_api_%s_operation_name', $operationType);	×
113
114	foreach ($this->router->getRouteCollection()->all() as $routeName => $route) {	×
115	$currentResourceClass = $route->getDefault('_api_resource_class');	×
116	$currentOperationName = $route->getDefault($operationNameKey);	×
117
118	if ($resourceClass === $currentResourceClass && $operationName === $currentOperationName) {	×
119	return $route;	×
120	}	×
121	}	×
122
123	throw new RuntimeException(sprintf('No route found for operation "%s" for type "%s".', $operationName, $resourceClass));	×
124	}	×
125
126	/**
127	* Gets the route name or null if not defined.
128	*/
129	private function getRouteName(ResourceMetadata $resourceMetadata, string $operationName, string $operationType): ?string
130	{	×
131	if (OperationType::ITEM === $operationType) {	×
132	return $resourceMetadata->getItemOperationAttribute($operationName, 'route_name');	×
133	}	×
134
135	return $resourceMetadata->getCollectionOperationAttribute($operationName, 'route_name');	×
136	}	×
137
138	/**
139	* Gets the route with the given name.
140	*
141	* @throws RuntimeException
142	*/
143	private function getRoute(string $routeName): Route
144	{	×
145	foreach ($this->router->getRouteCollection() as $name => $route) {	×
146	if ($routeName === $name) {	×
147	return $route;	×
148	}	×
149	}	×
150
151	throw new RuntimeException(sprintf('The route "%s" does not exist.', $routeName));	×
152	}	×
153	}

api-platform / core / #24940

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