16050929464

Committed 03 Jul 2025 12:51PM UTC coverage: 22.065% (+0.2%) from 21.821%

Build # 16050929464

Build Type

push

github

Committed by

soyuka

Commit Message

chore: todo improvement

Run Details

11516 of 52192 relevant lines covered (22.06%)

22.08 hits per line

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

96.61

/src/Symfony/Routing/ApiLoader.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\Metadata\Exception\RuntimeException;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
use ApiPlatform\OpenApi\Attributes\Webhook;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\Config\Loader\Loader;
use Symfony\Component\Config\Resource\DirectoryResource;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpKernel\KernelInterface;
use Symfony\Component\Routing\Loader\XmlFileLoader;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;

/**
 * Loads Resources.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
final class ApiLoader extends Loader
{
    public const DEFAULT_ACTION_PATTERN = 'api_platform.action.';

    private readonly XmlFileLoader $fileLoader;

    public function __construct(KernelInterface $kernel, private readonly ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, private readonly ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, private readonly ContainerInterface $container, private readonly array $formats, private readonly array $resourceClassDirectories = [], private readonly bool $graphqlEnabled = false, private readonly bool $entrypointEnabled = true, readonly bool $docsEnabled = true, private readonly bool $graphiQlEnabled = false)
    {
        $paths = $kernel->locateResource('@ApiPlatformBundle/Resources/config/routing');
        $this->fileLoader = new XmlFileLoader(new FileLocator($paths));
    }

    /**
     * {@inheritdoc}
     */
    public function load(mixed $data, ?string $type = null): RouteCollection
    {
        $routeCollection = new RouteCollection();
        foreach ($this->resourceClassDirectories as $directory) {
            $routeCollection->addResource(new DirectoryResource($directory, '/\.php$/'));
        }

        $this->loadExternalFiles($routeCollection);
        foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
            foreach ($this->resourceMetadataFactory->create($resourceClass) as $resourceMetadata) {
                foreach ($resourceMetadata->getOperations() as $operationName => $operation) {
                    if ($operation->getOpenapi() instanceof Webhook) {
                        continue;
                    }

                    if ($operation->getRouteName()) {
                        continue;
                    }

                    if (SkolemIriConverter::$skolemUriTemplate === $operation->getUriTemplate()) {
                        continue;
                    }

                    $path = ($operation->getRoutePrefix() ?? '').$operation->getUriTemplate();
                    foreach ($operation->getUriVariables() ?? [] as $parameterName => $link) {
                        if (!$expandedValue = $link->getExpandedValue()) {
                            continue;
                        }

                        $path = str_replace(\sprintf('{%s}', $parameterName), $expandedValue, $path);
                    }

                    // Within Symfony .{_format} is a special parameter but the rfc6570 specifies label expansion with a dot operator
                    if (str_ends_with($path, '{._format}')) {
                        $path = str_replace('{._format}', '.{_format}', $path);
                    }

                    if ($controller = $operation->getController()) {
                        $controllerId = explode('::', $controller, 2)[0];
                        if (!$this->container->has($controllerId)) {
                            throw new RuntimeException(\sprintf('Operation "%s" is defining an unknown service as controller "%s". Make sure it is properly registered in the dependency injection container.', $operationName, $controllerId));
                        }
                    }

                    $route = new Route(
                        $path,
                        [
                            '_controller' => $controller ?? 'api_platform.action.placeholder',
                            '_stateless' => $operation->getStateless(),
                            '_api_resource_class' => $resourceClass,
                            '_api_operation_name' => $operationName,
                        ] + ($operation->getDefaults() ?? []) + ['_format' => null],
                        $operation->getRequirements() ?? [],
                        $operation->getOptions() ?? [],
                        $operation->getHost() ?? '',
                        $operation->getSchemes() ?? [],
                        [$operation->getMethod()],
                        $operation->getCondition() ?? ''
                    );

                    $routeCollection->add($operationName, $route);
                }
            }
        }

        return $routeCollection;
    }

    /**
     * {@inheritdoc}
     */
    public function supports(mixed $resource, ?string $type = null): bool
    {
        return 'api_platform' === $type;
    }

    /**
     * Load external files.
     */
    private function loadExternalFiles(RouteCollection $routeCollection): void
    {
        $routeCollection->addCollection($this->fileLoader->load('docs.xml'));
        $routeCollection->addCollection($this->fileLoader->load('genid.xml'));
        $routeCollection->addCollection($this->fileLoader->load('errors.xml'));

        if ($this->entrypointEnabled) {
            $routeCollection->addCollection($this->fileLoader->load('api.xml'));
        }

        if ($this->graphqlEnabled) {
            $graphqlCollection = $this->fileLoader->load('graphql/graphql.xml');
            $graphqlCollection->addDefaults(['_graphql' => true]);
            $routeCollection->addCollection($graphqlCollection);
        }

        if ($this->graphiQlEnabled) {
            $graphiQlCollection = $this->fileLoader->load('graphql/graphiql.xml');
            $graphiQlCollection->addDefaults(['_graphql' => true]);
            $routeCollection->addCollection($graphiQlCollection);
        }

        if (isset($this->formats['jsonld'])) {
            $routeCollection->addCollection($this->fileLoader->load('jsonld.xml'));
        }
    }
}

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\Metadata\Exception\RuntimeException;
17	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
18	use ApiPlatform\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
19	use ApiPlatform\OpenApi\Attributes\Webhook;
20	use Symfony\Component\Config\FileLocator;
21	use Symfony\Component\Config\Loader\Loader;
22	use Symfony\Component\Config\Resource\DirectoryResource;
23	use Symfony\Component\DependencyInjection\ContainerInterface;
24	use Symfony\Component\HttpKernel\KernelInterface;
25	use Symfony\Component\Routing\Loader\XmlFileLoader;
26	use Symfony\Component\Routing\Route;
27	use Symfony\Component\Routing\RouteCollection;
28
29	/**
30	* Loads Resources.
31	*
32	* @author Kévin Dunglas <dunglas@gmail.com>
33	*/
34	final class ApiLoader extends Loader
35	{
36	public const DEFAULT_ACTION_PATTERN = 'api_platform.action.';
37
38	private readonly XmlFileLoader $fileLoader;
39
40	public function __construct(KernelInterface $kernel, private readonly ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, private readonly ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, private readonly ContainerInterface $container, private readonly array $formats, private readonly array $resourceClassDirectories = [], private readonly bool $graphqlEnabled = false, private readonly bool $entrypointEnabled = true, readonly bool $docsEnabled = true, private readonly bool $graphiQlEnabled = false)
41	{
42	$paths = $kernel->locateResource('@ApiPlatformBundle/Resources/config/routing');	96✔
43	$this->fileLoader = new XmlFileLoader(new FileLocator($paths));	96✔
44	}
45
46	/**
47	* {@inheritdoc}
48	*/
49	public function load(mixed $data, ?string $type = null): RouteCollection
50	{
51	$routeCollection = new RouteCollection();	96✔
52	foreach ($this->resourceClassDirectories as $directory) {	96✔
53	$routeCollection->addResource(new DirectoryResource($directory, '/\.php$/'));	90✔
54	}
55
56	$this->loadExternalFiles($routeCollection);	96✔
57	foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {	96✔
58	foreach ($this->resourceMetadataFactory->create($resourceClass) as $resourceMetadata) {	96✔
59	foreach ($resourceMetadata->getOperations() as $operationName => $operation) {	96✔
60	if ($operation->getOpenapi() instanceof Webhook) {	96✔
61	continue;	×
62	}
63
64	if ($operation->getRouteName()) {	96✔
65	continue;	90✔
66	}
67
68	if (SkolemIriConverter::$skolemUriTemplate === $operation->getUriTemplate()) {	96✔
69	continue;	×
70	}
71
72	$path = ($operation->getRoutePrefix() ?? '').$operation->getUriTemplate();	96✔
73	foreach ($operation->getUriVariables() ?? [] as $parameterName => $link) {	96✔
74	if (!$expandedValue = $link->getExpandedValue()) {	92✔
75	continue;	92✔
76	}
77
78	$path = str_replace(\sprintf('{%s}', $parameterName), $expandedValue, $path);	10✔
79	}
80
81	// Within Symfony .{_format} is a special parameter but the rfc6570 specifies label expansion with a dot operator
82	if (str_ends_with($path, '{._format}')) {	96✔
83	$path = str_replace('{._format}', '.{_format}', $path);	90✔
84	}
85
86	if ($controller = $operation->getController()) {	96✔
87	$controllerId = explode('::', $controller, 2)[0];	70✔
88	if (!$this->container->has($controllerId)) {	70✔
89	throw new RuntimeException(\sprintf('Operation "%s" is defining an unknown service as controller "%s". Make sure it is properly registered in the dependency injection container.', $operationName, $controllerId));	2✔
90	}
91	}
92
93	$route = new Route(	94✔
94	$path,	94✔
95	[	94✔
96	'_controller' => $controller ?? 'api_platform.action.placeholder',	94✔
97	'_stateless' => $operation->getStateless(),	94✔
98	'_api_resource_class' => $resourceClass,	94✔
99	'_api_operation_name' => $operationName,	94✔
100	] + ($operation->getDefaults() ?? []) + ['_format' => null],	94✔
101	$operation->getRequirements() ?? [],	94✔
102	$operation->getOptions() ?? [],	94✔
103	$operation->getHost() ?? '',	94✔
104	$operation->getSchemes() ?? [],	94✔
105	[$operation->getMethod()],	94✔
106	$operation->getCondition() ?? ''	94✔
107	);	94✔
108
109	$routeCollection->add($operationName, $route);	94✔
110	}
111	}
112	}
113
114	return $routeCollection;	94✔
115	}
116
117	/**
118	* {@inheritdoc}
119	*/
120	public function supports(mixed $resource, ?string $type = null): bool
121	{
122	return 'api_platform' === $type;	90✔
123	}
124
125	/**
126	* Load external files.
127	*/
128	private function loadExternalFiles(RouteCollection $routeCollection): void
129	{
130	$routeCollection->addCollection($this->fileLoader->load('docs.xml'));	96✔
131	$routeCollection->addCollection($this->fileLoader->load('genid.xml'));	96✔
132	$routeCollection->addCollection($this->fileLoader->load('errors.xml'));	96✔
133
134	if ($this->entrypointEnabled) {	96✔
135	$routeCollection->addCollection($this->fileLoader->load('api.xml'));	96✔
136	}
137
138	if ($this->graphqlEnabled) {	96✔
139	$graphqlCollection = $this->fileLoader->load('graphql/graphql.xml');	90✔
140	$graphqlCollection->addDefaults(['_graphql' => true]);	90✔
141	$routeCollection->addCollection($graphqlCollection);	90✔
142	}
143
144	if ($this->graphiQlEnabled) {	96✔
145	$graphiQlCollection = $this->fileLoader->load('graphql/graphiql.xml');	90✔
146	$graphiQlCollection->addDefaults(['_graphql' => true]);	90✔
147	$routeCollection->addCollection($graphiQlCollection);	90✔
148	}
149
150	if (isset($this->formats['jsonld'])) {	96✔
151	$routeCollection->addCollection($this->fileLoader->load('jsonld.xml'));	96✔
152	}
153	}
154	}

api-platform / core / 16050929464

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