#25488

pending completion

Build # #25488

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/54e36656d19c62769ac7b5d48137418adee9f28d">54e36656d<a href="https://github.com/api-platform/core/commit/54e36656d19c62769ac7b5d48137418adee9f28d">">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/249a2226a811d925f5b7be7ba256570d012a3ac4">249a2226a</a>">249a2226a</a><a href="https://github.com/api-platform/core/commit/54e36656d19c62769ac7b5d48137418adee9f28d"> into d83d50228">d83d50228</a>

Run Details

67 of 67 new or added lines in 10 files covered. (100.0%)

8654 of 10201 relevant lines covered (84.83%)

15.07 hits per line

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

92.62

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

use ApiPlatform\Core\Api\IdentifiersExtractorInterface;
use ApiPlatform\Core\Api\IriConverterInterface;
use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\SearchFilterInterface;
use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\SearchFilterTrait;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryBuilderHelper;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
use ApiPlatform\Core\Exception\InvalidArgumentException;
use Doctrine\Common\Persistence\ManagerRegistry;
use Doctrine\DBAL\Types\Type as DBALType;
use Doctrine\ORM\QueryBuilder;
use Psr\Log\LoggerInterface;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\PropertyAccess\PropertyAccess;
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;

/**
 * Filter the collection by given properties.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 */
class SearchFilter extends AbstractContextAwareFilter implements SearchFilterInterface
{
    use SearchFilterTrait;

    public const DOCTRINE_INTEGER_TYPE = DBALType::INTEGER;

    public function __construct(ManagerRegistry $managerRegistry, ?RequestStack $requestStack, IriConverterInterface $iriConverter, PropertyAccessorInterface $propertyAccessor = null, LoggerInterface $logger = null, array $properties = null, IdentifiersExtractorInterface $identifiersExtractor = null, NameConverterInterface $nameConverter = null)
    {
        parent::__construct($managerRegistry, $requestStack, $logger, $properties, $nameConverter);

        if (null === $identifiersExtractor) {
            @trigger_error('Not injecting ItemIdentifiersExtractor is deprecated since API Platform 2.5 and can lead to unexpected behaviors, it will not be possible anymore in API Platform 3.0.', E_USER_DEPRECATED);
        }

        $this->iriConverter = $iriConverter;
        $this->identifiersExtractor = $identifiersExtractor;
        $this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();
    }

    protected function getIriConverter(): IriConverterInterface
    {
        return $this->iriConverter;
    }

    protected function getPropertyAccessor(): PropertyAccessorInterface
    {
        return $this->propertyAccessor;
    }

    /**
     * {@inheritdoc}
     */
    protected function filterProperty(string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
    {
        if (
            null === $value ||
            !$this->isPropertyEnabled($property, $resourceClass) ||
            !$this->isPropertyMapped($property, $resourceClass, true)
        ) {
            return;
        }

        $alias = $queryBuilder->getRootAliases()[0];
        $field = $property;

        $associations = [];
        if ($this->isPropertyNested($property, $resourceClass)) {
            [$alias, $field, $associations] = $this->addJoinsForNestedProperty($property, $alias, $queryBuilder, $queryNameGenerator, $resourceClass);
        }

        $values = $this->normalizeValues((array) $value, $property);
        if (null === $values) {
            return;
        }

        $caseSensitive = true;
        $metadata = $this->getNestedMetadata($resourceClass, $associations);

        if ($metadata->hasField($field)) {
            if ('id' === $field) {
                $values = array_map([$this, 'getIdFromValue'], $values);
            }

            if (!$this->hasValidValues($values, $this->getDoctrineFieldType($property, $resourceClass))) {
                $this->logger->notice('Invalid filter ignored', [
                    'exception' => new InvalidArgumentException(sprintf('Values for field "%s" are not valid according to the doctrine type.', $field)),
                ]);

                return;
            }

            $strategy = $this->properties[$property] ?? self::STRATEGY_EXACT;

            // prefixing the strategy with i makes it case insensitive
            if (0 === strpos($strategy, 'i')) {
                $strategy = substr($strategy, 1);
                $caseSensitive = false;
            }

            if (1 === \count($values)) {
                $this->addWhereByStrategy($strategy, $queryBuilder, $queryNameGenerator, $alias, $field, $values[0], $caseSensitive);

                return;
            }

            if (self::STRATEGY_EXACT !== $strategy) {
                $this->logger->notice('Invalid filter ignored', [
                    'exception' => new InvalidArgumentException(sprintf('"%s" strategy selected for "%s" property, but only "%s" strategy supports multiple values', $strategy, $property, self::STRATEGY_EXACT)),
                ]);

                return;
            }

            $wrapCase = $this->createWrapCase($caseSensitive);
            $valueParameter = $queryNameGenerator->generateParameterName($field);

            $queryBuilder
                ->andWhere(sprintf($wrapCase('%s.%s').' IN (:%s)', $alias, $field, $valueParameter))
                ->setParameter($valueParameter, $caseSensitive ? $values : array_map('strtolower', $values));
        }

        // metadata doesn't have the field, nor an association on the field
        if (!$metadata->hasAssociation($field)) {
            return;
        }

        $values = array_map([$this, 'getIdFromValue'], $values);
        $associationFieldIdentifier = 'id';
        $doctrineTypeField = $this->getDoctrineFieldType($property, $resourceClass);

        if (null !== $this->identifiersExtractor) {
            $associationResourceClass = $metadata->getAssociationTargetClass($field);
            $associationFieldIdentifier = $this->identifiersExtractor->getIdentifiersFromResourceClass($associationResourceClass)[0];
            $doctrineTypeField = $this->getDoctrineFieldType($associationFieldIdentifier, $associationResourceClass);
        }

        if (!$this->hasValidValues($values, $doctrineTypeField)) {
            $this->logger->notice('Invalid filter ignored', [
                'exception' => new InvalidArgumentException(sprintf('Values for field "%s" are not valid according to the doctrine type.', $field)),
            ]);

            return;
        }

        $association = $field;
        $valueParameter = $queryNameGenerator->generateParameterName($association);
        if ($metadata->isCollectionValuedAssociation($association)) {
            $associationAlias = QueryBuilderHelper::addJoinOnce($queryBuilder, $queryNameGenerator, $alias, $association);
            $associationField = $associationFieldIdentifier;
        } else {
            $associationAlias = $alias;
            $associationField = $field;
        }

        if (1 === \count($values)) {
            $queryBuilder
                ->andWhere(sprintf('%s.%s = :%s', $associationAlias, $associationField, $valueParameter))
                ->setParameter($valueParameter, $values[0]);
        } else {
            $queryBuilder
                ->andWhere(sprintf('%s.%s IN (:%s)', $associationAlias, $associationField, $valueParameter))
                ->setParameter($valueParameter, $values);
        }
    }

    /**
     * Adds where clause according to the strategy.
     *
     * @throws InvalidArgumentException If strategy does not exist
     */
    protected function addWhereByStrategy(string $strategy, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $alias, string $field, $value, bool $caseSensitive)
    {
        $wrapCase = $this->createWrapCase($caseSensitive);
        $valueParameter = $queryNameGenerator->generateParameterName($field);

        switch ($strategy) {
            case null:
            case self::STRATEGY_EXACT:
                $queryBuilder
                    ->andWhere(sprintf($wrapCase('%s.%s').' = '.$wrapCase(':%s'), $alias, $field, $valueParameter))
                    ->setParameter($valueParameter, $value);
                break;
            case self::STRATEGY_PARTIAL:
                $queryBuilder
                    ->andWhere(sprintf($wrapCase('%s.%s').' LIKE '.$wrapCase('CONCAT(\'%%\', :%s, \'%%\')'), $alias, $field, $valueParameter))
                    ->setParameter($valueParameter, $value);
                break;
            case self::STRATEGY_START:
                $queryBuilder
                    ->andWhere(sprintf($wrapCase('%s.%s').' LIKE '.$wrapCase('CONCAT(:%s, \'%%\')'), $alias, $field, $valueParameter))
                    ->setParameter($valueParameter, $value);
                break;
            case self::STRATEGY_END:
                $queryBuilder
                    ->andWhere(sprintf($wrapCase('%s.%s').' LIKE '.$wrapCase('CONCAT(\'%%\', :%s)'), $alias, $field, $valueParameter))
                    ->setParameter($valueParameter, $value);
                break;
            case self::STRATEGY_WORD_START:
                $queryBuilder
                    ->andWhere(sprintf($wrapCase('%1$s.%2$s').' LIKE '.$wrapCase('CONCAT(:%3$s, \'%%\')').' OR '.$wrapCase('%1$s.%2$s').' LIKE '.$wrapCase('CONCAT(\'%% \', :%3$s, \'%%\')'), $alias, $field, $valueParameter))
                    ->setParameter($valueParameter, $value);
                break;
            default:
                throw new InvalidArgumentException(sprintf('strategy %s does not exist.', $strategy));
        }
    }

    /**
     * Creates a function that will wrap a Doctrine expression according to the
     * specified case sensitivity.
     *
     * For example, "o.name" will get wrapped into "LOWER(o.name)" when $caseSensitive
     * is false.
     */
    protected function createWrapCase(bool $caseSensitive): \Closure
    {
        return static function (string $expr) use ($caseSensitive): string {
            if ($caseSensitive) {
                return $expr;
            }

            return sprintf('LOWER(%s)', $expr);
        };
    }

    /**
     * {@inheritdoc}
     */
    protected function getType(string $doctrineType): string
    {
        switch ($doctrineType) {
            case DBALType::TARRAY:
                return 'array';
            case DBALType::BIGINT:
            case DBALType::INTEGER:
            case DBALType::SMALLINT:
                return 'int';
            case DBALType::BOOLEAN:
                return 'bool';
            case DBALType::DATE:
            case DBALType::TIME:
            case DBALType::DATETIME:
            case DBALType::DATETIMETZ:
                return \DateTimeInterface::class;
            case DBALType::FLOAT:
                return 'float';
        }

        if (\defined(DBALType::class.'::DATE_IMMUTABLE')) {
            switch ($doctrineType) {
                case DBALType::DATE_IMMUTABLE:
                case DBALType::TIME_IMMUTABLE:
                case DBALType::DATETIME_IMMUTABLE:
                case DBALType::DATETIMETZ_IMMUTABLE:
                    return \DateTimeInterface::class;
            }
        }

        return 'string';
    }
}

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\Orm\Filter;
15
16	use ApiPlatform\Core\Api\IdentifiersExtractorInterface;
17	use ApiPlatform\Core\Api\IriConverterInterface;
18	use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\SearchFilterInterface;
19	use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\SearchFilterTrait;
20	use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryBuilderHelper;
21	use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
22	use ApiPlatform\Core\Exception\InvalidArgumentException;
23	use Doctrine\Common\Persistence\ManagerRegistry;
24	use Doctrine\DBAL\Types\Type as DBALType;
25	use Doctrine\ORM\QueryBuilder;
26	use Psr\Log\LoggerInterface;
27	use Symfony\Component\HttpFoundation\RequestStack;
28	use Symfony\Component\PropertyAccess\PropertyAccess;
29	use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
30	use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
31
32	/**
33	* Filter the collection by given properties.
34	*
35	* @author Kévin Dunglas <dunglas@gmail.com>
36	*/
37	class SearchFilter extends AbstractContextAwareFilter implements SearchFilterInterface
38	{
39	use SearchFilterTrait;
40
41	public const DOCTRINE_INTEGER_TYPE = DBALType::INTEGER;
42
43	public function __construct(ManagerRegistry $managerRegistry, ?RequestStack $requestStack, IriConverterInterface $iriConverter, PropertyAccessorInterface $propertyAccessor = null, LoggerInterface $logger = null, array $properties = null, IdentifiersExtractorInterface $identifiersExtractor = null, NameConverterInterface $nameConverter = null)
44	{
45	parent::__construct($managerRegistry, $requestStack, $logger, $properties, $nameConverter);	64✔
46
47	if (null === $identifiersExtractor) {	64✔
48	@trigger_error('Not injecting ItemIdentifiersExtractor is deprecated since API Platform 2.5 and can lead to unexpected behaviors, it will not be possible anymore in API Platform 3.0.', E_USER_DEPRECATED);	1✔
49	}
50
51	$this->iriConverter = $iriConverter;	64✔
52	$this->identifiersExtractor = $identifiersExtractor;	64✔
53	$this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();	64✔
54	}	64✔
55
56	protected function getIriConverter(): IriConverterInterface
57	{
58	return $this->iriConverter;	10✔
59	}
60
61	protected function getPropertyAccessor(): PropertyAccessorInterface
62	{
63	return $this->propertyAccessor;	4✔
64	}
65
66	/**
67	* {@inheritdoc}
68	*/
69	protected function filterProperty(string $property, $value, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
70	{
71	if (
72	null === $value \|\|	46✔
73	!$this->isPropertyEnabled($property, $resourceClass) \|\|	46✔
74	!$this->isPropertyMapped($property, $resourceClass, true)	46✔
75	) {
76	return;	2✔
77	}
78
79	$alias = $queryBuilder->getRootAliases()[0];	44✔
80	$field = $property;	44✔
81
82	$associations = [];	44✔
83	if ($this->isPropertyNested($property, $resourceClass)) {	44✔
84	[$alias, $field, $associations] = $this->addJoinsForNestedProperty($property, $alias, $queryBuilder, $queryNameGenerator, $resourceClass);	10✔
85	}
86
87	$values = $this->normalizeValues((array) $value, $property);	44✔
88	if (null === $values) {	44✔
89	return;	2✔
90	}
91
92	$caseSensitive = true;	44✔
93	$metadata = $this->getNestedMetadata($resourceClass, $associations);	44✔
94
95	if ($metadata->hasField($field)) {	44✔
96	if ('id' === $field) {	38✔
97	$values = array_map([$this, 'getIdFromValue'], $values);	2✔
98	}
99
100	if (!$this->hasValidValues($values, $this->getDoctrineFieldType($property, $resourceClass))) {	38✔
101	$this->logger->notice('Invalid filter ignored', [	×
102	'exception' => new InvalidArgumentException(sprintf('Values for field "%s" are not valid according to the doctrine type.', $field)),	×
103	]);
104
105	return;	×
106	}
107
108	$strategy = $this->properties[$property] ?? self::STRATEGY_EXACT;	38✔
109
110	// prefixing the strategy with i makes it case insensitive
111	if (0 === strpos($strategy, 'i')) {	38✔
112	$strategy = substr($strategy, 1);	12✔
113	$caseSensitive = false;	12✔
114	}
115
116	if (1 === \count($values)) {	38✔
117	$this->addWhereByStrategy($strategy, $queryBuilder, $queryNameGenerator, $alias, $field, $values[0], $caseSensitive);	34✔
118
119	return;	34✔
120	}
121
122	if (self::STRATEGY_EXACT !== $strategy) {	4✔
123	$this->logger->notice('Invalid filter ignored', [	×
124	'exception' => new InvalidArgumentException(sprintf('"%s" strategy selected for "%s" property, but only "%s" strategy supports multiple values', $strategy, $property, self::STRATEGY_EXACT)),	×
125	]);
126
127	return;	×
128	}
129
130	$wrapCase = $this->createWrapCase($caseSensitive);	4✔
131	$valueParameter = $queryNameGenerator->generateParameterName($field);	4✔
132
133	$queryBuilder
134	->andWhere(sprintf($wrapCase('%s.%s').' IN (:%s)', $alias, $field, $valueParameter))	4✔
135	->setParameter($valueParameter, $caseSensitive ? $values : array_map('strtolower', $values));	4✔
136	}
137
138	// metadata doesn't have the field, nor an association on the field
139	if (!$metadata->hasAssociation($field)) {	12✔
140	return;	4✔
141	}
142
143	$values = array_map([$this, 'getIdFromValue'], $values);	8✔
144	$associationFieldIdentifier = 'id';	8✔
145	$doctrineTypeField = $this->getDoctrineFieldType($property, $resourceClass);	8✔
146
147	if (null !== $this->identifiersExtractor) {	8✔
148	$associationResourceClass = $metadata->getAssociationTargetClass($field);	8✔
149	$associationFieldIdentifier = $this->identifiersExtractor->getIdentifiersFromResourceClass($associationResourceClass)[0];	8✔
150	$doctrineTypeField = $this->getDoctrineFieldType($associationFieldIdentifier, $associationResourceClass);	8✔
151	}
152
153	if (!$this->hasValidValues($values, $doctrineTypeField)) {	8✔
154	$this->logger->notice('Invalid filter ignored', [	6✔
155	'exception' => new InvalidArgumentException(sprintf('Values for field "%s" are not valid according to the doctrine type.', $field)),	6✔
156	]);
157
158	return;	6✔
159	}
160
161	$association = $field;	2✔
162	$valueParameter = $queryNameGenerator->generateParameterName($association);	2✔
163	if ($metadata->isCollectionValuedAssociation($association)) {	2✔
164	$associationAlias = QueryBuilderHelper::addJoinOnce($queryBuilder, $queryNameGenerator, $alias, $association);	2✔
165	$associationField = $associationFieldIdentifier;	2✔
166	} else {
167	$associationAlias = $alias;	2✔
168	$associationField = $field;	2✔
169	}
170
171	if (1 === \count($values)) {	2✔
172	$queryBuilder
173	->andWhere(sprintf('%s.%s = :%s', $associationAlias, $associationField, $valueParameter))	2✔
174	->setParameter($valueParameter, $values[0]);	2✔
175	} else {
176	$queryBuilder
177	->andWhere(sprintf('%s.%s IN (:%s)', $associationAlias, $associationField, $valueParameter))	2✔
178	->setParameter($valueParameter, $values);	2✔
179	}
180	}	2✔
181
182	/**
183	* Adds where clause according to the strategy.
184	*
185	* @throws InvalidArgumentException If strategy does not exist
186	*/
187	protected function addWhereByStrategy(string $strategy, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $alias, string $field, $value, bool $caseSensitive)
188	{
189	$wrapCase = $this->createWrapCase($caseSensitive);	34✔
190	$valueParameter = $queryNameGenerator->generateParameterName($field);	34✔
191
192	switch ($strategy) {	34✔
193	case null:
194	case self::STRATEGY_EXACT:	34✔
195	$queryBuilder
196	->andWhere(sprintf($wrapCase('%s.%s').' = '.$wrapCase(':%s'), $alias, $field, $valueParameter))	18✔
197	->setParameter($valueParameter, $value);	18✔
198	break;	18✔
199	case self::STRATEGY_PARTIAL:	16✔
200	$queryBuilder
201	->andWhere(sprintf($wrapCase('%s.%s').' LIKE '.$wrapCase('CONCAT(\'%%\', :%s, \'%%\')'), $alias, $field, $valueParameter))	4✔
202	->setParameter($valueParameter, $value);	4✔
203	break;	4✔
204	case self::STRATEGY_START:	12✔
205	$queryBuilder
206	->andWhere(sprintf($wrapCase('%s.%s').' LIKE '.$wrapCase('CONCAT(:%s, \'%%\')'), $alias, $field, $valueParameter))	4✔
207	->setParameter($valueParameter, $value);	4✔
208	break;	4✔
209	case self::STRATEGY_END:	8✔
210	$queryBuilder
211	->andWhere(sprintf($wrapCase('%s.%s').' LIKE '.$wrapCase('CONCAT(\'%%\', :%s)'), $alias, $field, $valueParameter))	4✔
212	->setParameter($valueParameter, $value);	4✔
213	break;	4✔
214	case self::STRATEGY_WORD_START:	4✔
215	$queryBuilder
216	->andWhere(sprintf($wrapCase('%1$s.%2$s').' LIKE '.$wrapCase('CONCAT(:%3$s, \'%%\')').' OR '.$wrapCase('%1$s.%2$s').' LIKE '.$wrapCase('CONCAT(\'%% \', :%3$s, \'%%\')'), $alias, $field, $valueParameter))	4✔
217	->setParameter($valueParameter, $value);	4✔
218	break;	4✔
219	default:
220	throw new InvalidArgumentException(sprintf('strategy %s does not exist.', $strategy));	×
221	}
222	}	34✔
223
224	/**
225	* Creates a function that will wrap a Doctrine expression according to the
226	* specified case sensitivity.
227	*
228	* For example, "o.name" will get wrapped into "LOWER(o.name)" when $caseSensitive
229	* is false.
230	*/
231	protected function createWrapCase(bool $caseSensitive): \Closure
232	{
233	return static function (string $expr) use ($caseSensitive): string {
234	if ($caseSensitive) {	38✔
235	return $expr;	26✔
236	}
237
238	return sprintf('LOWER(%s)', $expr);	12✔
239	};	38✔
240	}
241
242	/**
243	* {@inheritdoc}
244	*/
245	protected function getType(string $doctrineType): string
246	{
247	switch ($doctrineType) {
248	case DBALType::TARRAY:	12✔
249	return 'array';	×
250	case DBALType::BIGINT:	12✔
251	case DBALType::INTEGER:	12✔
252	case DBALType::SMALLINT:	12✔
253	return 'int';	12✔
254	case DBALType::BOOLEAN:	12✔
255	return 'bool';	1✔
256	case DBALType::DATE:	12✔
257	case DBALType::TIME:	12✔
258	case DBALType::DATETIME:	12✔
259	case DBALType::DATETIMETZ:	12✔
260	return \DateTimeInterface::class;	2✔
261	case DBALType::FLOAT:	12✔
262	return 'float';	1✔
263	}
264
265	if (\defined(DBALType::class.'::DATE_IMMUTABLE')) {	12✔
266	switch ($doctrineType) {
267	case DBALType::DATE_IMMUTABLE:	12✔
268	case DBALType::TIME_IMMUTABLE:	12✔
269	case DBALType::DATETIME_IMMUTABLE:	12✔
270	case DBALType::DATETIMETZ_IMMUTABLE:	12✔
271	return \DateTimeInterface::class;	×
272	}
273	}
274
275	return 'string';	12✔
276	}
277	}

api-platform / core / #25488

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