#24520

pending completion

Build # #24520

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/cb13754ad3a7b5e11b6deb0e2e826a42a40ed9eb">cb13754ad<a href="https://github.com/api-platform/core/commit/cb13754ad3a7b5e11b6deb0e2e826a42a40ed9eb">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/de6fb155a0544d67af225b26e395f51f54e86ccb">de6fb155a</a>">de6fb155a</a><a href="https://github.com/api-platform/core/commit/cb13754ad3a7b5e11b6deb0e2e826a42a40ed9eb"> into 311678d25">311678d25</a>

Run Details

7 of 7 new or added lines in 2 files covered. (100.0%)

8732 of 9610 relevant lines covered (90.86%)

16.51 hits per line

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

98.11

/src/Serializer/Filter/PropertyFilter.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\Core\Serializer\Filter;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;

/**
 * Property filter.
 *
 * @author Baptiste Meyer <baptiste.meyer@gmail.com>
 */
final class PropertyFilter implements FilterInterface
{
    private $overrideDefaultProperties;
    private $parameterName;
    private $whitelist;
    private $nameConverter;

    public function __construct(string $parameterName = 'properties', bool $overrideDefaultProperties = false, array $whitelist = null, NameConverterInterface $nameConverter = null)
    {
        $this->overrideDefaultProperties = $overrideDefaultProperties;
        $this->parameterName = $parameterName;
        $this->whitelist = null === $whitelist ? null : $this->formatWhitelist($whitelist);
        $this->nameConverter = $nameConverter;
    }

    /**
     * {@inheritdoc}
     */
    public function apply(Request $request, bool $normalization, array $attributes, array &$context)
    {
        if (null !== $propertyAttribute = $request->attributes->get('_api_filter_property')) {
            $properties = $propertyAttribute;
        } elseif (\array_key_exists($this->parameterName, $commonAttribute = $request->attributes->get('_api_filters', []))) {
            $properties = $commonAttribute[$this->parameterName];
        } else {
            $properties = $request->query->get($this->parameterName);
        }

        if (!\is_array($properties)) {
            return;
        }

        $properties = $this->denormalizeProperties($properties);

        if (null !== $this->whitelist) {
            $properties = $this->getProperties($properties, $this->whitelist);
        }

        if (!$this->overrideDefaultProperties && isset($context[AbstractNormalizer::ATTRIBUTES])) {
            $properties = array_merge_recursive((array) $context[AbstractNormalizer::ATTRIBUTES], $properties);
        }

        $context[AbstractNormalizer::ATTRIBUTES] = $properties;
    }

    /**
     * {@inheritdoc}
     */
    public function getDescription(string $resourceClass): array
    {
        $example = sprintf('%1$s[]={propertyName}&%1$s[]={anotherPropertyName}&%1$s[{nestedPropertyParent}][]={nestedProperty}',
            $this->parameterName
        );

        return [
            "$this->parameterName[]" => [
                'property' => null,
                'type' => 'string',
                'is_collection' => true,
                'required' => false,
                'swagger' => [
                    'description' => 'Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: '.$example,
                    'name' => "$this->parameterName[]",
                    'type' => 'array',
                    'items' => [
                        'type' => 'string',
                    ],
                ],
                'openapi' => [
                    'description' => 'Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: '.$example,
                    'name' => "$this->parameterName[]",
                    'schema' => [
                        'type' => 'array',
                        'items' => [
                            'type' => 'string',
                        ],
                    ],
                ],
            ],
        ];
    }

    /**
     * Generate an array of whitelist properties to match the format that properties
     * will have in the request.
     *
     * @param array $whitelist the whitelist to format
     *
     * @return array An array containing the whitelist ready to match request parameters
     */
    private function formatWhitelist(array $whitelist): array
    {
        if (array_values($whitelist) === $whitelist) {
            return $whitelist;
        }
        foreach ($whitelist as $name => $value) {
            if (null === $value) {
                unset($whitelist[$name]);
                $whitelist[] = $name;
            }
        }

        return $whitelist;
    }

    private function getProperties(array $properties, array $whitelist = null): array
    {
        $whitelist = $whitelist ?? $this->whitelist;
        $result = [];

        foreach ($properties as $key => $value) {
            if (is_numeric($key)) {
                if (\in_array($propertyName = $this->denormalizePropertyName($value), $whitelist, true)) {
                    $result[] = $propertyName;
                }

                continue;
            }

            if (\is_array($value) && isset($whitelist[$key]) && $recursiveResult = $this->getProperties($value, $whitelist[$key])) {
                $result[$this->denormalizePropertyName($key)] = $recursiveResult;
            }
        }

        return $result;
    }

    private function denormalizeProperties(array $properties): array
    {
        if (null === $this->nameConverter || !$properties) {
            return $properties;
        }

        $result = [];
        foreach ($properties as $key => $value) {
            $result[$this->denormalizePropertyName((string) $key)] = \is_array($value) ? $this->denormalizeProperties($value) : $this->denormalizePropertyName($value);
        }

        return $result;
    }

    private function denormalizePropertyName($property)
    {
        return null !== $this->nameConverter ? $this->nameConverter->denormalize($property) : $property;
    }
}

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\Core\Serializer\Filter;
15
16	use Symfony\Component\HttpFoundation\Request;
17	use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
18	use Symfony\Component\Serializer\Normalizer\AbstractNormalizer;
19
20	/**
21	* Property filter.
22	*
23	* @author Baptiste Meyer <baptiste.meyer@gmail.com>
24	*/
25	final class PropertyFilter implements FilterInterface
26	{
27	private $overrideDefaultProperties;
28	private $parameterName;
29	private $whitelist;
30	private $nameConverter;
31
32	public function __construct(string $parameterName = 'properties', bool $overrideDefaultProperties = false, array $whitelist = null, NameConverterInterface $nameConverter = null)
33	{
34	$this->overrideDefaultProperties = $overrideDefaultProperties;	33✔
35	$this->parameterName = $parameterName;	33✔
36	$this->whitelist = null === $whitelist ? null : $this->formatWhitelist($whitelist);	33✔
37	$this->nameConverter = $nameConverter;	33✔
38	}	33✔
39
40	/**
41	* {@inheritdoc}
42	*/
43	public function apply(Request $request, bool $normalization, array $attributes, array &$context)
44	{
45	if (null !== $propertyAttribute = $request->attributes->get('_api_filter_property')) {	25✔
46	$properties = $propertyAttribute;	×
47	} elseif (\array_key_exists($this->parameterName, $commonAttribute = $request->attributes->get('_api_filters', []))) {	25✔
48	$properties = $commonAttribute[$this->parameterName];	2✔
49	} else {
50	$properties = $request->query->get($this->parameterName);	23✔
51	}
52
53	if (!\is_array($properties)) {	25✔
54	return;	11✔
55	}
56
57	$properties = $this->denormalizeProperties($properties);	14✔
58
59	if (null !== $this->whitelist) {	14✔
60	$properties = $this->getProperties($properties, $this->whitelist);	8✔
61	}
62
63	if (!$this->overrideDefaultProperties && isset($context[AbstractNormalizer::ATTRIBUTES])) {	14✔
64	$properties = array_merge_recursive((array) $context[AbstractNormalizer::ATTRIBUTES], $properties);	10✔
65	}
66
67	$context[AbstractNormalizer::ATTRIBUTES] = $properties;	14✔
68	}	14✔
69
70	/**
71	* {@inheritdoc}
72	*/
73	public function getDescription(string $resourceClass): array
74	{
75	$example = sprintf('%1$s[]={propertyName}&%1$s[]={anotherPropertyName}&%1$s[{nestedPropertyParent}][]={nestedProperty}',	11✔
76	$this->parameterName	11✔
77	);
78
79	return [
80	"$this->parameterName[]" => [	11✔
81	'property' => null,	11✔
82	'type' => 'string',	11✔
83	'is_collection' => true,
84	'required' => false,
85	'swagger' => [
86	'description' => 'Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: '.$example,	11✔
87	'name' => "$this->parameterName[]",	11✔
88	'type' => 'array',	11✔
89	'items' => [
90	'type' => 'string',
91	],
92	],
93	'openapi' => [
94	'description' => 'Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: '.$example,	11✔
95	'name' => "$this->parameterName[]",	11✔
96	'schema' => [
97	'type' => 'array',
98	'items' => [
99	'type' => 'string',
100	],
101	],
102	],
103	],
104	];
105	}
106
107	/**
108	* Generate an array of whitelist properties to match the format that properties
109	* will have in the request.
110	*
111	* @param array $whitelist the whitelist to format
112	*
113	* @return array An array containing the whitelist ready to match request parameters
114	*/
115	private function formatWhitelist(array $whitelist): array
116	{
117	if (array_values($whitelist) === $whitelist) {	15✔
118	return $whitelist;	13✔
119	}
120	foreach ($whitelist as $name => $value) {	9✔
121	if (null === $value) {	9✔
122	unset($whitelist[$name]);	9✔
123	$whitelist[] = $name;	9✔
124	}
125	}
126
127	return $whitelist;	9✔
128	}
129
130	private function getProperties(array $properties, array $whitelist = null): array
131	{
132	$whitelist = $whitelist ?? $this->whitelist;	8✔
133	$result = [];	8✔
134
135	foreach ($properties as $key => $value) {	8✔
136	if (is_numeric($key)) {	8✔
137	if (\in_array($propertyName = $this->denormalizePropertyName($value), $whitelist, true)) {	8✔
138	$result[] = $propertyName;	6✔
139	}
140
141	continue;	8✔
142	}
143
144	if (\is_array($value) && isset($whitelist[$key]) && $recursiveResult = $this->getProperties($value, $whitelist[$key])) {	4✔
145	$result[$this->denormalizePropertyName($key)] = $recursiveResult;	2✔
146	}
147	}
148
149	return $result;	8✔
150	}
151
152	private function denormalizeProperties(array $properties): array
153	{
154	if (null === $this->nameConverter \|\| !$properties) {	14✔
155	return $properties;	7✔
156	}
157
158	$result = [];	7✔
159	foreach ($properties as $key => $value) {	7✔
160	$result[$this->denormalizePropertyName((string) $key)] = \is_array($value) ? $this->denormalizeProperties($value) : $this->denormalizePropertyName($value);	7✔
161	}
162
163	return $result;	7✔
164	}
165
166	private function denormalizePropertyName($property)
167	{
168	return null !== $this->nameConverter ? $this->nameConverter->denormalize($property) : $property;	11✔
169	}
170	}

api-platform / core / #24520

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