#25188

pending completion

Build # #25188

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/abf9dde9c064c72b8e853967990c4cc84bf1a603">abf9dde9c<a href="https://github.com/api-platform/core/commit/abf9dde9c064c72b8e853967990c4cc84bf1a603">">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/bc8d979be6d3d6126414a5b4b17c9bf60d7abf27">bc8d979be</a>">bc8d979be</a><a href="https://github.com/api-platform/core/commit/abf9dde9c064c72b8e853967990c4cc84bf1a603"> into cfc05d1ce">cfc05d1ce</a>

Run Details

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

6100 of 12049 relevant lines covered (50.63%)

58.81 hits per line

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

73.08

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

use ApiPlatform\Core\Api\IriConverterInterface;
use ApiPlatform\Core\Bridge\Doctrine\Common\PropertyHelperTrait;
use ApiPlatform\Core\Exception\InvalidArgumentException;
use Psr\Log\LoggerInterface;
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;

/**
 * Trait for filtering the collection by given properties.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
trait SearchFilterTrait
{
    use PropertyHelperTrait;

    protected $iriConverter;
    protected $propertyAccessor;
    protected $identifiersExtractor;

    /**
     * {@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 => $strategy) {
            if (!$this->isPropertyMapped($property, $resourceClass, true)) {
                continue;
            }

            if ($this->isPropertyNested($property, $resourceClass)) {
                $propertyParts = $this->splitPropertyParts($property, $resourceClass);
                $field = $propertyParts['field'];
                $metadata = $this->getNestedMetadata($resourceClass, $propertyParts['associations']);
            } else {
                $field = $property;
                $metadata = $this->getClassMetadata($resourceClass);
            }

            $propertyName = $this->normalizePropertyName($property);
            if ($metadata->hasField($field)) {
                $typeOfField = $this->getType($metadata->getTypeOfField($field));
                $strategy = $this->getProperties()[$property] ?? self::STRATEGY_EXACT;
                $filterParameterNames = [$propertyName];

                if (self::STRATEGY_EXACT === $strategy) {
                    $filterParameterNames[] = $propertyName.'[]';
                }

                foreach ($filterParameterNames as $filterParameterName) {
                    $description[$filterParameterName] = [
                        'property' => $propertyName,
                        'type' => $typeOfField,
                        'required' => false,
                        'strategy' => $strategy,
                        'is_collection' => '[]' === substr((string) $filterParameterName, -2),
                    ];
                }
            } elseif ($metadata->hasAssociation($field)) {
                $filterParameterNames = [
                    $propertyName,
                    $propertyName.'[]',
                ];

                foreach ($filterParameterNames as $filterParameterName) {
                    $description[$filterParameterName] = [
                        'property' => $propertyName,
                        'type' => 'string',
                        'required' => false,
                        'strategy' => self::STRATEGY_EXACT,
                        'is_collection' => '[]' === substr((string) $filterParameterName, -2),
                    ];
                }
            }
        }

        return $description;
    }

    /**
     * Converts a Doctrine type in PHP type.
     */
    abstract protected function getType(string $doctrineType): string;

    abstract protected function getProperties(): ?array;

    abstract protected function getLogger(): LoggerInterface;

    abstract protected function getIriConverter(): IriConverterInterface;

    abstract protected function getPropertyAccessor(): PropertyAccessorInterface;

    abstract protected function normalizePropertyName($property);

    /**
     * Gets the ID from an IRI or a raw ID.
     */
    protected function getIdFromValue(string $value)
    {
        try {
            $item = $this->getIriConverter()->getItemFromIri($value, ['fetch_data' => false]);

            return $this->getPropertyAccessor()->getValue($item, 'id');
        } catch (InvalidArgumentException $e) {
            // Do nothing, return the raw value
        }

        return $value;
    }

    /**
     * Normalize the values array.
     */
    protected function normalizeValues(array $values, string $property): ?array
    {
        foreach ($values as $key => $value) {
            if (!\is_int($key) || !\is_string($value)) {
                unset($values[$key]);
            }
        }

        if (empty($values)) {
            $this->getLogger()->notice('Invalid filter ignored', [
                'exception' => new InvalidArgumentException(sprintf('At least one value is required, multiple values should be in "%1$s[]=firstvalue&%1$s[]=secondvalue" format', $property)),
            ]);

            return null;
        }

        return array_values($values);
    }

    /**
     * When the field should be an integer, check that the given value is a valid one.
     *
     * @param mixed|null $type
     */
    protected function hasValidValues(array $values, $type = null): bool
    {
        foreach ($values as $key => $value) {
            if (self::DOCTRINE_INTEGER_TYPE === $type && null !== $value && false === filter_var($value, FILTER_VALIDATE_INT)) {
                return false;
            }
        }

        return true;
    }
}

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\Bridge\Doctrine\Common\Filter;
15
16	use ApiPlatform\Core\Api\IriConverterInterface;
17	use ApiPlatform\Core\Bridge\Doctrine\Common\PropertyHelperTrait;
18	use ApiPlatform\Core\Exception\InvalidArgumentException;
19	use Psr\Log\LoggerInterface;
20	use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
21
22	/**
23	* Trait for filtering the collection by given properties.
24	*
25	* @author Kévin Dunglas <dunglas@gmail.com>
26	* @author Alan Poulain <contact@alanpoulain.eu>
27	*/
28	trait SearchFilterTrait
29	{
30	use PropertyHelperTrait;
31
32	protected $iriConverter;
33	protected $propertyAccessor;
34	protected $identifiersExtractor;
35
36	/**
37	* {@inheritdoc}
38	*/
39	public function getDescription(string $resourceClass): array
40	{
41	$description = [];	206✔
42
43	$properties = $this->getProperties();	206✔
44	if (null === $properties) {	206✔
45	$properties = array_fill_keys($this->getClassMetadata($resourceClass)->getFieldNames(), null);	×
46	}
47
48	foreach ($properties as $property => $strategy) {	206✔
49	if (!$this->isPropertyMapped($property, $resourceClass, true)) {	206✔
50	continue;	199✔
51	}
52
53	if ($this->isPropertyNested($property, $resourceClass)) {	206✔
54	$propertyParts = $this->splitPropertyParts($property, $resourceClass);	205✔
55	$field = $propertyParts['field'];	205✔
56	$metadata = $this->getNestedMetadata($resourceClass, $propertyParts['associations']);	205✔
57	} else {
58	$field = $property;	205✔
59	$metadata = $this->getClassMetadata($resourceClass);	205✔
60	}
61
62	$propertyName = $this->normalizePropertyName($property);	206✔
63	if ($metadata->hasField($field)) {	206✔
64	$typeOfField = $this->getType($metadata->getTypeOfField($field));	206✔
65	$strategy = $this->getProperties()[$property] ?? self::STRATEGY_EXACT;	206✔
66	$filterParameterNames = [$propertyName];	206✔
67
68	if (self::STRATEGY_EXACT === $strategy) {	206✔
69	$filterParameterNames[] = $propertyName.'[]';	205✔
70	}
71
72	foreach ($filterParameterNames as $filterParameterName) {	206✔
73	$description[$filterParameterName] = [	206✔
74	'property' => $propertyName,	206✔
75	'type' => $typeOfField,	206✔
76	'required' => false,
77	'strategy' => $strategy,	206✔
78	'is_collection' => '[]' === substr((string) $filterParameterName, -2),	206✔
79	];
80	}
81	} elseif ($metadata->hasAssociation($field)) {	×
82	$filterParameterNames = [
83	$propertyName,	×
84	$propertyName.'[]',	×
85	];
86
87	foreach ($filterParameterNames as $filterParameterName) {	×
88	$description[$filterParameterName] = [	×
89	'property' => $propertyName,	×
90	'type' => 'string',	×
91	'required' => false,
92	'strategy' => self::STRATEGY_EXACT,	×
93	'is_collection' => '[]' === substr((string) $filterParameterName, -2),	×
94	];
95	}
96	}
97	}
98
99	return $description;	206✔
100	}
101
102	/**
103	* Converts a Doctrine type in PHP type.
104	*/
105	abstract protected function getType(string $doctrineType): string;
106
107	abstract protected function getProperties(): ?array;
108
109	abstract protected function getLogger(): LoggerInterface;
110
111	abstract protected function getIriConverter(): IriConverterInterface;
112
113	abstract protected function getPropertyAccessor(): PropertyAccessorInterface;
114
115	abstract protected function normalizePropertyName($property);
116
117	/**
118	* Gets the ID from an IRI or a raw ID.
119	*/
120	protected function getIdFromValue(string $value)
121	{
122	try {
123	$item = $this->getIriConverter()->getItemFromIri($value, ['fetch_data' => false]);	8✔
124
125	return $this->getPropertyAccessor()->getValue($item, 'id');	4✔
126	} catch (InvalidArgumentException $e) {	4✔
127	// Do nothing, return the raw value
128	}
129
130	return $value;	4✔
131	}
132
133	/**
134	* Normalize the values array.
135	*/
136	protected function normalizeValues(array $values, string $property): ?array
137	{
138	foreach ($values as $key => $value) {	30✔
139	if (!\is_int($key) \|\| !\is_string($value)) {	30✔
140	unset($values[$key]);	×
141	}
142	}
143
144	if (empty($values)) {	30✔
145	$this->getLogger()->notice('Invalid filter ignored', [	×
146	'exception' => new InvalidArgumentException(sprintf('At least one value is required, multiple values should be in "%1$s[]=firstvalue&%1$s[]=secondvalue" format', $property)),	×
147	]);
148
149	return null;	×
150	}
151
152	return array_values($values);	30✔
153	}
154
155	/**
156	* When the field should be an integer, check that the given value is a valid one.
157	*
158	* @param mixed\|null $type
159	*/
160	protected function hasValidValues(array $values, $type = null): bool
161	{
162	foreach ($values as $key => $value) {	30✔
163	if (self::DOCTRINE_INTEGER_TYPE === $type && null !== $value && false === filter_var($value, FILTER_VALIDATE_INT)) {	30✔
164	return false;	1✔
165	}
166	}
167
168	return true;	29✔
169	}
170	}

api-platform / core / #25188

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