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

api-platform / core / 6067528200

04 Sep 2023 12:12AM UTC coverage: 36.875% (-21.9%) from 58.794%
6067528200

Pull #5791

github

web-flow
Merge 64157e578 into d09cfc9d2
Pull Request #5791: fix: strip down any sql function name

3096 of 3096 new or added lines in 205 files covered. (100.0%)

9926 of 26918 relevant lines covered (36.87%)

6.5 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
    ];
69

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

85
        foreach ($fixtures as $fixture) {
×
86
            $resource = $xml->addChild('resource');
×
87

88
            if (null === $fixture) {
×
89
                $resource->addAttribute('class', $resourceClass);
×
90
                continue;
×
91
            }
92

93
            $fixture['class'] = $resourceClass;
×
94
            foreach ($parameters as $parameter) {
×
95
                $parameterName = $parameter->getName();
×
96
                $value = \array_key_exists($parameterName, $fixture) ? $fixture[$parameterName] : null;
×
97

98
                if ('compositeIdentifier' === $parameterName || 'provider' === $parameterName || 'processor' === $parameterName) {
×
99
                    continue;
×
100
                }
101

102
                if (method_exists($this, 'build'.ucfirst($parameterName))) {
×
103
                    $this->{'build'.ucfirst($parameterName)}($resource, $value);
×
104
                    continue;
×
105
                }
106

107
                if (\in_array($parameterName, self::ATTRIBUTES, true) && \is_scalar($value)) {
×
108
                    $resource->addAttribute($parameterName, $this->parse($value));
×
109
                    continue;
×
110
                }
111

112
                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));
×
113
            }
114
        }
115

116
        $filename = __DIR__.'/resources.xml';
×
117
        $xml->asXML($filename);
×
118

119
        return [$filename];
×
120
    }
121

122
    private function buildTypes(\SimpleXMLElement $resource, array $values): void
123
    {
124
        $node = $resource->addChild('types');
×
125
        foreach ($values as $value) {
×
126
            $node->addChild('type', $value);
×
127
        }
128
    }
129

130
    private function buildInputFormats(\SimpleXMLElement $resource, array $values): void
131
    {
132
        $this->buildFormats($resource, $values, 'inputFormats');
×
133
    }
134

135
    private function buildOutputFormats(\SimpleXMLElement $resource, array $values): void
136
    {
137
        $this->buildFormats($resource, $values, 'outputFormats');
×
138
    }
139

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

157
    private function buildDefaults(\SimpleXMLElement $resource, array $values): void
158
    {
159
        $this->buildValues($resource->addChild('defaults'), $values);
×
160
    }
161

162
    private function buildMercure(\SimpleXMLElement $resource, $values): void
163
    {
164
        $child = $resource->addChild('mercure');
×
165
        if (\is_array($values)) {
×
166
            foreach ($values as $key => $value) {
×
167
                if (\is_string($key)) {
×
168
                    $child->addAttribute($key, $this->parse($value));
×
169
                }
170
            }
171
        }
172
    }
173

174
    private function buildRequirements(\SimpleXMLElement $resource, array $values): void
175
    {
176
        $node = $resource->addChild('requirements');
×
177
        foreach ($values as $key => $value) {
×
178
            $node->addChild('requirement', $value)->addAttribute('property', $key);
×
179
        }
180
    }
181

182
    private function buildOptions(\SimpleXMLElement $resource, array $values): void
183
    {
184
        $this->buildValues($resource->addChild('options'), $values);
×
185
    }
186

187
    private function buildSchemes(\SimpleXMLElement $resource, array $values): void
188
    {
189
        $node = $resource->addChild('schemes');
×
190
        foreach ($values as $value) {
×
191
            $node->addChild('scheme', $value);
×
192
        }
193
    }
194

195
    private function buildCacheHeaders(\SimpleXMLElement $resource, array $values): void
196
    {
197
        $node = $resource->addChild('cacheHeaders');
×
198
        foreach ($values as $key => $value) {
×
199
            if (\is_array($value)) {
×
200
                $child = $node->addChild('cacheHeader');
×
201
                $this->buildValues($child, $value);
×
202
            } else {
203
                $child = $node->addChild('cacheHeader', $this->parse($value));
×
204
            }
205
            $child->addAttribute('name', $key);
×
206
        }
207
    }
208

209
    private function buildNormalizationContext(\SimpleXMLElement $resource, array $values): void
210
    {
211
        $this->buildValues($resource->addChild('normalizationContext'), $values);
×
212
    }
213

214
    private function buildDenormalizationContext(\SimpleXMLElement $resource, array $values): void
215
    {
216
        $this->buildValues($resource->addChild('denormalizationContext'), $values);
×
217
    }
218

219
    private function buildHydraContext(\SimpleXMLElement $resource, array $values): void
220
    {
221
        $this->buildValues($resource->addChild('hydraContext'), $values);
×
222
    }
223

224
    /**
225
     * TODO Remove in 4.0.
226
     *
227
     * @deprecated
228
     */
229
    private function buildOpenapiContext(\SimpleXMLElement $resource, array $values): void
230
    {
231
        $this->buildValues($resource->addChild('openapiContext'), $values);
×
232
    }
233

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

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

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

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

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

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

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

336
        if (isset($values['security'])) {
×
337
            $this->buildValues($node->security ?? $node->addChild('security'), $values['security']);
×
338
        }
339

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

498
    private function buildLinks(\SimpleXMLElement $resource, array $values = null): void
499
    {
500
        if (!$values) {
×
501
            return;
×
502
        }
503

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

510
    private function parse($value): ?string
511
    {
512
        if (null === $value) {
×
513
            return null;
×
514
        }
515

516
        return \is_bool($value) ? (true === $value ? 'true' : 'false') : (string) $value;
×
517
    }
518
}
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

© 2026 Coveralls, Inc