#28175

pending completion

Build # #28175

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/<a class="double-link" href="https://git"><a class=hub.com/api-platform/core/commit/<a class="double-link" href="https://git"><a class=hub.com/api-platform/core/commit/e3dfafcab4d815d46bdb81478f5278c609c5a941">e3dfafcab<a href="https://github.com/api-platform/core/commit/e3dfafcab4d815d46bdb81478f5278c609c5a941">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/api-platform/core/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/api-platform/core/commit/e3dfafcab4d815d46bdb81478f5278c609c5a941&quot;&gt;e3dfafcab&lt;/a&gt;&lt;a href=&quot;https://github.com/api-platform/core/commit/e3dfafcab4d815d46bdb81478f5278c609c5a941&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/api-platform/core/commit/e3dfafcab4d815d46bdb81478f5278c6&lt;/a&gt;09c5a941">&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/503884b9587245c8b188e227d108bf76beed4188">503884b95</a><a href="https://github.com/api-platform/core/commit/e3dfafcab4d815d46bdb81478f5278c609c5a941">&amp;quot;&amp;gt;503884b95&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;503884b95&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/api-platform/core/commit/e3dfafcab4d815d46bdb81478f5278c609c5a&lt;/a&gt;941&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/8cc452c1f">8cc452c1f">8cc452c1f</a>

Run Details

2 of 2 new or added lines in 1 file covered. (100.0%)

13176 of 16535 relevant lines covered (79.69%)

14.71 hits per line

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

90.0

/src/Doctrine/Common/Filter/RangeFilterTrait.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\Doctrine\Common\Filter;

use ApiPlatform\Doctrine\Common\PropertyHelperTrait;
use ApiPlatform\Exception\InvalidArgumentException;
use Psr\Log\LoggerInterface;
use Ramsey\Uuid\Nonstandard\UuidV6;

/**
 * Trait for filtering the collection by range.
 *
 * @author Lee Siong Chan <ahlee2326@me.com>
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
trait RangeFilterTrait
{
    use PropertyHelperTrait;

    /**
     * {@inheritdoc}
     */
    public function getDescription(string $resourceClass): array
    {
        $description = [];

        $properties = $this->getProperties();
        if (null === $properties) {
            $properties = array_fill_keys($this->getClassMetadata($resourceClass)->getFieldNames(), null);
        }

        foreach ($properties as $property => $unused) {
            if (!$this->isPropertyMapped($property, $resourceClass)) {
                continue;
            }

            $description += $this->getFilterDescription($property, self::PARAMETER_BETWEEN);
            $description += $this->getFilterDescription($property, self::PARAMETER_GREATER_THAN);
            $description += $this->getFilterDescription($property, self::PARAMETER_GREATER_THAN_OR_EQUAL);
            $description += $this->getFilterDescription($property, self::PARAMETER_LESS_THAN);
            $description += $this->getFilterDescription($property, self::PARAMETER_LESS_THAN_OR_EQUAL);
        }

        return $description;
    }

    abstract protected function getProperties(): ?array;

    abstract protected function getLogger(): LoggerInterface;

    abstract protected function normalizePropertyName($property);

    /**
     * Gets filter description.
     */
    protected function getFilterDescription(string $fieldName, string $operator): array
    {
        $propertyName = $this->normalizePropertyName($fieldName);

        return [
            sprintf('%s[%s]', $propertyName, $operator) => [
                'property' => $propertyName,
                'type' => 'string',
                'required' => false,
            ],
        ];
    }

    private function normalizeValues(array $values, string $property): ?array
    {
        $operators = [self::PARAMETER_BETWEEN, self::PARAMETER_GREATER_THAN, self::PARAMETER_GREATER_THAN_OR_EQUAL, self::PARAMETER_LESS_THAN, self::PARAMETER_LESS_THAN_OR_EQUAL];

        foreach ($values as $operator => $value) {
            if (!\in_array($operator, $operators, true)) {
                unset($values[$operator]);
            }
        }

        if (empty($values)) {
            $this->getLogger()->notice('Invalid filter ignored', [
                'exception' => new InvalidArgumentException(sprintf('At least one valid operator ("%s") is required for "%s" property', implode('", "', $operators), $property)),
            ]);

            return null;
        }

        return $values;
    }

    /**
     * Normalize the values array for between operator.
     */
    private function normalizeBetweenValues(array $values): ?array
    {
        if (2 !== \count($values)) {
            $this->getLogger()->notice('Invalid filter ignored', [
                'exception' => new InvalidArgumentException(sprintf('Invalid format for "[%s]", expected "<min>..<max>"', self::PARAMETER_BETWEEN)),
            ]);

            return null;
        }

        if (!is_numeric($values[0]) || !is_numeric($values[1])) {
            $this->getLogger()->notice('Invalid filter ignored', [
                'exception' => new InvalidArgumentException(sprintf('Invalid values for "[%s]" range, expected numbers', self::PARAMETER_BETWEEN)),
            ]);

            return null;
        }

        return [$values[0] + 0, $values[1] + 0]; // coerce to the right types.
    }

    /**
     * Normalize the value.
     *
     * @return int|float|string | null
     */
    private function normalizeValue(string $value, string $operator)
    {
        if (!is_numeric($value) && !UuidV6::isValid($value)) {
            $this->getLogger()->notice('Invalid filter ignored', [
                'exception' => new InvalidArgumentException(sprintf('Invalid value for "[%s]", expected number', $operator)),
            ]);

            return null;
        }

        return $value;
    }
}

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\Doctrine\Common\Filter;
15
16	use ApiPlatform\Doctrine\Common\PropertyHelperTrait;
17	use ApiPlatform\Exception\InvalidArgumentException;
18	use Psr\Log\LoggerInterface;
19	use Ramsey\Uuid\Nonstandard\UuidV6;
20
21	/**
22	* Trait for filtering the collection by range.
23	*
24	* @author Lee Siong Chan <ahlee2326@me.com>
25	* @author Alan Poulain <contact@alanpoulain.eu>
26	*/
27	trait RangeFilterTrait
28	{
29	use PropertyHelperTrait;
30
31	/**
32	* {@inheritdoc}
33	*/
34	public function getDescription(string $resourceClass): array
35	{
36	$description = [];	10✔
37
38	$properties = $this->getProperties();	10✔
39	if (null === $properties) {	10✔
40	$properties = array_fill_keys($this->getClassMetadata($resourceClass)->getFieldNames(), null);	1✔
41	}
42
43	foreach ($properties as $property => $unused) {	10✔
44	if (!$this->isPropertyMapped($property, $resourceClass)) {	10✔
45	continue;	6✔
46	}
47
48	$description += $this->getFilterDescription($property, self::PARAMETER_BETWEEN);	10✔
49	$description += $this->getFilterDescription($property, self::PARAMETER_GREATER_THAN);	10✔
50	$description += $this->getFilterDescription($property, self::PARAMETER_GREATER_THAN_OR_EQUAL);	10✔
51	$description += $this->getFilterDescription($property, self::PARAMETER_LESS_THAN);	10✔
52	$description += $this->getFilterDescription($property, self::PARAMETER_LESS_THAN_OR_EQUAL);	10✔
53	}
54
55	return $description;	10✔
56	}
57
58	abstract protected function getProperties(): ?array;
59
60	abstract protected function getLogger(): LoggerInterface;
61
62	abstract protected function normalizePropertyName($property);
63
64	/**
65	* Gets filter description.
66	*/
67	protected function getFilterDescription(string $fieldName, string $operator): array
68	{
69	$propertyName = $this->normalizePropertyName($fieldName);	10✔
70
71	return [
72	sprintf('%s[%s]', $propertyName, $operator) => [	10✔
73	'property' => $propertyName,	10✔
74	'type' => 'string',	10✔
75	'required' => false,
76	],
77	];
78	}
79
80	private function normalizeValues(array $values, string $property): ?array
81	{
82	$operators = [self::PARAMETER_BETWEEN, self::PARAMETER_GREATER_THAN, self::PARAMETER_GREATER_THAN_OR_EQUAL, self::PARAMETER_LESS_THAN, self::PARAMETER_LESS_THAN_OR_EQUAL];	28✔
83
84	foreach ($values as $operator => $value) {	28✔
85	if (!\in_array($operator, $operators, true)) {	28✔
86	unset($values[$operator]);	×
87	}
88	}
89
90	if (empty($values)) {	28✔
91	$this->getLogger()->notice('Invalid filter ignored', [	×
92	'exception' => new InvalidArgumentException(sprintf('At least one valid operator ("%s") is required for "%s" property', implode('", "', $operators), $property)),	×
93	]);
94
95	return null;	×
96	}
97
98	return $values;	28✔
99	}
100
101	/**
102	* Normalize the values array for between operator.
103	*/
104	private function normalizeBetweenValues(array $values): ?array
105	{
106	if (2 !== \count($values)) {	10✔
107	$this->getLogger()->notice('Invalid filter ignored', [	4✔
108	'exception' => new InvalidArgumentException(sprintf('Invalid format for "[%s]", expected "<min>..<max>"', self::PARAMETER_BETWEEN)),	4✔
109	]);
110
111	return null;	4✔
112	}
113
114	if (!is_numeric($values[0]) \|\| !is_numeric($values[1])) {	6✔
115	$this->getLogger()->notice('Invalid filter ignored', [	2✔
116	'exception' => new InvalidArgumentException(sprintf('Invalid values for "[%s]" range, expected numbers', self::PARAMETER_BETWEEN)),	2✔
117	]);
118
119	return null;	2✔
120	}
121
122	return [$values[0] + 0, $values[1] + 0]; // coerce to the right types.	4✔
123	}
124
125	/**
126	* Normalize the value.
127	*
128	* @return int\|float\|string \| null
129	*/
130	private function normalizeValue(string $value, string $operator)
131	{
132	if (!is_numeric($value) && !UuidV6::isValid($value)) {	18✔
133	$this->getLogger()->notice('Invalid filter ignored', [	8✔
134	'exception' => new InvalidArgumentException(sprintf('Invalid value for "[%s]", expected number', $operator)),	8✔
135	]);
136
137	return null;	8✔
138	}
139
140	return $value;	10✔
141	}
142	}

api-platform / core / #28175

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