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

api-platform / core / 13175309672

06 Feb 2025 09:04AM UTC coverage: 7.663% (-0.2%) from 7.841%
13175309672

push

github

web-flow
fix: ensure template files have a tpl file extension (#6826) (#6829)

2 of 5 new or added lines in 4 files covered. (40.0%)

3676 existing lines in 122 files now uncovered.

13073 of 170593 relevant lines covered (7.66%)

27.3 hits per line

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

0.0
/src/Metadata/Tests/Extractor/Adapter/XmlResourceAdapter.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\Tests\Extractor\Adapter;
15

16
use ApiPlatform\Metadata\Tests\Extractor\ResourceMetadataCompatibilityTest;
17

18
/**
19
 * XML adapter for ResourceMetadataCompatibilityTest.
20
 *
21
 * @author Vincent Chalamon <vincentchalamon@gmail.com>
22
 */
23
final class XmlResourceAdapter implements ResourceAdapterInterface
24
{
25
    private const ATTRIBUTES = [
26
        'uriTemplate',
27
        'shortName',
28
        'description',
29
        'routePrefix',
30
        'stateless',
31
        'sunset',
32
        'class',
33
        'acceptPatch',
34
        'status',
35
        'host',
36
        'condition',
37
        'controller',
38
        'urlGenerationStrategy',
39
        'deprecationReason',
40
        'elasticsearch',
41
        'messenger',
42
        'input',
43
        'output',
44
        'fetchPartial',
45
        'forceEager',
46
        'paginationClientEnabled',
47
        'paginationClientItemsPerPage',
48
        'paginationClientPartial',
49
        'paginationEnabled',
50
        'paginationFetchJoinCollection',
51
        'paginationUseOutputWalkers',
52
        'paginationItemsPerPage',
53
        'paginationMaximumItemsPerPage',
54
        'paginationPartial',
55
        'paginationType',
56
        'processor',
57
        'provider',
58
        'security',
59
        'securityMessage',
60
        'securityPostDenormalize',
61
        'securityPostDenormalizeMessage',
62
        'securityPostValidation',
63
        'securityPostValidationMessage',
64
        'queryParameterValidationEnabled',
65
        'stateOptions',
66
        'collectDenormalizationErrors',
67
        'links',
68
        'parameters',
69
    ];
70

71
    private const EXCLUDE = ['policy', 'middleware', 'rule'];
72

73
    /**
74
     * {@inheritdoc}
75
     */
76
    public function __invoke(string $resourceClass, array $parameters, array $fixtures): array
77
    {
78
        $xml = new \SimpleXMLElement(<<<XML_WRAP
×
79
<?xml version="1.0" encoding="UTF-8" ?>
80
<resources xmlns="https://api-platform.com/schema/metadata/resources-3.0"
81
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
82
           xsi:schemaLocation="https://api-platform.com/schema/metadata/resources-3.0
83
           https://api-platform.com/schema/metadata/resources-3.0.xsd">
84
</resources>
85
XML_WRAP
×
86
        );
×
87

88
        foreach ($fixtures as $fixture) {
×
89
            $resource = $xml->addChild('resource');
×
90

91
            if (null === $fixture) {
×
92
                $resource->addAttribute('class', $resourceClass);
×
93
                continue;
×
94
            }
95

96
            $fixture['class'] = $resourceClass;
×
97
            foreach ($parameters as $parameter) {
×
98
                $parameterName = $parameter->getName();
×
99
                if (\in_array($parameterName, self::EXCLUDE, true)) {
×
100
                    continue;
×
101
                }
102

103
                $value = \array_key_exists($parameterName, $fixture) ? $fixture[$parameterName] : null;
×
104

105
                if ('compositeIdentifier' === $parameterName || 'provider' === $parameterName || 'processor' === $parameterName) {
×
106
                    continue;
×
107
                }
108

109
                if (method_exists($this, 'build'.ucfirst($parameterName))) {
×
110
                    $this->{'build'.ucfirst($parameterName)}($resource, $value);
×
111
                    continue;
×
112
                }
113

114
                if (\in_array($parameterName, self::ATTRIBUTES, true) && \is_scalar($value)) {
×
115
                    $resource->addAttribute($parameterName, $this->parse($value));
×
116
                    continue;
×
117
                }
118

119
                throw new \LogicException(\sprintf('Cannot adapt attribute or child "%s". Please add fixtures in '.ResourceMetadataCompatibilityTest::class.' and create a "%s" method in %s.', $parameterName, 'build'.ucfirst($parameterName), self::class));
×
120
            }
121
        }
122

123
        $filename = __DIR__.'/resources.xml';
×
124
        $xml->asXML($filename);
×
125

126
        return [$filename];
×
127
    }
128

129
    private function buildTypes(\SimpleXMLElement $resource, array $values): void
130
    {
131
        $node = $resource->addChild('types');
×
132
        foreach ($values as $value) {
×
133
            $node->addChild('type', $value);
×
134
        }
135
    }
136

137
    private function buildInputFormats(\SimpleXMLElement $resource, array $values): void
138
    {
139
        $this->buildFormats($resource, $values, 'inputFormats');
×
140
    }
141

142
    private function buildOutputFormats(\SimpleXMLElement $resource, array $values): void
143
    {
144
        $this->buildFormats($resource, $values, 'outputFormats');
×
145
    }
146

147
    private function buildUriVariables(\SimpleXMLElement $resource, array $values): void
148
    {
149
        $child = $resource->addChild('uriVariables');
×
150
        foreach ($values as $parameterName => $value) {
×
151
            $grandChild = $child->addChild('uriVariable');
×
152
            $grandChild->addAttribute('parameterName', $parameterName);
×
153
            if (!isset($value['fromClass'])) {
×
154
                $value['fromClass'] = $value[0];
×
155
                $value['fromProperty'] = $value[1];
×
156
                unset($value[0], $value[1]);
×
157
            }
158
            foreach ($value as $key => $data) {
×
159
                $grandChild->addAttribute($key, $this->parse($data));
×
160
            }
161
        }
162
    }
163

164
    private function buildDefaults(\SimpleXMLElement $resource, array $values): void
165
    {
166
        $this->buildValues($resource->addChild('defaults'), $values);
×
167
    }
168

169
    private function buildMercure(\SimpleXMLElement $resource, $values): void
170
    {
171
        $child = $resource->addChild('mercure');
×
172
        if (\is_array($values)) {
×
173
            foreach ($values as $key => $value) {
×
174
                if (\is_string($key)) {
×
175
                    $child->addAttribute($key, $this->parse($value));
×
176
                }
177
            }
178
        }
179
    }
180

181
    private function buildRequirements(\SimpleXMLElement $resource, array $values): void
182
    {
183
        $node = $resource->addChild('requirements');
×
184
        foreach ($values as $key => $value) {
×
185
            $node->addChild('requirement', $value)->addAttribute('property', $key);
×
186
        }
187
    }
188

189
    private function buildOptions(\SimpleXMLElement $resource, array $values): void
190
    {
191
        $this->buildValues($resource->addChild('options'), $values);
×
192
    }
193

194
    private function buildSchemes(\SimpleXMLElement $resource, array $values): void
195
    {
196
        $node = $resource->addChild('schemes');
×
197
        foreach ($values as $value) {
×
198
            $node->addChild('scheme', $value);
×
199
        }
200
    }
201

202
    private function buildCacheHeaders(\SimpleXMLElement $resource, array $values): void
203
    {
204
        $node = $resource->addChild('cacheHeaders');
×
205
        foreach ($values as $key => $value) {
×
206
            if (\is_array($value)) {
×
207
                $child = $node->addChild('cacheHeader');
×
208
                $this->buildValues($child, $value);
×
209
            } else {
210
                $child = $node->addChild('cacheHeader', $this->parse($value));
×
211
            }
212
            $child->addAttribute('name', $key);
×
213
        }
214
    }
215

216
    private function buildNormalizationContext(\SimpleXMLElement $resource, array $values): void
217
    {
218
        $this->buildValues($resource->addChild('normalizationContext'), $values);
×
219
    }
220

221
    private function buildDenormalizationContext(\SimpleXMLElement $resource, array $values): void
222
    {
223
        $this->buildValues($resource->addChild('denormalizationContext'), $values);
×
224
    }
225

226
    private function buildHydraContext(\SimpleXMLElement $resource, array $values): void
227
    {
228
        $this->buildValues($resource->addChild('hydraContext'), $values);
×
229
    }
230

231
    private function buildOpenapi(\SimpleXMLElement $resource, array $values): void
232
    {
233
        $node = $resource->openapi ?? $resource->addChild('openapi');
×
234

235
        if (isset($values['tags'])) {
×
236
            $tagsNode = $node->tags ?? $node->addChild('tags');
×
237
            foreach ($values['tags'] as $tag) {
×
238
                $tagsNode->addChild('tag', $tag);
×
239
            }
240
        }
241

242
        if (isset($values['responses'])) {
×
243
            $responsesNode = $node->responses ?? $node->addChild('responses');
×
244
            foreach ($values['responses'] as $status => $response) {
×
245
                $responseNode = $responsesNode->addChild('response');
×
246
                $responseNode->addAttribute('status', $status);
×
247
                if (isset($response['description'])) {
×
248
                    $responseNode->addAttribute('description', $response['description']);
×
249
                }
250
                if (isset($response['content'])) {
×
251
                    $this->buildValues($responseNode->addChild('content'), $response['content']);
×
252
                }
253
                if (isset($response['headers'])) {
×
254
                    $this->buildValues($responseNode->addChild('headers'), $response['headers']);
×
255
                }
256
                if (isset($response['links'])) {
×
257
                    $this->buildValues($responseNode->addChild('links'), $response['links']);
×
258
                }
259
            }
260
        }
261

262
        if (isset($values['externalDocs'])) {
×
263
            $externalDocsNode = $node->externalDocs ?? $node->addChild('externalDocs');
×
264
            if (isset($values['externalDocs']['description'])) {
×
265
                $externalDocsNode->addAttribute('description', $values['externalDocs']['description']);
×
266
            }
267
            if (isset($values['url']['description'])) {
×
268
                $externalDocsNode->addAttribute('url', $values['externalDocs']['url']);
×
269
            }
270
        }
271

272
        if (isset($values['parameters'])) {
×
273
            $parametersNode = $node->parameters ?? $node->addChild('parameters');
×
274
            foreach ($values['parameters'] as $name => $parameter) {
×
275
                $parameterNode = $parametersNode->addChild('parameter');
×
276
                $parameterNode->addAttribute('name', $name);
×
277
                if (isset($parameter['in'])) {
×
278
                    $parameterNode->addAttribute('in', $parameter['in']);
×
279
                }
280
                if (isset($parameter['description'])) {
×
281
                    $parameterNode->addAttribute('description', $parameter['description']);
×
282
                }
283
                if (isset($parameter['required'])) {
×
284
                    $parameterNode->addAttribute('required', $parameter['required']);
×
285
                }
286
                if (isset($parameter['deprecated'])) {
×
287
                    $parameterNode->addAttribute('deprecated', $parameter['deprecated']);
×
288
                }
289
                if (isset($parameter['allowEmptyValue'])) {
×
290
                    $parameterNode->addAttribute('allowEmptyValue', $parameter['allowEmptyValue']);
×
291
                }
292
                if (isset($parameter['style'])) {
×
293
                    $parameterNode->addAttribute('style', $parameter['style']);
×
294
                }
295
                if (isset($parameter['explode'])) {
×
296
                    $parameterNode->addAttribute('explode', $parameter['explode']);
×
297
                }
298
                if (isset($parameter['allowReserved'])) {
×
299
                    $parameterNode->addAttribute('allowReserved', $parameter['allowReserved']);
×
300
                }
301
                if (isset($parameter['example'])) {
×
302
                    $parameterNode->addAttribute('example', $parameter['example']);
×
303
                }
304
                if (isset($parameter['schema'])) {
×
305
                    $this->buildValues($parameterNode->addChild('schema'), $parameter['schema']);
×
306
                }
307
                if (isset($parameter['examples'])) {
×
308
                    $this->buildValues($parameterNode->addChild('examples'), $parameter['examples']);
×
309
                }
310
                if (isset($parameter['content'])) {
×
311
                    $this->buildValues($parameterNode->addChild('content'), $parameter['content']);
×
312
                }
313
            }
314
        }
315

316
        if (isset($values['requestBody'])) {
×
317
            $requestBodyNode = $node->requestBody ?? $node->addChild('requestBody');
×
318
            if (isset($values['requestBody']['content'])) {
×
319
                $this->buildValues($requestBodyNode->addChild('content'), $values['requestBody']['content']);
×
320
            }
321
            if (isset($values['requestBody']['description'])) {
×
322
                $requestBodyNode->addAttribute('description', $values['requestBody']['description']);
×
323
            }
324
            if (isset($values['requestBody']['required'])) {
×
325
                $requestBodyNode->addAttribute('required', $values['requestBody']['required']);
×
326
            }
327
        }
328

329
        if (isset($values['callbacks'])) {
×
330
            $this->buildValues($node->callbacks ?? $node->addChild('callbacks'), $values['callbacks']);
×
331
        }
332

333
        if (isset($values['security'])) {
×
334
            $this->buildValues($node->security ?? $node->addChild('security'), $values['security']);
×
335
        }
336

337
        if (isset($values['servers'])) {
×
338
            $serversNode = $node->servers ?? $node->addChild('servers');
×
339
            foreach ($values['servers'] as $server) {
×
340
                $serverNode = $serversNode->addChild('serverNode');
×
341
                if (isset($server['url'])) {
×
342
                    $serverNode->addAttribute('url', $server['url']);
×
343
                }
344
                if (isset($server['description'])) {
×
345
                    $serverNode->addAttribute('description', $server['description']);
×
346
                }
347
                if (isset($server['variables'])) {
×
348
                    $this->buildValues($serverNode->addChild('variables'), $server['variables']);
×
349
                }
350
            }
351
        }
352

353
        if (isset($values['extensionProperties'])) {
×
354
            $this->buildValues($node->extensionProperties ?? $node->addChild('extensionProperties'), $values['extensionProperties']);
×
355
        }
356
    }
357

358
    private function buildValidationContext(\SimpleXMLElement $resource, array $values): void
359
    {
360
        $this->buildValues($resource->addChild('validationContext'), $values);
×
361
    }
362

363
    private function buildFilters(\SimpleXMLElement $resource, array $values): void
364
    {
365
        $node = $resource->addChild('filters');
×
366
        foreach ($values as $value) {
×
367
            $node->addChild('filter', $value);
×
368
        }
369
    }
370

371
    private function buildOrder(\SimpleXMLElement $resource, array $values): void
372
    {
373
        $this->buildValues($resource->addChild('order'), $values);
×
374
    }
375

376
    private function buildPaginationViaCursor(\SimpleXMLElement $resource, array $values): void
377
    {
378
        $node = $resource->addChild('paginationViaCursor');
×
379
        foreach ($values as $key => $value) {
×
380
            $child = $node->addChild('paginationField');
×
381
            $child->addAttribute('field', $key);
×
382
            $child->addAttribute('direction', $value);
×
383
        }
384
    }
385

386
    private function buildExceptionToStatus(\SimpleXMLElement $resource, array $values): void
387
    {
388
        $node = $resource->addChild('exceptionToStatus');
×
389
        foreach ($values as $key => $value) {
×
390
            $child = $node->addChild('exception');
×
391
            $child->addAttribute('class', $key);
×
392
            $child->addAttribute('statusCode', $this->parse($value));
×
393
        }
394
    }
395

396
    private function buildExtraProperties(\SimpleXMLElement $resource, array $values): void
397
    {
398
        $this->buildValues($resource->addChild('extraProperties'), $values);
×
399
    }
400

401
    private function buildArgs(\SimpleXMLElement $resource, array $args): void
402
    {
403
        $child = $resource->addChild('args');
×
404
        foreach ($args as $id => $values) {
×
405
            $grandChild = $child->addChild('arg');
×
406
            $grandChild->addAttribute('id', $id);
×
407
            $this->buildValues($grandChild, $values);
×
408
        }
409
    }
410

411
    private function buildExtraArgs(\SimpleXMLElement $resource, array $args): void
412
    {
413
        $child = $resource->addChild('extraArgs');
×
414
        foreach ($args as $id => $values) {
×
415
            $grandChild = $child->addChild('arg');
×
416
            $grandChild->addAttribute('id', $id);
×
417
            $this->buildValues($grandChild, $values);
×
418
        }
419
    }
420

421
    private function buildGraphQlOperations(\SimpleXMLElement $resource, array $values): void
422
    {
423
        $node = $resource->addChild('graphQlOperations');
×
424
        foreach ($values as $value) {
×
425
            $child = $node->addChild('graphQlOperation');
×
426
            foreach ($value as $index => $data) {
×
427
                if (method_exists($this, 'build'.ucfirst($index))) {
×
428
                    $this->{'build'.ucfirst($index)}($child, $data);
×
429
                    continue;
×
430
                }
431

432
                if (\is_string($data) || null === $data || is_numeric($data) || \is_bool($data)) {
×
433
                    $child->addAttribute($index, $this->parse($data));
×
434
                    continue;
×
435
                }
436

437
                throw new \LogicException(\sprintf('Cannot adapt graphQlOperation attribute or child "%s". Please create a "%s" method in %s.', $index, 'build'.ucfirst($index), self::class));
×
438
            }
439
        }
440
    }
441

442
    private function buildOperations(\SimpleXMLElement $resource, array $values): void
443
    {
444
        $node = $resource->addChild('operations');
×
445
        foreach ($values as $value) {
×
446
            $child = $node->addChild('operation');
×
447
            foreach ($value as $index => $data) {
×
448
                if (method_exists($this, 'build'.ucfirst($index))) {
×
449
                    $this->{'build'.ucfirst($index)}($child, $data);
×
450
                    continue;
×
451
                }
452

453
                if (\is_string($data) || null === $data || is_numeric($data) || \is_bool($data)) {
×
454
                    $child->addAttribute($index, $this->parse($data));
×
455
                    continue;
×
456
                }
457

458
                throw new \LogicException(\sprintf('Cannot adapt operation attribute or child "%s". Please create a "%s" method in %s.', $index, 'build'.ucfirst($index), self::class));
×
459
            }
460
        }
461
    }
462

463
    private function buildFormats(\SimpleXMLElement $resource, array $values, string $name = 'formats'): void
464
    {
465
        $node = $resource->addChild($name);
×
466
        foreach ($values as $key => $value) {
×
467
            $node->addChild('format', $value)->addAttribute('name', $key);
×
468
        }
469
    }
470

471
    private function buildStateOptions(\SimpleXMLElement $resource, array $values): void
472
    {
473
        $node = $resource->addChild('stateOptions');
×
474
        $childNode = $node->addChild(array_key_first($values));
×
475
        $childNode->addAttribute('index', $values[array_key_first($values)]['index']);
×
476
        $childNode->addAttribute('type', $values[array_key_first($values)]['type']);
×
477
    }
478

479
    private function buildValues(\SimpleXMLElement $resource, array $values): void
480
    {
481
        $node = $resource->addChild('values');
×
482
        foreach ($values as $key => $value) {
×
483
            if (\is_array($value)) {
×
484
                $child = $node->addChild('value');
×
485
                $this->buildValues($child, $value);
×
486
            } else {
487
                $child = $node->addChild('value', $value);
×
488
            }
489
            if (\is_string($key)) {
×
490
                $child->addAttribute('name', $key);
×
491
            }
492
        }
493
    }
494

495
    private function buildLinks(\SimpleXMLElement $resource, ?array $values = null): void
496
    {
497
        if (!$values) {
×
498
            return;
×
499
        }
500

501
        $node = $resource->addChild('links');
×
502
        $childNode = $node->addChild('link');
×
503
        $childNode->addAttribute('rel', $values[0]['rel']);
×
504
        $childNode->addAttribute('href', $values[0]['href']);
×
505
    }
506

507
    private function buildRules(\SimpleXMLElement $resource, ?array $values = null): void
508
    {
509
    }
×
510

511
    private function buildHeaders(\SimpleXMLElement $resource, ?array $values = null): void
512
    {
513
        if (!$values) {
×
514
            return;
×
515
        }
516

517
        $node = $resource->addChild('headers');
×
518
        foreach ($values as $key => $value) {
×
519
            $childNode = $node->addChild('header');
×
520
            $childNode->addAttribute('key', $key);
×
521
            $childNode->addAttribute('value', $value);
×
522
        }
523
    }
524

525
    private function buildParameters(\SimpleXMLElement $resource, ?array $values = null): void
526
    {
527
        if (!$values) {
×
528
            return;
×
529
        }
530

531
        $node = $resource->addChild('parameters');
×
532
        foreach ($values as $key => $value) {
×
533
            $childNode = $node->addChild('parameter');
×
534
            $childNode->addAttribute('in', 'query');
×
535
            $childNode->addAttribute('key', $key);
×
536

537
            if (\array_key_exists('required', $value)) {
×
UNCOV
538
                $childNode->addAttribute('required', $this->parse($value['required']));
×
539
            }
540

UNCOV
541
            if (\array_key_exists('schema', $value)) {
×
UNCOV
542
                $this->buildValues($childNode->addChild('schema'), $value['schema']);
×
543
            }
544
        }
545
    }
546

547
    private function parse($value): ?string
548
    {
UNCOV
549
        if (null === $value) {
×
UNCOV
550
            return null;
×
551
        }
552

UNCOV
553
        return \is_bool($value) ? (true === $value ? 'true' : 'false') : (string) $value;
×
554
    }
555
}
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