• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

api-platform / core / 19164609113

07 Nov 2025 09:50AM UTC coverage: 0.0% (-24.0%) from 23.965%
19164609113

push

github

web-flow
chore: malformed json (#7512)

0 of 56687 relevant lines covered (0.0%)

0.0 hits per line

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

0.0
/src/Metadata/Resource/Factory/FormatsResourceMetadataCollectionFactory.php
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\Metadata\Resource\Factory;
15

16
use ApiPlatform\Metadata\CollectionOperationInterface;
17
use ApiPlatform\Metadata\ErrorResource;
18
use ApiPlatform\Metadata\Exception\InvalidArgumentException;
19
use ApiPlatform\Metadata\Exception\ResourceClassNotFoundException;
20
use ApiPlatform\Metadata\HttpOperation;
21
use ApiPlatform\Metadata\Operations;
22
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
23

24
/**
25
 * Normalizes enabled formats.
26
 *
27
 * Formats hierarchy:
28
 * * resource formats
29
 *   * resource input/output formats
30
 *     * operation formats
31
 *       * operation input/output formats
32
 *
33
 * @author Kévin Dunglas <dunglas@gmail.com>
34
 */
35
final class FormatsResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface
36
{
37
    public function __construct(
38
        private readonly ResourceMetadataCollectionFactoryInterface $decorated,
39
        private readonly array $formats,
40
        private readonly array $patchFormats,
41
        private readonly ?array $errorFormats = null,
42
    ) {
43
    }
×
44

45
    /**
46
     * Adds the formats attributes.
47
     *
48
     * @see UriTemplateResourceMetadataCollectionFactory
49
     *
50
     * @throws ResourceClassNotFoundException
51
     */
52
    public function create(string $resourceClass): ResourceMetadataCollection
53
    {
54
        $resourceMetadataCollection = $this->decorated->create($resourceClass);
×
55

56
        foreach ($resourceMetadataCollection as $index => $resourceMetadata) {
×
57
            $rawResourceFormats = $resourceMetadata->getFormats();
×
58
            $resourceFormats = null === $rawResourceFormats ? $this->formats : $this->normalizeFormats($rawResourceFormats);
×
59
            $resourceInputFormats = $resourceMetadata->getInputFormats() ? $this->normalizeFormats($resourceMetadata->getInputFormats()) : $resourceFormats;
×
60
            $resourceOutputFormats = $resourceMetadata->getOutputFormats() ? $this->normalizeFormats($resourceMetadata->getOutputFormats()) : $resourceFormats;
×
61
            if ($resourceMetadata instanceof ErrorResource) {
×
62
                $resourceOutputFormats = $resourceMetadata->getOutputFormats() ? $this->normalizeFormats($resourceMetadata->getOutputFormats()) : ($this->errorFormats ?? []);
×
63
            }
64

65
            $resourceMetadataCollection[$index] = $resourceMetadataCollection[$index]->withOperations($this->normalize($resourceInputFormats, $resourceOutputFormats, $resourceMetadata->getOperations()));
×
66
        }
67

68
        return $resourceMetadataCollection;
×
69
    }
70

71
    /**
72
     * @param Operations<HttpOperation> $operations
73
     */
74
    private function normalize(array $resourceInputFormats, array $resourceOutputFormats, Operations $operations): Operations
75
    {
76
        $newOperations = [];
×
77
        $patchFormats = null;
×
78
        foreach ($operations as $operationName => $operation) {
×
79
            if ($operation->getFormats()) {
×
80
                $operation = $operation->withFormats($this->normalizeFormats($operation->getFormats()));
×
81
            }
82

83
            if (($isPatch = 'PATCH' === $operation->getMethod()) && !$operation->getFormats() && !$operation->getInputFormats()) {
×
84
                $operation = $operation->withInputFormats($this->patchFormats);
×
85
            }
86

87
            $operation = $operation->withInputFormats($operation->getInputFormats() ? $this->normalizeFormats($operation->getInputFormats()) : $operation->getFormats() ?? $resourceInputFormats);
×
88
            $operation = $operation->withOutputFormats($operation->getOutputFormats() ? $this->normalizeFormats($operation->getOutputFormats()) : $operation->getFormats() ?? $resourceOutputFormats);
×
89

90
            if ($isPatch) {
×
91
                $patchFormats = $operation->getInputFormats();
×
92
            }
93

94
            $newOperations[$operationName] = $operation;
×
95
        }
96

97
        if (!$patchFormats) {
×
98
            return new Operations($newOperations);
×
99
        }
100

101
        // Prepare an Accept-Patch header
102
        foreach ($newOperations as $operationName => $operation) {
×
103
            if ($operation instanceof CollectionOperationInterface) {
×
104
                continue;
×
105
            }
106

107
            $patchMimeTypes = [];
×
108

109
            foreach ($patchFormats as $mimeTypes) {
×
110
                foreach ($mimeTypes as $mimeType) {
×
111
                    $patchMimeTypes[] = $mimeType;
×
112
                }
113
            }
114

115
            $newOperations[$operationName] = $operation->withAcceptPatch(implode(', ', $patchMimeTypes));
×
116
        }
117

118
        return new Operations($newOperations);
×
119
    }
120

121
    /**
122
     * @throws InvalidArgumentException
123
     */
124
    private function normalizeFormats(array|string $currentFormats): array
125
    {
126
        $currentFormats = (array) $currentFormats;
×
127

128
        $normalizedFormats = [];
×
129
        foreach ($currentFormats as $format => $value) {
×
130
            if (!is_numeric($format)) {
×
131
                $normalizedFormats[$format] = (array) $value;
×
132
                continue;
×
133
            }
134
            if (!\is_string($value)) {
×
135
                throw new InvalidArgumentException(\sprintf("The 'formats' attributes value must be a string when trying to include an already configured format, %s given.", \gettype($value)));
×
136
            }
137
            if (\array_key_exists($value, $this->formats)) {
×
138
                $normalizedFormats[$value] = $this->formats[$value];
×
139
                continue;
×
140
            }
141

142
            throw new InvalidArgumentException(\sprintf("You either need to add the format '%s' to your project configuration or declare a mime type for it in your annotation.", $value));
×
143
        }
144

145
        return $normalizedFormats;
×
146
    }
147
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc