17487610263

Committed 05 Sep 2025 08:12AM UTC coverage: 22.608% (+0.3%) from 22.319%

Build # 17487610263

Build Type

push

github

Committed by

web-flow

Commit Message

chore: remove @experimental flag from parameters (#7357)

Run Details

12049 of 53296 relevant lines covered (22.61%)

26.21 hits per line

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

78.69

/src/Metadata/Extractor/XmlPropertyExtractor.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 Symfony\Component\Config\Util\XmlUtils;

/**
 * Extracts an array of metadata from a list of XML files.
 *
 * @author Vincent Chalamon <vincentchalamon@gmail.com>
 */
final class XmlPropertyExtractor extends AbstractPropertyExtractor
{
    public const SCHEMA = __DIR__.'/schema/properties.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, XmlResourceExtractor::SCHEMA));
            } catch (\InvalidArgumentException) {
                throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e);
            }

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

        foreach ($xml->property as $property) {
            $this->properties[$this->resolve((string) $property['resource'])][(string) $property['name']] = [
                'description' => $this->phpize($property, 'description', 'string'),
                'readable' => $this->phpize($property, 'readable', 'bool'),
                'writable' => $this->phpize($property, 'writable', 'bool'),
                'readableLink' => $this->phpize($property, 'readableLink', 'bool'),
                'writableLink' => $this->phpize($property, 'writableLink', 'bool'),
                'required' => $this->phpize($property, 'required', 'bool'),
                'identifier' => $this->phpize($property, 'identifier', 'bool'),
                'default' => $this->phpize($property, 'default', 'string'),
                'example' => $this->phpize($property, 'example', 'string'),
                'deprecationReason' => $this->phpize($property, 'deprecationReason', 'string'),
                'fetchable' => $this->phpize($property, 'fetchable', 'bool'),
                'fetchEager' => $this->phpize($property, 'fetchEager', 'bool'),
                'jsonldContext' => isset($property->jsonldContext->values) ? $this->buildValues($property->jsonldContext->values) : null,
                'openapiContext' => isset($property->openapiContext->values) ? $this->buildValues($property->openapiContext->values) : null,
                'jsonSchemaContext' => isset($property->jsonSchemaContext->values) ? $this->buildValues($property->jsonSchemaContext->values) : null,
                'push' => $this->phpize($property, 'push', 'bool'),
                'security' => $this->phpize($property, 'security', 'string'),
                'securityPostDenormalize' => $this->phpize($property, 'securityPostDenormalize', 'string'),
                'types' => $this->buildArrayValue($property, 'type'),
                'builtinTypes' => $this->buildArrayValue($property, 'builtinType'),
                'schema' => isset($property->schema->values) ? $this->buildValues($property->schema->values) : null,
                'initializable' => $this->phpize($property, 'initializable', 'bool'),
                'extraProperties' => $this->buildExtraProperties($property, 'extraProperties'),
                'iris' => $this->buildArrayValue($property, 'iri'),
                'genId' => $this->phpize($property, 'genId', 'bool'),
                'uriTemplate' => $this->phpize($property, 'uriTemplate', 'string'),
                'property' => $this->phpize($property, 'property', 'string'),
                'nativeType' => $this->phpize($property, 'nativeType', 'string'),
            ];
        }
    }

    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);
    }

    /**
     * @return string[]
     */
    private function buildValues(\SimpleXMLElement $resource): array
    {
        $data = [];
        foreach ($resource->value as $value) {
            if (null !== $value->attributes()->name) {
                $data[(string) $value->attributes()->name] = isset($value->values) ? $this->buildValues($value->values) : (string) $value;
                continue;
            }

            $data[] = isset($value->values) ? $this->buildValues($value->values) : (string) $value;
        }

        return $data;
    }

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

        return (array) $resource->{$key.'s'}->{$key};
    }

    /**
     * Transforms an XML attribute's value in a PHP value.
     */
    private function phpize(\SimpleXMLElement $resource, string $key, string $type, mixed $default = null): array|bool|int|string|null
    {
        if (!isset($resource[$key])) {
            return $default;
        }

        return match ($type) {
            'bool|string' => \in_array((string) $resource[$key], ['1', '0', 'true', 'false'], true) ? $this->phpize($resource, $key, 'bool') : $this->phpize($resource, $key, 'string'),
            'string' => (string) $resource[$key],
            'integer' => (int) $resource[$key],
            'bool' => (bool) XmlUtils::phpize($resource[$key]),
            default => null,
        };
    }
}

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 Symfony\Component\Config\Util\XmlUtils;
18
19	/**
20	* Extracts an array of metadata from a list of XML files.
21	*
22	* @author Vincent Chalamon <vincentchalamon@gmail.com>
23	*/
24	final class XmlPropertyExtractor extends AbstractPropertyExtractor
25	{
26	public const SCHEMA = __DIR__.'/schema/properties.xsd';
27
28	/**
29	* {@inheritdoc}
30	*/
31	protected function extractPath(string $path): void
32	{
33	try {
34	/** @var \SimpleXMLElement $xml */
35	$xml = simplexml_import_dom(XmlUtils::loadFile($path, self::SCHEMA));	200✔
36	} catch (\InvalidArgumentException $e) {	200✔
37	// Ensure it's not a resource
38	try {
39	simplexml_import_dom(XmlUtils::loadFile($path, XmlResourceExtractor::SCHEMA));	200✔
40	} catch (\InvalidArgumentException) {	×
41	throw new InvalidArgumentException($e->getMessage(), $e->getCode(), $e);	×
42	}
43
44	// It's a resource: ignore error
45	return;	200✔
46	}
47
48	foreach ($xml->property as $property) {	200✔
49	$this->properties[$this->resolve((string) $property['resource'])][(string) $property['name']] = [	200✔
50	'description' => $this->phpize($property, 'description', 'string'),	200✔
51	'readable' => $this->phpize($property, 'readable', 'bool'),	200✔
52	'writable' => $this->phpize($property, 'writable', 'bool'),	200✔
53	'readableLink' => $this->phpize($property, 'readableLink', 'bool'),	200✔
54	'writableLink' => $this->phpize($property, 'writableLink', 'bool'),	200✔
55	'required' => $this->phpize($property, 'required', 'bool'),	200✔
56	'identifier' => $this->phpize($property, 'identifier', 'bool'),	200✔
57	'default' => $this->phpize($property, 'default', 'string'),	200✔
58	'example' => $this->phpize($property, 'example', 'string'),	200✔
59	'deprecationReason' => $this->phpize($property, 'deprecationReason', 'string'),	200✔
60	'fetchable' => $this->phpize($property, 'fetchable', 'bool'),	200✔
61	'fetchEager' => $this->phpize($property, 'fetchEager', 'bool'),	200✔
62	'jsonldContext' => isset($property->jsonldContext->values) ? $this->buildValues($property->jsonldContext->values) : null,	200✔
63	'openapiContext' => isset($property->openapiContext->values) ? $this->buildValues($property->openapiContext->values) : null,	200✔
64	'jsonSchemaContext' => isset($property->jsonSchemaContext->values) ? $this->buildValues($property->jsonSchemaContext->values) : null,	200✔
65	'push' => $this->phpize($property, 'push', 'bool'),	200✔
66	'security' => $this->phpize($property, 'security', 'string'),	200✔
67	'securityPostDenormalize' => $this->phpize($property, 'securityPostDenormalize', 'string'),	200✔
68	'types' => $this->buildArrayValue($property, 'type'),	200✔
69	'builtinTypes' => $this->buildArrayValue($property, 'builtinType'),	200✔
70	'schema' => isset($property->schema->values) ? $this->buildValues($property->schema->values) : null,	200✔
71	'initializable' => $this->phpize($property, 'initializable', 'bool'),	200✔
72	'extraProperties' => $this->buildExtraProperties($property, 'extraProperties'),	200✔
73	'iris' => $this->buildArrayValue($property, 'iri'),	200✔
74	'genId' => $this->phpize($property, 'genId', 'bool'),	200✔
75	'uriTemplate' => $this->phpize($property, 'uriTemplate', 'string'),	200✔
76	'property' => $this->phpize($property, 'property', 'string'),	200✔
77	'nativeType' => $this->phpize($property, 'nativeType', 'string'),	200✔
78	];	200✔
79	}
80	}
81
82	private function buildExtraProperties(\SimpleXMLElement $resource, ?string $key = null): ?array
83	{
84	if (null !== $key) {	200✔
85	if (!isset($resource->{$key})) {	200✔
86	return null;	200✔
87	}
88
89	$resource = $resource->{$key};	×
90	}
91
92	return $this->buildValues($resource->values);	×
93	}
94
95	/**
96	* @return string[]
97	*/
98	private function buildValues(\SimpleXMLElement $resource): array
99	{
100	$data = [];	×
101	foreach ($resource->value as $value) {	×
102	if (null !== $value->attributes()->name) {	×
103	$data[(string) $value->attributes()->name] = isset($value->values) ? $this->buildValues($value->values) : (string) $value;	×
104	continue;	×
105	}
106
107	$data[] = isset($value->values) ? $this->buildValues($value->values) : (string) $value;	×
108	}
109
110	return $data;	×
111	}
112
113	private function buildArrayValue(?\SimpleXMLElement $resource, string $key): ?array
114	{
115	if (!isset($resource->{$key.'s'}->{$key})) {	200✔
116	return null;	200✔
117	}
118
119	return (array) $resource->{$key.'s'}->{$key};	200✔
120	}
121
122	/**
123	* Transforms an XML attribute's value in a PHP value.
124	*/
125	private function phpize(\SimpleXMLElement $resource, string $key, string $type, mixed $default = null): array\|bool\|int\|string\|null
126	{
127	if (!isset($resource[$key])) {	200✔
128	return $default;	200✔
129	}
130
131	return match ($type) {	200✔
132	'bool\|string' => \in_array((string) $resource[$key], ['1', '0', 'true', 'false'], true) ? $this->phpize($resource, $key, 'bool') : $this->phpize($resource, $key, 'string'),	×
133	'string' => (string) $resource[$key],	200✔
134	'integer' => (int) $resource[$key],	×
135	'bool' => (bool) XmlUtils::phpize($resource[$key]),	200✔
136	default => null,	200✔
137	};	200✔
138	}
139	}

api-platform / core / 17487610263

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