17439928843

Committed 03 Sep 2025 04:33PM UTC coverage: 21.972% (-0.2%) from 22.209%

Build # 17439928843

Build Type

Pull #7366

github

Committed by

web-flow

Commit Message

Merge 09a9499ba into 9e382e01b

Pull Request Pull Request #7366: Fix array shape

Run Details

0 of 1 new or added line in 1 file covered. (0.0%)

125 existing lines in 11 files now uncovered.

11574 of 52676 relevant lines covered (21.97%)

12.0 hits per line

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

94.29

/src/State/Provider/ContentNegotiationProvider.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\Provider;

use ApiPlatform\Metadata\Error as ErrorOperation;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\Util\ContentNegotiationTrait;
use ApiPlatform\State\ProviderInterface;
use ApiPlatform\State\StopwatchAwareInterface;
use ApiPlatform\State\StopwatchAwareTrait;
use Negotiation\Negotiator;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException;

final class ContentNegotiationProvider implements ProviderInterface, StopwatchAwareInterface
{
    use ContentNegotiationTrait;
    use StopwatchAwareTrait;

    /**
     * @param array<string, string[]> $formats
     * @param array<string, string[]> $errorFormats
     */
    public function __construct(private readonly ?ProviderInterface $decorated = null, ?Negotiator $negotiator = null, private readonly array $formats = [], private readonly array $errorFormats = [])
    {
        $this->negotiator = $negotiator ?? new Negotiator();
    }

    public function provide(Operation $operation, array $uriVariables = [], array $context = []): object|array|null
    {
        if (!($request = $context['request'] ?? null) || !$operation instanceof HttpOperation) {
            return $this->decorated?->provide($operation, $uriVariables, $context);
        }

        $this->stopwatch?->start('api_platform.provider.content_negotiation');
        $isErrorOperation = $operation instanceof ErrorOperation;

        $formats = $operation->getOutputFormats() ?? ($isErrorOperation ? $this->errorFormats : $this->formats);
        $this->addRequestFormats($request, $formats);
        $request->attributes->set('input_format', $this->getInputFormat($operation, $request));
        $request->setRequestFormat($this->getRequestFormat($request, $formats, !$isErrorOperation));
        $this->stopwatch?->stop('api_platform.provider.content_negotiation');

        return $this->decorated?->provide($operation, $uriVariables, $context);
    }

    /**
     * Adds the supported formats to the request.
     *
     * This is necessary for {@see Request::getMimeType} and {@see Request::getMimeTypes} to work.
     * Note that this replaces default mime types configured at {@see Request::initializeFormats}
     *
     * @param array<string, string|string[]> $formats
     */
    private function addRequestFormats(Request $request, array $formats): void
    {
        foreach ($formats as $format => $mimeTypes) {
            $request->setFormat($format, (array) $mimeTypes);
        }
    }

    /**
     * Flattened the list of MIME types.
     *
     * @param array<string, string|string[]> $formats
     *
     * @return array<string, string>
     */
    private function flattenMimeTypes(array $formats): array
    {
        $flattenedMimeTypes = [];
        foreach ($formats as $format => $mimeTypes) {
            foreach ($mimeTypes as $mimeType) {
                $flattenedMimeTypes[$mimeType] = $format;
            }
        }

        return $flattenedMimeTypes;
    }

    /**
     * Extracts the format from the Content-Type header and check that it is supported.
     *
     * @throws UnsupportedMediaTypeHttpException
     */
    private function getInputFormat(HttpOperation $operation, Request $request): ?string
    {
        if (
            false === ($input = $operation->getInput())
            || (\is_array($input) && null === $input['class'])
            || false === $operation->canDeserialize()
        ) {
            return null;
        }

        $contentType = $request->headers->get('CONTENT_TYPE');
        if (null === $contentType || '' === $contentType) {
            return null;
        }

        $formats = $operation->getInputFormats() ?? [];
        if ($format = $this->getMimeTypeFormat($contentType, $formats)) {
            return $format;
        }

        if (!$request->isMethodSafe() && 'DELETE' !== $request->getMethod()) {
            $supportedMimeTypes = [];
            foreach ($formats as $mimeTypes) {
                foreach ($mimeTypes as $mimeType) {
                    $supportedMimeTypes[] = $mimeType;
                }
            }

            throw new UnsupportedMediaTypeHttpException(\sprintf('The content-type "%s" is not supported. Supported MIME types are "%s".', $contentType, implode('", "', $supportedMimeTypes)));
        }

        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\State\Provider;
15
16	use ApiPlatform\Metadata\Error as ErrorOperation;
17	use ApiPlatform\Metadata\HttpOperation;
18	use ApiPlatform\Metadata\Operation;
19	use ApiPlatform\Metadata\Util\ContentNegotiationTrait;
20	use ApiPlatform\State\ProviderInterface;
21	use ApiPlatform\State\StopwatchAwareInterface;
22	use ApiPlatform\State\StopwatchAwareTrait;
23	use Negotiation\Negotiator;
24	use Symfony\Component\HttpFoundation\Request;
25	use Symfony\Component\HttpKernel\Exception\UnsupportedMediaTypeHttpException;
26
27	final class ContentNegotiationProvider implements ProviderInterface, StopwatchAwareInterface
28	{
29	use ContentNegotiationTrait;
30	use StopwatchAwareTrait;
31
32	/**
33	* @param array<string, string[]> $formats
34	* @param array<string, string[]> $errorFormats
35	*/
36	public function __construct(private readonly ?ProviderInterface $decorated = null, ?Negotiator $negotiator = null, private readonly array $formats = [], private readonly array $errorFormats = [])
37	{
38	$this->negotiator = $negotiator ?? new Negotiator();	289✔
39	}
40
41	public function provide(Operation $operation, array $uriVariables = [], array $context = []): object\|array\|null
42	{
43	if (!($request = $context['request'] ?? null) \|\| !$operation instanceof HttpOperation) {	289✔
44	return $this->decorated?->provide($operation, $uriVariables, $context);	×
45	}
46
47	$this->stopwatch?->start('api_platform.provider.content_negotiation');	289✔
48	$isErrorOperation = $operation instanceof ErrorOperation;	289✔
49
50	$formats = $operation->getOutputFormats() ?? ($isErrorOperation ? $this->errorFormats : $this->formats);	289✔
51	$this->addRequestFormats($request, $formats);	289✔
52	$request->attributes->set('input_format', $this->getInputFormat($operation, $request));	289✔
53	$request->setRequestFormat($this->getRequestFormat($request, $formats, !$isErrorOperation));	288✔
54	$this->stopwatch?->stop('api_platform.provider.content_negotiation');	288✔
55
56	return $this->decorated?->provide($operation, $uriVariables, $context);	288✔
57	}
58
59	/**
60	* Adds the supported formats to the request.
61	*
62	* This is necessary for {@see Request::getMimeType} and {@see Request::getMimeTypes} to work.
63	* Note that this replaces default mime types configured at {@see Request::initializeFormats}
64	*
65	* @param array<string, string\|string[]> $formats
66	*/
67	private function addRequestFormats(Request $request, array $formats): void
68	{
69	foreach ($formats as $format => $mimeTypes) {	289✔
70	$request->setFormat($format, (array) $mimeTypes);	289✔
71	}
72	}
73
74	/**
75	* Flattened the list of MIME types.
76	*
77	* @param array<string, string\|string[]> $formats
78	*
79	* @return array<string, string>
80	*/
81	private function flattenMimeTypes(array $formats): array
82	{
83	$flattenedMimeTypes = [];	288✔
84	foreach ($formats as $format => $mimeTypes) {	288✔
85	foreach ($mimeTypes as $mimeType) {	288✔
86	$flattenedMimeTypes[$mimeType] = $format;	288✔
87	}
88	}
89
90	return $flattenedMimeTypes;	288✔
91	}
92
93	/**
94	* Extracts the format from the Content-Type header and check that it is supported.
95	*
96	* @throws UnsupportedMediaTypeHttpException
97	*/
98	private function getInputFormat(HttpOperation $operation, Request $request): ?string
99	{
100	if (
101	false === ($input = $operation->getInput())	289✔
102	\|\| (\is_array($input) && null === $input['class'])	289✔
103	\|\| false === $operation->canDeserialize()	289✔
104	) {
105	return null;	264✔
106	}
107
108	$contentType = $request->headers->get('CONTENT_TYPE');	32✔
109	if (null === $contentType \|\| '' === $contentType) {	32✔
110	return null;	18✔
111	}
112
113	$formats = $operation->getInputFormats() ?? [];	14✔
114	if ($format = $this->getMimeTypeFormat($contentType, $formats)) {	14✔
115	return $format;	12✔
116	}
117
118	if (!$request->isMethodSafe() && 'DELETE' !== $request->getMethod()) {	2✔
119	$supportedMimeTypes = [];	2✔
120	foreach ($formats as $mimeTypes) {	2✔
121	foreach ($mimeTypes as $mimeType) {	1✔
122	$supportedMimeTypes[] = $mimeType;	1✔
123	}
124	}
125
126	throw new UnsupportedMediaTypeHttpException(\sprintf('The content-type "%s" is not supported. Supported MIME types are "%s".', $contentType, implode('", "', $supportedMimeTypes)));	2✔
127	}
128
UNCOV 129	return null;	×
130	}
131	}

api-platform / core / 17439928843

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