7275126587

Committed 20 Dec 2023 12:09PM UTC coverage: 37.298% (+0.04%) from 37.262%

Build # 7275126587

Build Type

push

github

Committed by

soyuka

Commit Message

Merge 3.2

Run Details

24 of 134 new or added lines in 24 files covered. (17.91%)

4 existing lines in 2 files now uncovered.

10338 of 27717 relevant lines covered (37.3%)

28.58 hits per line

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

54.04

/src/Metadata/Extractor/XmlResourceExtractor.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\Metadata\Extractor;

use ApiPlatform\Metadata\Exception\InvalidArgumentException;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\Tests\Fixtures\StateOptions;
use ApiPlatform\OpenApi\Model\ExternalDocumentation;
use ApiPlatform\OpenApi\Model\Operation as OpenApiOperation;
use ApiPlatform\OpenApi\Model\Parameter;
use ApiPlatform\OpenApi\Model\RequestBody;
use ApiPlatform\State\OptionsInterface;
use Symfony\Component\Config\Util\XmlUtils;
use Symfony\Component\WebLink\Link;

/**
 * Extracts an array of metadata from a list of XML files.
 *
 * @author Vincent Chalamon <vincentchalamon@gmail.com>
 */
final class XmlResourceExtractor extends AbstractResourceExtractor
{
    use ResourceExtractorTrait;

    public const SCHEMA = __DIR__.'/schema/resources.xsd';

    /**
     * {@inheritdoc}
     */
    protected function extractPath(string $path): void
    {
        try {
            /** @var \SimpleXMLElement $xml */
            $xml = simplexml_import_dom(XmlUtils::loadFile($path, self::SCHEMA));
        } catch (\InvalidArgumentException $e) {
            // Ensure it's not a resource
            try {
                simplexml_import_dom(XmlUtils::loadFile($path, XmlPropertyExtractor::SCHEMA));
            } catch (\InvalidArgumentException) {
                throw new InvalidArgumentException(sprintf('Error while parsing %s: %s', $path, $e->getMessage()), $e->getCode(), $e);
            }

            // It's a property: ignore error
            return;
        }

        foreach ($xml->resource as $resource) {
            $base = $this->buildExtendedBase($resource);
            $this->resources[$this->resolve((string) $resource['class'])][] = array_merge($base, [
                'class' => $this->phpize($resource, 'class', 'string'),
                'operations' => $this->buildOperations($resource, $base),
                'graphQlOperations' => $this->buildGraphQlOperations($resource, $base),
            ]);
        }
    }

    private function buildExtendedBase(\SimpleXMLElement $resource): array
    {
        return array_merge($this->buildBase($resource), [
            'uriTemplate' => $this->phpize($resource, 'uriTemplate', 'string'),
            'routePrefix' => $this->phpize($resource, 'routePrefix', 'string'),
            'stateless' => $this->phpize($resource, 'stateless', 'bool'),
            'sunset' => $this->phpize($resource, 'sunset', 'string'),
            'acceptPatch' => $this->phpize($resource, 'acceptPatch', 'string'),
            'status' => $this->phpize($resource, 'status', 'integer'),
            'host' => $this->phpize($resource, 'host', 'string'),
            'condition' => $this->phpize($resource, 'condition', 'string'),
            'controller' => $this->phpize($resource, 'controller', 'string'),
            'types' => $this->buildArrayValue($resource, 'type'),
            'formats' => $this->buildFormats($resource, 'formats'),
            'inputFormats' => $this->buildFormats($resource, 'inputFormats'),
            'outputFormats' => $this->buildFormats($resource, 'outputFormats'),
            'uriVariables' => $this->buildUriVariables($resource),
            'defaults' => isset($resource->defaults->values) ? $this->buildValues($resource->defaults->values) : null,
            'requirements' => $this->buildRequirements($resource),
            'options' => isset($resource->options->values) ? $this->buildValues($resource->options->values) : null,
            'schemes' => $this->buildArrayValue($resource, 'scheme'),
            'cacheHeaders' => $this->buildCacheHeaders($resource),
            'hydraContext' => isset($resource->hydraContext->values) ? $this->buildValues($resource->hydraContext->values) : null,
            'openapiContext' => isset($resource->openapiContext->values) ? $this->buildValues($resource->openapiContext->values) : null, // TODO Remove in 4.0
            'openapi' => $this->buildOpenapi($resource),
            'paginationViaCursor' => $this->buildPaginationViaCursor($resource),
            'exceptionToStatus' => $this->buildExceptionToStatus($resource),
            'queryParameterValidationEnabled' => $this->phpize($resource, 'queryParameterValidationEnabled', 'bool'),
            'stateOptions' => $this->buildStateOptions($resource),
            'links' => $this->buildLinks($resource),
        ]);
    }

    private function buildBase(\SimpleXMLElement $resource): array
    {
        return [
            'shortName' => $this->phpize($resource, 'shortName', 'string'),
            'description' => $this->phpize($resource, 'description', 'string'),
            'urlGenerationStrategy' => $this->phpize($resource, 'urlGenerationStrategy', 'integer'),
            'deprecationReason' => $this->phpize($resource, 'deprecationReason', 'string'),
            'elasticsearch' => $this->phpize($resource, 'elasticsearch', 'bool'),
            'messenger' => $this->phpize($resource, 'messenger', 'bool|string'),
            'mercure' => $this->buildMercure($resource),
            'input' => $this->phpize($resource, 'input', 'bool|string'),
            'output' => $this->phpize($resource, 'output', 'bool|string'),
            'fetchPartial' => $this->phpize($resource, 'fetchPartial', 'bool'),
            'forceEager' => $this->phpize($resource, 'forceEager', 'bool'),
            'paginationClientEnabled' => $this->phpize($resource, 'paginationClientEnabled', 'bool'),
            'paginationClientItemsPerPage' => $this->phpize($resource, 'paginationClientItemsPerPage', 'bool'),
            'paginationClientPartial' => $this->phpize($resource, 'paginationClientPartial', 'bool'),
            'paginationEnabled' => $this->phpize($resource, 'paginationEnabled', 'bool'),
            'paginationFetchJoinCollection' => $this->phpize($resource, 'paginationFetchJoinCollection', 'bool'),
            'paginationUseOutputWalkers' => $this->phpize($resource, 'paginationUseOutputWalkers', 'bool'),
            'paginationItemsPerPage' => $this->phpize($resource, 'paginationItemsPerPage', 'integer'),
            'paginationMaximumItemsPerPage' => $this->phpize($resource, 'paginationMaximumItemsPerPage', 'integer'),
            'paginationPartial' => $this->phpize($resource, 'paginationPartial', 'bool'),
            'paginationType' => $this->phpize($resource, 'paginationType', 'string'),
            'processor' => $this->phpize($resource, 'processor', 'string'),
            'provider' => $this->phpize($resource, 'provider', 'string'),
            'security' => $this->phpize($resource, 'security', 'string'),
            'securityMessage' => $this->phpize($resource, 'securityMessage', 'string'),
            'securityPostDenormalize' => $this->phpize($resource, 'securityPostDenormalize', 'string'),
            'securityPostDenormalizeMessage' => $this->phpize($resource, 'securityPostDenormalizeMessage', 'string'),
            'securityPostValidation' => $this->phpize($resource, 'securityPostValidation', 'string'),
            'securityPostValidationMessage' => $this->phpize($resource, 'securityPostValidationMessage', 'string'),
            'normalizationContext' => isset($resource->normalizationContext->values) ? $this->buildValues($resource->normalizationContext->values) : null,
            'denormalizationContext' => isset($resource->denormalizationContext->values) ? $this->buildValues($resource->denormalizationContext->values) : null,
            'collectDenormalizationErrors' => $this->phpize($resource, 'collectDenormalizationErrors', 'bool'),
            'validationContext' => isset($resource->validationContext->values) ? $this->buildValues($resource->validationContext->values) : null,
            'filters' => $this->buildArrayValue($resource, 'filter'),
            'order' => isset($resource->order->values) ? $this->buildValues($resource->order->values) : null,
            'extraProperties' => $this->buildExtraProperties($resource, 'extraProperties'),
            'read' => $this->phpize($resource, 'read', 'bool'),
            'write' => $this->phpize($resource, 'write', 'bool'),
        ];
    }

    private function buildFormats(\SimpleXMLElement $resource, string $key): ?array
    {
        if (!isset($resource->{$key}->format)) {
            return null;
        }

        $data = [];
        foreach ($resource->{$key}->format as $format) {
            if (isset($format['name'])) {
                $data[(string) $format['name']] = (string) $format;
                continue;
            }

            $data[] = (string) $format;
        }

        return $data;
    }

    private function buildOpenapi(\SimpleXMLElement $resource): bool|OpenApiOperation|null
    {
        if (!isset($resource->openapi) && !isset($resource['openapi'])) {
            return null;
        }

        if (isset($resource['openapi']) && \in_array((string) $resource['openapi'], ['1', '0', 'true', 'false'], true)) {
            return $this->phpize($resource, 'openapi', 'bool');
        }

        $openapi = $resource->openapi;
        $data = [];
        $attributes = $openapi->attributes();
        foreach ($attributes as $attribute) {
            $data[$attribute->getName()] = $this->phpize($attributes, 'deprecated', 'deprecated' === $attribute->getName() ? 'bool' : 'string');
        }

        $data['tags'] = $this->buildArrayValue($resource, 'tag');

        if (isset($openapi->responses->response)) {
            foreach ($openapi->responses->response as $response) {
                $data['responses'][(string) $response->attributes()->status] = [
                    'description' => $this->phpize($response, 'description', 'string'),
                    'content' => isset($response->content->values) ? $this->buildValues($response->content->values) : null,
                    'headers' => isset($response->headers->values) ? $this->buildValues($response->headers->values) : null,
                    'links' => isset($response->links->values) ? $this->buildValues($response->links->values) : null,
                ];
            }
        }

        $data['externalDocs'] = isset($openapi->externalDocs) ? new ExternalDocumentation(
            description: $this->phpize($resource, 'description', 'string'),
            url: $this->phpize($resource, 'url', 'string'),
        ) : null;

        if (isset($openapi->parameters->parameter)) {
            foreach ($openapi->parameters->parameter as $parameter) {
                $data['parameters'][(string) $parameter->attributes()->name] = new Parameter(
                    name: $this->phpize($parameter, 'name', 'string'),
                    in: $this->phpize($parameter, 'in', 'string'),
                    description: $this->phpize($parameter, 'description', 'string'),
                    required: $this->phpize($parameter, 'required', 'bool'),
                    deprecated: $this->phpize($parameter, 'deprecated', 'bool'),
                    allowEmptyValue: $this->phpize($parameter, 'allowEmptyValue', 'bool'),
                    schema: isset($parameter->schema->values) ? $this->buildValues($parameter->schema->values) : null,
                    style: $this->phpize($parameter, 'style', 'string'),
                    explode: $this->phpize($parameter, 'explode', 'bool'),
                    allowReserved: $this->phpize($parameter, 'allowReserved', 'bool'),
                    example: $this->phpize($parameter, 'example', 'string'),
                    examples: isset($parameter->examples->values) ? new \ArrayObject($this->buildValues($parameter->examples->values)) : null,
                    content: isset($parameter->content->values) ? new \ArrayObject($this->buildValues($parameter->content->values)) : null,
                );
            }
        }
        $data['requestBody'] = isset($openapi->requestBody) ? new RequestBody(
            description: $this->phpize($openapi->requestBody, 'description', 'string'),
            content: isset($openapi->requestBody->content->values) ? new \ArrayObject($this->buildValues($openapi->requestBody->content->values)) : null,
            required: $this->phpize($openapi->requestBody, 'required', 'bool'),
        ) : null;

        $data['callbacks'] = isset($openapi->callbacks->values) ? new \ArrayObject($this->buildValues($openapi->callbacks->values)) : null;

        $data['security'] = isset($openapi->security->values) ? $this->buildValues($openapi->security->values) : null;

        if (isset($openapi->servers->server)) {
            foreach ($openapi->servers->server as $server) {
                $data['servers'][] = [
                    'description' => $this->phpize($server, 'description', 'string'),
                    'url' => $this->phpize($server, 'url', 'string'),
                    'variables' => isset($server->variables->values) ? $this->buildValues($server->variables->values) : null,
                ];
            }
        }

        $data['extensionProperties'] = isset($openapi->extensionProperties->values) ? $this->buildValues($openapi->extensionProperties->values) : null;

        foreach ($data as $key => $value) {
            if (null === $value) {
                unset($data[$key]);
            }
        }

        return new OpenApiOperation(...$data);
    }

    private function buildUriVariables(\SimpleXMLElement $resource): ?array
    {
        if (!isset($resource->uriVariables->uriVariable)) {
            return null;
        }

        $uriVariables = [];
        foreach ($resource->uriVariables->uriVariable as $data) {
            $parameterName = (string) $data['parameterName'];
            if (1 === (null === $data->attributes() ? 0 : \count($data->attributes()))) {
                $uriVariables[$parameterName] = $parameterName;
                continue;
            }

            if ($fromProperty = $this->phpize($data, 'fromProperty', 'string')) {
                $uriVariables[$parameterName]['from_property'] = $fromProperty;
            }
            if ($toProperty = $this->phpize($data, 'toProperty', 'string')) {
                $uriVariables[$parameterName]['to_property'] = $toProperty;
            }
            if ($fromClass = $this->phpize($data, 'fromClass', 'string')) {
                $uriVariables[$parameterName]['from_class'] = $fromClass;
            }
            if ($toClass = $this->phpize($data, 'toClass', 'string')) {
                $uriVariables[$parameterName]['to_class'] = $toClass;
            }
            if (isset($data->identifiers->values)) {
                $uriVariables[$parameterName]['identifiers'] = $this->buildValues($data->identifiers->values);
            }
            if (null !== ($compositeIdentifier = $this->phpize($data, 'compositeIdentifier', 'bool'))) {
                $uriVariables[$parameterName]['composite_identifier'] = $compositeIdentifier;
            }
        }

        return $uriVariables;
    }

    private function buildCacheHeaders(\SimpleXMLElement $resource): ?array
    {
        if (!isset($resource->cacheHeaders->cacheHeader)) {
            return null;
        }

        $data = [];
        foreach ($resource->cacheHeaders->cacheHeader as $cacheHeader) {
            if (isset($cacheHeader->values->value)) {
                $data[(string) $cacheHeader['name']] = $this->buildValues($cacheHeader->values);
                continue;
            }

            $data[(string) $cacheHeader['name']] = (string) $cacheHeader;
        }

        return $data;
    }

    private function buildRequirements(\SimpleXMLElement $resource): ?array
    {
        if (!isset($resource->requirements->requirement)) {
            return null;
        }

        $data = [];
        foreach ($resource->requirements->requirement as $requirement) {
            $data[(string) $requirement->attributes()->property] = (string) $requirement;
        }

        return $data;
    }

    private function buildMercure(\SimpleXMLElement $resource): array|bool|null
    {
        if (!isset($resource->mercure)) {
            return null;
        }

        if (null !== $resource->mercure->attributes()->private) {
            return ['private' => $this->phpize($resource->mercure->attributes(), 'private', 'bool')];
        }

        return true;
    }

    private function buildPaginationViaCursor(\SimpleXMLElement $resource): ?array
    {
        if (!isset($resource->paginationViaCursor->paginationField)) {
            return null;
        }

        $data = [];
        foreach ($resource->paginationViaCursor->paginationField as $paginationField) {
            $data[(string) $paginationField['field']] = (string) $paginationField['direction'];
        }

        return $data;
    }

    private function buildExceptionToStatus(\SimpleXMLElement $resource): ?array
    {
        if (!isset($resource->exceptionToStatus->exception)) {
            return null;
        }

        $data = [];
        foreach ($resource->exceptionToStatus->exception as $exception) {
            $data[(string) $exception['class']] = (int) $exception['statusCode'];
        }

        return $data;
    }

    private function buildExtraProperties(\SimpleXMLElement $resource, string $key = null): ?array
    {
        if (null !== $key) {
            if (!isset($resource->{$key})) {
                return null;
            }

            $resource = $resource->{$key};
        }

        return $this->buildValues($resource->values);
    }

    private function buildOperations(\SimpleXMLElement $resource, array $root): ?array
    {
        if (!isset($resource->operations->operation)) {
            return null;
        }

        $data = [];
        foreach ($resource->operations->operation as $operation) {
            $datum = $this->buildExtendedBase($operation);
            foreach ($datum as $key => $value) {
                if (null === $value) {
                    $datum[$key] = $root[$key];
                }
            }

            if (\in_array((string) $operation['class'], [GetCollection::class, Post::class], true)) {
                $datum['itemUriTemplate'] = $this->phpize($operation, 'itemUriTemplate', 'string');
            } elseif (isset($operation['itemUriTemplate'])) {
                throw new InvalidArgumentException(sprintf('"itemUriTemplate" option is not allowed on a %s operation.', $operation['class']));
            }

            $data[] = array_merge($datum, [
                'collection' => $this->phpize($operation, 'collection', 'bool'),
                'class' => (string) $operation['class'],
                'method' => $this->phpize($operation, 'method', 'string'),
                'read' => $this->phpize($operation, 'read', 'bool'),
                'deserialize' => $this->phpize($operation, 'deserialize', 'bool'),
                'validate' => $this->phpize($operation, 'validate', 'bool'),
                'write' => $this->phpize($operation, 'write', 'bool'),
                'serialize' => $this->phpize($operation, 'serialize', 'bool'),
                'queryParameterValidate' => $this->phpize($operation, 'queryParameterValidate', 'bool'),
                'priority' => $this->phpize($operation, 'priority', 'integer'),
                'name' => $this->phpize($operation, 'name', 'string'),
            ]);
        }

        return $data;
    }

    private function buildGraphQlOperations(\SimpleXMLElement $resource, array $root): ?array
    {
        if (!isset($resource->graphQlOperations->graphQlOperation)) {
            return null;
        }

        $data = [];
        foreach ($resource->graphQlOperations->graphQlOperation as $operation) {
            $datum = $this->buildBase($operation);
            foreach ($datum as $key => $value) {
                if (null === $value) {
                    $datum[$key] = $root[$key];
                }
            }

            $data[] = array_merge($datum, [
                'resolver' => $this->phpize($operation, 'resolver', 'string'),
                'args' => $this->buildArgs($operation),
                'extraArgs' => $this->buildExtraArgs($operation),
                'class' => (string) $operation['class'],
                'read' => $this->phpize($operation, 'read', 'bool'),
                'deserialize' => $this->phpize($operation, 'deserialize', 'bool'),
                'validate' => $this->phpize($operation, 'validate', 'bool'),
                'write' => $this->phpize($operation, 'write', 'bool'),
                'serialize' => $this->phpize($operation, 'serialize', 'bool'),
                'priority' => $this->phpize($operation, 'priority', 'integer'),
                'name' => $this->phpize($operation, 'name', 'string'),
            ]);
        }

        return $data;
    }

    private function buildStateOptions(\SimpleXMLElement $resource): ?OptionsInterface
    {
        $stateOptions = $resource->stateOptions ?? null;
        if (!$stateOptions) {
            return null;
        }
        $elasticsearchOptions = $stateOptions->elasticsearchOptions ?? null;
        if ($elasticsearchOptions) {
            return new StateOptions(
                isset($elasticsearchOptions['index']) ? (string) $elasticsearchOptions['index'] : null,
                isset($elasticsearchOptions['type']) ? (string) $elasticsearchOptions['type'] : null,
            );
        }

        return null;
    }

    /**
     * @return Link[]
     */
    private function buildLinks(\SimpleXMLElement $resource): ?array
    {
        $links = $resource->links ?? null;
        if (!$resource->links) {
            return null;
        }

        $links = [];
        foreach ($resource->links as $link) {
            $links[] = new Link(rel: (string) $link->link->attributes()->rel, href: (string) $link->link->attributes()->href);
        }

        return $links;
    }
}

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\Extractor;
15
16	use ApiPlatform\Metadata\Exception\InvalidArgumentException;
17	use ApiPlatform\Metadata\GetCollection;
18	use ApiPlatform\Metadata\Post;
19	use ApiPlatform\Metadata\Tests\Fixtures\StateOptions;
20	use ApiPlatform\OpenApi\Model\ExternalDocumentation;
21	use ApiPlatform\OpenApi\Model\Operation as OpenApiOperation;
22	use ApiPlatform\OpenApi\Model\Parameter;
23	use ApiPlatform\OpenApi\Model\RequestBody;
24	use ApiPlatform\State\OptionsInterface;
25	use Symfony\Component\Config\Util\XmlUtils;
26	use Symfony\Component\WebLink\Link;
27
28	/**
29	* Extracts an array of metadata from a list of XML files.
30	*
31	* @author Vincent Chalamon <vincentchalamon@gmail.com>
32	*/
33	final class XmlResourceExtractor extends AbstractResourceExtractor
34	{
35	use ResourceExtractorTrait;
36
37	public const SCHEMA = __DIR__.'/schema/resources.xsd';
38
39	/**
40	* {@inheritdoc}
41	*/
42	protected function extractPath(string $path): void
43	{
44	try {
45	/** @var \SimpleXMLElement $xml */
46	$xml = simplexml_import_dom(XmlUtils::loadFile($path, self::SCHEMA));	32✔
47	} catch (\InvalidArgumentException $e) {	32✔
48	// Ensure it's not a resource
49	try {
50	simplexml_import_dom(XmlUtils::loadFile($path, XmlPropertyExtractor::SCHEMA));	32✔
51	} catch (\InvalidArgumentException) {	×
52	throw new InvalidArgumentException(sprintf('Error while parsing %s: %s', $path, $e->getMessage()), $e->getCode(), $e);	×
53	}
54
55	// It's a property: ignore error
56	return;	32✔
57	}
58
59	foreach ($xml->resource as $resource) {	32✔
60	$base = $this->buildExtendedBase($resource);	32✔
61	$this->resources[$this->resolve((string) $resource['class'])][] = array_merge($base, [	32✔
62	'class' => $this->phpize($resource, 'class', 'string'),	32✔
63	'operations' => $this->buildOperations($resource, $base),	32✔
64	'graphQlOperations' => $this->buildGraphQlOperations($resource, $base),	32✔
65	]);	32✔
66	}
67	}
68
69	private function buildExtendedBase(\SimpleXMLElement $resource): array
70	{
71	return array_merge($this->buildBase($resource), [	32✔
72	'uriTemplate' => $this->phpize($resource, 'uriTemplate', 'string'),	32✔
73	'routePrefix' => $this->phpize($resource, 'routePrefix', 'string'),	32✔
74	'stateless' => $this->phpize($resource, 'stateless', 'bool'),	32✔
75	'sunset' => $this->phpize($resource, 'sunset', 'string'),	32✔
76	'acceptPatch' => $this->phpize($resource, 'acceptPatch', 'string'),	32✔
77	'status' => $this->phpize($resource, 'status', 'integer'),	32✔
78	'host' => $this->phpize($resource, 'host', 'string'),	32✔
79	'condition' => $this->phpize($resource, 'condition', 'string'),	32✔
80	'controller' => $this->phpize($resource, 'controller', 'string'),	32✔
81	'types' => $this->buildArrayValue($resource, 'type'),	32✔
82	'formats' => $this->buildFormats($resource, 'formats'),	32✔
83	'inputFormats' => $this->buildFormats($resource, 'inputFormats'),	32✔
84	'outputFormats' => $this->buildFormats($resource, 'outputFormats'),	32✔
85	'uriVariables' => $this->buildUriVariables($resource),	32✔
86	'defaults' => isset($resource->defaults->values) ? $this->buildValues($resource->defaults->values) : null,	32✔
87	'requirements' => $this->buildRequirements($resource),	32✔
88	'options' => isset($resource->options->values) ? $this->buildValues($resource->options->values) : null,	32✔
89	'schemes' => $this->buildArrayValue($resource, 'scheme'),	32✔
90	'cacheHeaders' => $this->buildCacheHeaders($resource),	32✔
91	'hydraContext' => isset($resource->hydraContext->values) ? $this->buildValues($resource->hydraContext->values) : null,	32✔
92	'openapiContext' => isset($resource->openapiContext->values) ? $this->buildValues($resource->openapiContext->values) : null, // TODO Remove in 4.0	32✔
93	'openapi' => $this->buildOpenapi($resource),	32✔
94	'paginationViaCursor' => $this->buildPaginationViaCursor($resource),	32✔
95	'exceptionToStatus' => $this->buildExceptionToStatus($resource),	32✔
96	'queryParameterValidationEnabled' => $this->phpize($resource, 'queryParameterValidationEnabled', 'bool'),	32✔
97	'stateOptions' => $this->buildStateOptions($resource),	32✔
98	'links' => $this->buildLinks($resource),	32✔
99	]);	32✔
100	}
101
102	private function buildBase(\SimpleXMLElement $resource): array
103	{
104	return [	32✔
105	'shortName' => $this->phpize($resource, 'shortName', 'string'),	32✔
106	'description' => $this->phpize($resource, 'description', 'string'),	32✔
107	'urlGenerationStrategy' => $this->phpize($resource, 'urlGenerationStrategy', 'integer'),	32✔
108	'deprecationReason' => $this->phpize($resource, 'deprecationReason', 'string'),	32✔
109	'elasticsearch' => $this->phpize($resource, 'elasticsearch', 'bool'),	32✔
110	'messenger' => $this->phpize($resource, 'messenger', 'bool\|string'),	32✔
111	'mercure' => $this->buildMercure($resource),	32✔
112	'input' => $this->phpize($resource, 'input', 'bool\|string'),	32✔
113	'output' => $this->phpize($resource, 'output', 'bool\|string'),	32✔
114	'fetchPartial' => $this->phpize($resource, 'fetchPartial', 'bool'),	32✔
115	'forceEager' => $this->phpize($resource, 'forceEager', 'bool'),	32✔
116	'paginationClientEnabled' => $this->phpize($resource, 'paginationClientEnabled', 'bool'),	32✔
117	'paginationClientItemsPerPage' => $this->phpize($resource, 'paginationClientItemsPerPage', 'bool'),	32✔
118	'paginationClientPartial' => $this->phpize($resource, 'paginationClientPartial', 'bool'),	32✔
119	'paginationEnabled' => $this->phpize($resource, 'paginationEnabled', 'bool'),	32✔
120	'paginationFetchJoinCollection' => $this->phpize($resource, 'paginationFetchJoinCollection', 'bool'),	32✔
121	'paginationUseOutputWalkers' => $this->phpize($resource, 'paginationUseOutputWalkers', 'bool'),	32✔
122	'paginationItemsPerPage' => $this->phpize($resource, 'paginationItemsPerPage', 'integer'),	32✔
123	'paginationMaximumItemsPerPage' => $this->phpize($resource, 'paginationMaximumItemsPerPage', 'integer'),	32✔
124	'paginationPartial' => $this->phpize($resource, 'paginationPartial', 'bool'),	32✔
125	'paginationType' => $this->phpize($resource, 'paginationType', 'string'),	32✔
126	'processor' => $this->phpize($resource, 'processor', 'string'),	32✔
127	'provider' => $this->phpize($resource, 'provider', 'string'),	32✔
128	'security' => $this->phpize($resource, 'security', 'string'),	32✔
129	'securityMessage' => $this->phpize($resource, 'securityMessage', 'string'),	32✔
130	'securityPostDenormalize' => $this->phpize($resource, 'securityPostDenormalize', 'string'),	32✔
131	'securityPostDenormalizeMessage' => $this->phpize($resource, 'securityPostDenormalizeMessage', 'string'),	32✔
132	'securityPostValidation' => $this->phpize($resource, 'securityPostValidation', 'string'),	32✔
133	'securityPostValidationMessage' => $this->phpize($resource, 'securityPostValidationMessage', 'string'),	32✔
134	'normalizationContext' => isset($resource->normalizationContext->values) ? $this->buildValues($resource->normalizationContext->values) : null,	32✔
135	'denormalizationContext' => isset($resource->denormalizationContext->values) ? $this->buildValues($resource->denormalizationContext->values) : null,	32✔
136	'collectDenormalizationErrors' => $this->phpize($resource, 'collectDenormalizationErrors', 'bool'),	32✔
137	'validationContext' => isset($resource->validationContext->values) ? $this->buildValues($resource->validationContext->values) : null,	32✔
138	'filters' => $this->buildArrayValue($resource, 'filter'),	32✔
139	'order' => isset($resource->order->values) ? $this->buildValues($resource->order->values) : null,	32✔
140	'extraProperties' => $this->buildExtraProperties($resource, 'extraProperties'),	32✔
141	'read' => $this->phpize($resource, 'read', 'bool'),	32✔
142	'write' => $this->phpize($resource, 'write', 'bool'),	32✔
143	];	32✔
144	}
145
146	private function buildFormats(\SimpleXMLElement $resource, string $key): ?array
147	{
148	if (!isset($resource->{$key}->format)) {	32✔
149	return null;	32✔
150	}
151
152	$data = [];	×
153	foreach ($resource->{$key}->format as $format) {	×
154	if (isset($format['name'])) {	×
155	$data[(string) $format['name']] = (string) $format;	×
156	continue;	×
157	}
158
159	$data[] = (string) $format;	×
160	}
161
162	return $data;	×
163	}
164
165	private function buildOpenapi(\SimpleXMLElement $resource): bool\|OpenApiOperation\|null
166	{
167	if (!isset($resource->openapi) && !isset($resource['openapi'])) {	32✔
168	return null;	32✔
169	}
170
171	if (isset($resource['openapi']) && \in_array((string) $resource['openapi'], ['1', '0', 'true', 'false'], true)) {	×
172	return $this->phpize($resource, 'openapi', 'bool');	×
173	}
174
175	$openapi = $resource->openapi;	×
176	$data = [];	×
177	$attributes = $openapi->attributes();	×
178	foreach ($attributes as $attribute) {	×
179	$data[$attribute->getName()] = $this->phpize($attributes, 'deprecated', 'deprecated' === $attribute->getName() ? 'bool' : 'string');	×
180	}
181
182	$data['tags'] = $this->buildArrayValue($resource, 'tag');	×
183
184	if (isset($openapi->responses->response)) {	×
185	foreach ($openapi->responses->response as $response) {	×
186	$data['responses'][(string) $response->attributes()->status] = [	×
187	'description' => $this->phpize($response, 'description', 'string'),	×
188	'content' => isset($response->content->values) ? $this->buildValues($response->content->values) : null,	×
189	'headers' => isset($response->headers->values) ? $this->buildValues($response->headers->values) : null,	×
190	'links' => isset($response->links->values) ? $this->buildValues($response->links->values) : null,	×
191	];	×
192	}
193	}
194
195	$data['externalDocs'] = isset($openapi->externalDocs) ? new ExternalDocumentation(	×
196	description: $this->phpize($resource, 'description', 'string'),	×
197	url: $this->phpize($resource, 'url', 'string'),	×
198	) : null;	×
199
200	if (isset($openapi->parameters->parameter)) {	×
201	foreach ($openapi->parameters->parameter as $parameter) {	×
202	$data['parameters'][(string) $parameter->attributes()->name] = new Parameter(	×
203	name: $this->phpize($parameter, 'name', 'string'),	×
204	in: $this->phpize($parameter, 'in', 'string'),	×
205	description: $this->phpize($parameter, 'description', 'string'),	×
206	required: $this->phpize($parameter, 'required', 'bool'),	×
207	deprecated: $this->phpize($parameter, 'deprecated', 'bool'),	×
208	allowEmptyValue: $this->phpize($parameter, 'allowEmptyValue', 'bool'),	×
209	schema: isset($parameter->schema->values) ? $this->buildValues($parameter->schema->values) : null,	×
210	style: $this->phpize($parameter, 'style', 'string'),	×
211	explode: $this->phpize($parameter, 'explode', 'bool'),	×
212	allowReserved: $this->phpize($parameter, 'allowReserved', 'bool'),	×
213	example: $this->phpize($parameter, 'example', 'string'),	×
214	examples: isset($parameter->examples->values) ? new \ArrayObject($this->buildValues($parameter->examples->values)) : null,	×
215	content: isset($parameter->content->values) ? new \ArrayObject($this->buildValues($parameter->content->values)) : null,	×
216	);	×
217	}
218	}
219	$data['requestBody'] = isset($openapi->requestBody) ? new RequestBody(	×
220	description: $this->phpize($openapi->requestBody, 'description', 'string'),	×
221	content: isset($openapi->requestBody->content->values) ? new \ArrayObject($this->buildValues($openapi->requestBody->content->values)) : null,	×
222	required: $this->phpize($openapi->requestBody, 'required', 'bool'),	×
223	) : null;	×
224
225	$data['callbacks'] = isset($openapi->callbacks->values) ? new \ArrayObject($this->buildValues($openapi->callbacks->values)) : null;	×
226
227	$data['security'] = isset($openapi->security->values) ? $this->buildValues($openapi->security->values) : null;	×
228
229	if (isset($openapi->servers->server)) {	×
230	foreach ($openapi->servers->server as $server) {	×
231	$data['servers'][] = [	×
232	'description' => $this->phpize($server, 'description', 'string'),	×
233	'url' => $this->phpize($server, 'url', 'string'),	×
234	'variables' => isset($server->variables->values) ? $this->buildValues($server->variables->values) : null,	×
235	];	×
236	}
237	}
238
239	$data['extensionProperties'] = isset($openapi->extensionProperties->values) ? $this->buildValues($openapi->extensionProperties->values) : null;	×
240
241	foreach ($data as $key => $value) {	×
242	if (null === $value) {	×
243	unset($data[$key]);	×
244	}
245	}
246
247	return new OpenApiOperation(...$data);	×
248	}
249
250	private function buildUriVariables(\SimpleXMLElement $resource): ?array
251	{
252	if (!isset($resource->uriVariables->uriVariable)) {	32✔
253	return null;	32✔
254	}
255
256	$uriVariables = [];	32✔
257	foreach ($resource->uriVariables->uriVariable as $data) {	32✔
258	$parameterName = (string) $data['parameterName'];	32✔
259	if (1 === (null === $data->attributes() ? 0 : \count($data->attributes()))) {	32✔
260	$uriVariables[$parameterName] = $parameterName;	32✔
261	continue;	32✔
262	}
263
264	if ($fromProperty = $this->phpize($data, 'fromProperty', 'string')) {	32✔
265	$uriVariables[$parameterName]['from_property'] = $fromProperty;	×
266	}
267	if ($toProperty = $this->phpize($data, 'toProperty', 'string')) {	32✔
268	$uriVariables[$parameterName]['to_property'] = $toProperty;	32✔
269	}
270	if ($fromClass = $this->phpize($data, 'fromClass', 'string')) {	32✔
271	$uriVariables[$parameterName]['from_class'] = $fromClass;	32✔
272	}
273	if ($toClass = $this->phpize($data, 'toClass', 'string')) {	32✔
274	$uriVariables[$parameterName]['to_class'] = $toClass;	×
275	}
276	if (isset($data->identifiers->values)) {	32✔
277	$uriVariables[$parameterName]['identifiers'] = $this->buildValues($data->identifiers->values);	×
278	}
279	if (null !== ($compositeIdentifier = $this->phpize($data, 'compositeIdentifier', 'bool'))) {	32✔
280	$uriVariables[$parameterName]['composite_identifier'] = $compositeIdentifier;	×
281	}
282	}
283
284	return $uriVariables;	32✔
285	}
286
287	private function buildCacheHeaders(\SimpleXMLElement $resource): ?array
288	{
289	if (!isset($resource->cacheHeaders->cacheHeader)) {	32✔
290	return null;	32✔
291	}
292
293	$data = [];	×
294	foreach ($resource->cacheHeaders->cacheHeader as $cacheHeader) {	×
295	if (isset($cacheHeader->values->value)) {	×
296	$data[(string) $cacheHeader['name']] = $this->buildValues($cacheHeader->values);	×
297	continue;	×
298	}
299
300	$data[(string) $cacheHeader['name']] = (string) $cacheHeader;	×
301	}
302
303	return $data;	×
304	}
305
306	private function buildRequirements(\SimpleXMLElement $resource): ?array
307	{
308	if (!isset($resource->requirements->requirement)) {	32✔
309	return null;	32✔
310	}
311
312	$data = [];	×
313	foreach ($resource->requirements->requirement as $requirement) {	×
314	$data[(string) $requirement->attributes()->property] = (string) $requirement;	×
315	}
316
317	return $data;	×
318	}
319
320	private function buildMercure(\SimpleXMLElement $resource): array\|bool\|null
321	{
322	if (!isset($resource->mercure)) {	32✔
323	return null;	32✔
324	}
325
326	if (null !== $resource->mercure->attributes()->private) {	×
327	return ['private' => $this->phpize($resource->mercure->attributes(), 'private', 'bool')];	×
328	}
329
330	return true;	×
331	}
332
333	private function buildPaginationViaCursor(\SimpleXMLElement $resource): ?array
334	{
335	if (!isset($resource->paginationViaCursor->paginationField)) {	32✔
336	return null;	32✔
337	}
338
339	$data = [];	×
340	foreach ($resource->paginationViaCursor->paginationField as $paginationField) {	×
341	$data[(string) $paginationField['field']] = (string) $paginationField['direction'];	×
342	}
343
344	return $data;	×
345	}
346
347	private function buildExceptionToStatus(\SimpleXMLElement $resource): ?array
348	{
349	if (!isset($resource->exceptionToStatus->exception)) {	32✔
350	return null;	32✔
351	}
352
353	$data = [];	×
354	foreach ($resource->exceptionToStatus->exception as $exception) {	×
355	$data[(string) $exception['class']] = (int) $exception['statusCode'];	×
356	}
357
358	return $data;	×
359	}
360
361	private function buildExtraProperties(\SimpleXMLElement $resource, string $key = null): ?array
362	{
363	if (null !== $key) {	32✔
364	if (!isset($resource->{$key})) {	32✔
365	return null;	32✔
366	}
367
368	$resource = $resource->{$key};	×
369	}
370
371	return $this->buildValues($resource->values);	×
372	}
373
374	private function buildOperations(\SimpleXMLElement $resource, array $root): ?array
375	{
376	if (!isset($resource->operations->operation)) {	32✔
377	return null;	32✔
378	}
379
380	$data = [];	32✔
381	foreach ($resource->operations->operation as $operation) {	32✔
382	$datum = $this->buildExtendedBase($operation);	32✔
383	foreach ($datum as $key => $value) {	32✔
384	if (null === $value) {	32✔
385	$datum[$key] = $root[$key];	32✔
386	}
387	}
388
389	if (\in_array((string) $operation['class'], [GetCollection::class, Post::class], true)) {	32✔
390	$datum['itemUriTemplate'] = $this->phpize($operation, 'itemUriTemplate', 'string');	32✔
391	} elseif (isset($operation['itemUriTemplate'])) {	32✔
NEW 392	throw new InvalidArgumentException(sprintf('"itemUriTemplate" option is not allowed on a %s operation.', $operation['class']));	×
393	}
394
395	$data[] = array_merge($datum, [	32✔
396	'collection' => $this->phpize($operation, 'collection', 'bool'),	32✔
397	'class' => (string) $operation['class'],	32✔
398	'method' => $this->phpize($operation, 'method', 'string'),	32✔
399	'read' => $this->phpize($operation, 'read', 'bool'),	32✔
400	'deserialize' => $this->phpize($operation, 'deserialize', 'bool'),	32✔
401	'validate' => $this->phpize($operation, 'validate', 'bool'),	32✔
402	'write' => $this->phpize($operation, 'write', 'bool'),	32✔
403	'serialize' => $this->phpize($operation, 'serialize', 'bool'),	32✔
404	'queryParameterValidate' => $this->phpize($operation, 'queryParameterValidate', 'bool'),	32✔
405	'priority' => $this->phpize($operation, 'priority', 'integer'),	32✔
406	'name' => $this->phpize($operation, 'name', 'string'),	32✔
407	]);	32✔
408	}
409
410	return $data;	32✔
411	}
412
413	private function buildGraphQlOperations(\SimpleXMLElement $resource, array $root): ?array
414	{
415	if (!isset($resource->graphQlOperations->graphQlOperation)) {	32✔
416	return null;	32✔
417	}
418
419	$data = [];	×
420	foreach ($resource->graphQlOperations->graphQlOperation as $operation) {	×
421	$datum = $this->buildBase($operation);	×
422	foreach ($datum as $key => $value) {	×
423	if (null === $value) {	×
424	$datum[$key] = $root[$key];	×
425	}
426	}
427
428	$data[] = array_merge($datum, [	×
429	'resolver' => $this->phpize($operation, 'resolver', 'string'),	×
430	'args' => $this->buildArgs($operation),	×
431	'extraArgs' => $this->buildExtraArgs($operation),	×
432	'class' => (string) $operation['class'],	×
433	'read' => $this->phpize($operation, 'read', 'bool'),	×
434	'deserialize' => $this->phpize($operation, 'deserialize', 'bool'),	×
435	'validate' => $this->phpize($operation, 'validate', 'bool'),	×
436	'write' => $this->phpize($operation, 'write', 'bool'),	×
437	'serialize' => $this->phpize($operation, 'serialize', 'bool'),	×
438	'priority' => $this->phpize($operation, 'priority', 'integer'),	×
439	'name' => $this->phpize($operation, 'name', 'string'),	×
440	]);	×
441	}
442
443	return $data;	×
444	}
445
446	private function buildStateOptions(\SimpleXMLElement $resource): ?OptionsInterface
447	{
448	$stateOptions = $resource->stateOptions ?? null;	32✔
449	if (!$stateOptions) {	32✔
450	return null;	32✔
451	}
452	$elasticsearchOptions = $stateOptions->elasticsearchOptions ?? null;	×
453	if ($elasticsearchOptions) {	×
454	return new StateOptions(	×
455	isset($elasticsearchOptions['index']) ? (string) $elasticsearchOptions['index'] : null,	×
456	isset($elasticsearchOptions['type']) ? (string) $elasticsearchOptions['type'] : null,	×
457	);	×
458	}
459
460	return null;	×
461	}
462
463	/**
464	* @return Link[]
465	*/
466	private function buildLinks(\SimpleXMLElement $resource): ?array
467	{
468	$links = $resource->links ?? null;	32✔
469	if (!$resource->links) {	32✔
470	return null;	32✔
471	}
472
473	$links = [];	×
474	foreach ($resource->links as $link) {	×
475	$links[] = new Link(rel: (string) $link->link->attributes()->rel, href: (string) $link->link->attributes()->href);	×
476	}
477
478	return $links;	×
479	}
480	}

api-platform / core / 7275126587

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