15394724286

Committed 02 Jun 2025 02:19PM UTC coverage: 22.201% (+0.1%) from 22.062%

Build # 15394724286

Build Type

push

github

Committed by

soyuka

Commit Message

feat(elasticsearch): add support for v9 (#7180)

Co-authored-by: darthf1 <17253332+darthf1@users.noreply.github.com>

Run Details

10888 of 49042 relevant lines covered (22.2%)

10.59 hits per line

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

58.89

/src/Metadata/Extractor/YamlResourceExtractor.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\Elasticsearch\State\Options;
use ApiPlatform\Metadata\Exception\InvalidArgumentException;
use ApiPlatform\Metadata\GetCollection;
use ApiPlatform\Metadata\HeaderParameter;
use ApiPlatform\Metadata\Post;
use ApiPlatform\Metadata\QueryParameter;
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\WebLink\Link;
use Symfony\Component\Yaml\Exception\ParseException;
use Symfony\Component\Yaml\Yaml;

/**
 * Extracts an array of metadata from a list of YAML files.
 *
 * @author Antoine Bluchet <soyuka@gmail.com>
 * @author Baptiste Meyer <baptiste.meyer@gmail.com>
 * @author Kévin Dunglas <dunglas@gmail.com>
 * @author Vincent Chalamon <vincentchalamon@gmail.com>
 */
final class YamlResourceExtractor extends AbstractResourceExtractor
{
    use ResourceExtractorTrait;

    /**
     * {@inheritdoc}
     */
    protected function extractPath(string $path): void
    {
        try {
            $resourcesYaml = Yaml::parse((string) file_get_contents($path), Yaml::PARSE_CONSTANT);
        } catch (ParseException $e) {
            $e->setParsedFile($path);

            throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e);
        }

        if (null === $resourcesYaml = $resourcesYaml['resources'] ?? $resourcesYaml) {
            return;
        }

        if (!\is_array($resourcesYaml)) {
            throw new InvalidArgumentException(\sprintf('"resources" setting is expected to be null or an array, %s given in "%s".', \gettype($resourcesYaml), $path));
        }

        $this->buildResources($resourcesYaml, $path);
    }

    private function buildResources(array $resourcesYaml, string $path): void
    {
        foreach ($resourcesYaml as $resourceName => $resourceYaml) {
            $resourceName = $this->resolve($resourceName);

            if (null === $resourceYaml) {
                $resourceYaml = [[]];
            }

            if (!\array_key_exists(0, $resourceYaml)) {
                $resourceYaml = [$resourceYaml];
            }

            foreach ($resourceYaml as $key => $resourceYamlDatum) {
                if (null === $resourceYamlDatum) {
                    $resourceYamlDatum = [];
                }

                try {
                    $base = $this->buildExtendedBase($resourceYamlDatum);
                    $this->resources[$resourceName][$key] = array_merge($base, [
                        'operations' => $this->buildOperations($resourceYamlDatum, $base),
                        'graphQlOperations' => $this->buildGraphQlOperations($resourceYamlDatum, $base),
                    ]);
                } catch (InvalidArgumentException $exception) {
                    throw new InvalidArgumentException(\sprintf('%s in "%s" (%s).', $exception->getMessage(), $resourceName, $path));
                }
            }
        }
    }

    private function buildExtendedBase(array $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'),
            'host' => $this->phpize($resource, 'host', 'string'),
            'condition' => $this->phpize($resource, 'condition', 'string'),
            'controller' => $this->phpize($resource, 'controller', 'string'),
            'queryParameterValidationEnabled' => $this->phpize($resource, 'queryParameterValidationEnabled', 'bool'),
            'types' => $this->buildArrayValue($resource, 'types'),
            'cacheHeaders' => $this->buildArrayValue($resource, 'cacheHeaders'),
            'hydraContext' => $this->buildArrayValue($resource, 'hydraContext'),
            'openapi' => $this->buildOpenapi($resource),
            'paginationViaCursor' => $this->buildArrayValue($resource, 'paginationViaCursor'),
            'exceptionToStatus' => $this->buildArrayValue($resource, 'exceptionToStatus'),
            'defaults' => $this->buildArrayValue($resource, 'defaults'),
            'requirements' => $this->buildArrayValue($resource, 'requirements'),
            'options' => $this->buildArrayValue($resource, 'options'),
            'status' => $this->phpize($resource, 'status', 'integer'),
            'schemes' => $this->buildArrayValue($resource, 'schemes'),
            'formats' => $this->buildArrayValue($resource, 'formats'),
            'uriVariables' => $this->buildUriVariables($resource),
            'inputFormats' => $this->buildArrayValue($resource, 'inputFormats'),
            'outputFormats' => $this->buildArrayValue($resource, 'outputFormats'),
            'stateOptions' => $this->buildStateOptions($resource),
            'links' => $this->buildLinks($resource),
            'headers' => $this->buildHeaders($resource),
            'parameters' => $this->buildParameters($resource),
        ]);
    }

    private function buildBase(array $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'),
            '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'),
            'input' => $this->phpize($resource, 'input', 'bool|string'),
            'output' => $this->phpize($resource, 'output', 'bool|string'),
            'normalizationContext' => $this->buildArrayValue($resource, 'normalizationContext'),
            'denormalizationContext' => $this->buildArrayValue($resource, 'denormalizationContext'),
            'collectDenormalizationErrors' => $this->phpize($resource, 'collectDenormalizationErrors', 'bool'),
            'validationContext' => $this->buildArrayValue($resource, 'validationContext'),
            'filters' => $this->buildArrayValue($resource, 'filters'),
            'order' => $this->buildArrayValue($resource, 'order'),
            'extraProperties' => $this->buildArrayValue($resource, 'extraProperties'),
            'mercure' => $this->buildMercure($resource),
            'messenger' => $this->buildMessenger($resource),
            'read' => $this->phpize($resource, 'read', 'bool'),
            'write' => $this->phpize($resource, 'write', 'bool'),
        ];
    }

    private function buildUriVariables(array $resource): ?array
    {
        if (!\array_key_exists('uriVariables', $resource)) {
            return null;
        }

        $uriVariables = [];
        foreach ($resource['uriVariables'] as $parameterName => $data) {
            if (\is_string($data)) {
                $uriVariables[$data] = $data;
                continue;
            }

            if (2 === (is_countable($data) ? \count($data) : 0) && isset($data[0]) && isset($data[1])) {
                $data['fromClass'] = $data[0];
                $data['fromProperty'] = $data[1];
                unset($data[0], $data[1]);
            }
            if (isset($data['fromClass'])) {
                $uriVariables[$parameterName]['from_class'] = $this->resolve($data['fromClass']);
            }
            if (isset($data['fromProperty'])) {
                $uriVariables[$parameterName]['from_property'] = $data['fromProperty'];
            }
            if (isset($data['toClass'])) {
                $uriVariables[$parameterName]['to_class'] = $this->resolve($data['toClass']);
            }
            if (isset($data['toProperty'])) {
                $uriVariables[$parameterName]['to_property'] = $data['toProperty'];
            }
            if (isset($data['identifiers'])) {
                $uriVariables[$parameterName]['identifiers'] = $data['identifiers'];
            }
            if (isset($data['compositeIdentifier'])) {
                $uriVariables[$parameterName]['composite_identifier'] = $data['compositeIdentifier'];
            }
            if (isset($data['security'])) {
                $uriVariables[$parameterName]['security'] = $data['security'];
            }
        }

        return $uriVariables;
    }

    private function buildOpenapi(array $resource): bool|OpenApiOperation|null
    {
        if (!\array_key_exists('openapi', $resource)) {
            return null;
        }

        if (!\is_array($resource['openapi'])) {
            return $this->phpize($resource, 'openapi', 'bool');
        }

        $allowedProperties = array_map(fn (\ReflectionProperty $reflProperty): string => $reflProperty->getName(), (new \ReflectionClass(OpenApiOperation::class))->getProperties());
        foreach ($resource['openapi'] as $key => $value) {
            $resource['openapi'][$key] = match ($key) {
                'externalDocs' => new ExternalDocumentation(description: $value['description'] ?? '', url: $value['url'] ?? ''),
                'requestBody' => new RequestBody(description: $value['description'] ?? '', content: isset($value['content']) ? new \ArrayObject($value['content'] ?? []) : null, required: $value['required'] ?? false),
                'callbacks' => new \ArrayObject($value ?? []),
                default => $value,
            };

            if (\in_array($key, $allowedProperties, true)) {
                continue;
            }

            $resource['openapi']['extensionProperties'][$key] = $value;
            unset($resource['openapi'][$key]);
        }

        if (\array_key_exists('parameters', $resource['openapi']) && \is_array($openapiParameters = $resource['openapi']['parameters'] ?? [])) {
            $parameters = [];
            foreach ($openapiParameters as $parameter) {
                $parameters[] = new Parameter(
                    name: $parameter['name'],
                    in: $parameter['in'],
                    description: $parameter['description'] ?? '',
                    required: $parameter['required'] ?? false,
                    deprecated: $parameter['deprecated'] ?? false,
                    allowEmptyValue: $parameter['allowEmptyValue'] ?? false,
                    schema: $parameter['schema'] ?? [],
                    style: $parameter['style'] ?? null,
                    explode: $parameter['explode'] ?? false,
                    allowReserved: $parameter['allowReserved '] ?? false,
                    example: $parameter['example'] ?? null,
                    examples: isset($parameter['examples']) ? new \ArrayObject($parameter['examples']) : null,
                    content: isset($parameter['content']) ? new \ArrayObject($parameter['content']) : null
                );
            }
            $resource['openapi']['parameters'] = $parameters;
        }

        return new OpenApiOperation(...$resource['openapi']);
    }

    /**
     * @return bool|string|string[]|null
     */
    private function buildMercure(array $resource): array|bool|string|null
    {
        if (!\array_key_exists('mercure', $resource)) {
            return null;
        }

        if (\is_string($resource['mercure'])) {
            return $this->phpize($resource, 'mercure', 'bool|string');
        }

        return $resource['mercure'];
    }

    private function buildMessenger(array $resource): bool|array|string|null
    {
        if (!\array_key_exists('messenger', $resource)) {
            return null;
        }

        return $this->phpize($resource, 'messenger', 'bool|string');
    }

    private function buildOperations(array $resource, array $root): ?array
    {
        if (!\array_key_exists('operations', $resource)) {
            return null;
        }

        $data = [];
        foreach ($resource['operations'] as $class => $operation) {
            if (null === $operation) {
                $operation = [];
            }

            if (\array_key_exists('class', $operation)) {
                if (!\array_key_exists('name', $operation) && \is_string($class)) {
                    $operation['name'] = $class;
                }
                $class = $operation['class'];
            }

            if (empty($class)) {
                throw new InvalidArgumentException('Missing "class" attribute');
            }

            if (!class_exists($class)) {
                throw new InvalidArgumentException(\sprintf('Operation class "%s" does not exist', $class));
            }

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

            if (\in_array((string) $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.', $class));
            }

            $data[] = array_merge($datum, [
                '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'),
                'strictQueryParameterValidation' => $this->phpize($operation, 'strictQueryParameterValidation', 'bool'),
                'hideHydraOperation' => $this->phpize($resource, 'hideHydraOperation', 'bool'),
                'priority' => $this->phpize($operation, 'priority', 'integer'),
                'name' => $this->phpize($operation, 'name', 'string'),
                'class' => (string) $class,
            ]);
        }

        return $data;
    }

    private function buildGraphQlOperations(array $resource, array $root): ?array
    {
        if (!\array_key_exists('graphQlOperations', $resource) || !\is_array($resource['graphQlOperations'])) {
            return null;
        }

        $data = [];
        foreach ($resource['graphQlOperations'] as $class => $operation) {
            if (null === $operation) {
                $operation = [];
            }

            if (\array_key_exists('class', $operation)) {
                if (!\array_key_exists('name', $operation) && \is_string($class)) {
                    $operation['name'] = $class;
                }
                $class = $operation['class'];
            }

            if (empty($class)) {
                throw new InvalidArgumentException('Missing "class" attribute');
            }

            if (!class_exists($class)) {
                throw new InvalidArgumentException(\sprintf('Operation class "%s" does not exist', $class));
            }

            $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' => $operation['args'] ?? null,
                'extraArgs' => $operation['extraArgs'] ?? null,
                'class' => (string) $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 ?: null;
    }

    private function buildStateOptions(array $resource): ?OptionsInterface
    {
        $stateOptions = $resource['stateOptions'] ?? [];
        if (!\is_array($stateOptions)) {
            return null;
        }

        if (!$stateOptions) {
            return null;
        }

        $configuration = reset($stateOptions);
        switch (key($stateOptions)) {
            case 'elasticsearchOptions':
                if (class_exists(Options::class)) {
                    return new Options($configuration['index'] ?? null);
                }
        }

        return null;
    }

    /**
     * @return Link[]
     */
    private function buildLinks(array $resource): ?array
    {
        if (!isset($resource['links']) || !\is_array($resource['links'])) {
            return null;
        }

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

        return $links;
    }

    /**
     * @return array<string, string>
     */
    private function buildHeaders(array $resource): ?array
    {
        if (!isset($resource['headers']) || !\is_array($resource['headers'])) {
            return null;
        }

        $headers = [];
        foreach ($resource['headers'] as $key => $value) {
            $headers[$key] = $value;
        }

        return $headers;
    }

    /**
     * @return array<string, \ApiPlatform\Metadata\Parameter>
     */
    private function buildParameters(array $resource): ?array
    {
        if (!isset($resource['parameters']) || !\is_array($resource['parameters'])) {
            return null;
        }

        $parameters = [];
        foreach ($resource['parameters'] as $key => $parameter) {
            $cl = ($parameter['in'] ?? 'query') === 'header' ? HeaderParameter::class : QueryParameter::class;
            $parameters[$key] = new $cl(
                key: $key,
                required: $this->phpize($parameter, 'required', 'bool'),
                schema: $parameter['schema'] ?? null,
                openApi: ($parameter['openapi'] ?? null) ? new Parameter(
                    name: $parameter['openapi']['name'],
                    in: $parameter['in'] ?? 'query',
                    description: $parameter['openapi']['description'] ?? '',
                    required: $parameter['openapi']['required'] ?? $parameter['required'] ?? false,
                    deprecated: $parameter['openapi']['deprecated'] ?? false,
                    allowEmptyValue: $parameter['openapi']['allowEmptyValue'] ?? false,
                    schema: $parameter['openapi']['schema'] ?? $parameter['schema'] ?? [],
                    style: $parameter['openapi']['style'] ?? null,
                    explode: $parameter['openapi']['explode'] ?? false,
                    allowReserved: $parameter['openapi']['allowReserved '] ?? false,
                    example: $parameter['openapi']['example'] ?? null,
                    examples: isset($parameter['openapi']['examples']) ? new \ArrayObject($parameter['openapi']['examples']) : null,
                    content: isset($parameter['openapi']['content']) ? new \ArrayObject($parameter['openapi']['content']) : null
                ) : null,
                provider: $this->phpize($parameter, 'provider', 'string'),
                filter: $this->phpize($parameter, 'filter', 'string'),
                property: $this->phpize($parameter, 'property', 'string'),
                description: $this->phpize($parameter, 'description', 'string'),
                priority: $this->phpize($parameter, 'priority', 'integer'),
                extraProperties: $this->buildArrayValue($parameter, 'extraProperties') ?? [],
            );
        }

        return $parameters;
    }
}

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

api-platform / core / 15394724286

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