#24786

pending completion

Build # #24786

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/bcbe31845f928e0a3284afe6b6d16d79d9efd312">bcbe31845<a href="https://github.com/api-platform/core/commit/bcbe31845f928e0a3284afe6b6d16d79d9efd312">">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/a9e94fb42b7f3347b8e2cff894f7e611ef5ddae9">a9e94fb42</a>">a9e94fb42</a><a href="https://github.com/api-platform/core/commit/bcbe31845f928e0a3284afe6b6d16d79d9efd312"> into 5a7c2e429">5a7c2e429</a>

Run Details

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

2324 of 12409 relevant lines covered (18.73%)

2.23 hits per line

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

0.0

/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);	×
46
47	if (null === $identifiersExtractor) {	×
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);	×
49	}	×
50
51	$this->iriConverter = $iriConverter;	×
52	$this->identifiersExtractor = $identifiersExtractor;	×
53	$this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();	×
54	}	×
55
56	protected function getIriConverter(): IriConverterInterface
57	{	×
58	return $this->iriConverter;	×
59	}	×
60
61	protected function getPropertyAccessor(): PropertyAccessorInterface
62	{	×
63	return $this->propertyAccessor;	×
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 \|\|	×
73	!$this->isPropertyEnabled($property, $resourceClass) \|\|	×
74	!$this->isPropertyMapped($property, $resourceClass, true)	×
75	) {	×
76	return;	×
77	}	×
78
79	$alias = $queryBuilder->getRootAliases()[0];	×
80	$field = $property;	×
81
82	$associations = [];	×
83	if ($this->isPropertyNested($property, $resourceClass)) {	×
84	[$alias, $field, $associations] = $this->addJoinsForNestedProperty($property, $alias, $queryBuilder, $queryNameGenerator, $resourceClass);	×
85	}	×
86
87	$values = $this->normalizeValues((array) $value, $property);	×
88	if (null === $values) {	×
89	return;	×
90	}	×
91
92	$caseSensitive = true;	×
93	$metadata = $this->getNestedMetadata($resourceClass, $associations);	×
94
95	if ($metadata->hasField($field)) {	×
96	if ('id' === $field) {	×
97	$values = array_map([$this, 'getIdFromValue'], $values);	×
98	}	×
99
100	if (!$this->hasValidValues($values, $this->getDoctrineFieldType($property, $resourceClass))) {	×
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;	×
109
110	// prefixing the strategy with i makes it case insensitive
111	if (0 === strpos($strategy, 'i')) {	×
112	$strategy = substr($strategy, 1);	×
113	$caseSensitive = false;	×
114	}	×
115
116	if (1 === \count($values)) {	×
117	$this->addWhereByStrategy($strategy, $queryBuilder, $queryNameGenerator, $alias, $field, $values[0], $caseSensitive);	×
118
119	return;	×
120	}	×
121
122	if (self::STRATEGY_EXACT !== $strategy) {	×
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);	×
131	$valueParameter = $queryNameGenerator->generateParameterName($field);	×
132
133	$queryBuilder	×
134	->andWhere(sprintf($wrapCase('%s.%s').' IN (:%s)', $alias, $field, $valueParameter))	×
135	->setParameter($valueParameter, $caseSensitive ? $values : array_map('strtolower', $values));	×
136	}	×
137
138	// metadata doesn't have the field, nor an association on the field
139	if (!$metadata->hasAssociation($field)) {	×
140	return;	×
141	}	×
142
143	$values = array_map([$this, 'getIdFromValue'], $values);	×
144	$associationFieldIdentifier = 'id';	×
145	$doctrineTypeField = $this->getDoctrineFieldType($property, $resourceClass);	×
146
147	if (null !== $this->identifiersExtractor) {	×
148	$associationResourceClass = $metadata->getAssociationTargetClass($field);	×
149	$associationFieldIdentifier = $this->identifiersExtractor->getIdentifiersFromResourceClass($associationResourceClass)[0];	×
150	$doctrineTypeField = $this->getDoctrineFieldType($associationFieldIdentifier, $associationResourceClass);	×
151	}	×
152
153	if (!$this->hasValidValues($values, $doctrineTypeField)) {	×
154	$this->logger->notice('Invalid filter ignored', [	×
155	'exception' => new InvalidArgumentException(sprintf('Values for field "%s" are not valid according to the doctrine type.', $field)),	×
156	]);	×
157
158	return;	×
159	}	×
160
161	$association = $field;	×
162	$valueParameter = $queryNameGenerator->generateParameterName($association);	×
163	if ($metadata->isCollectionValuedAssociation($association)) {	×
164	$associationAlias = QueryBuilderHelper::addJoinOnce($queryBuilder, $queryNameGenerator, $alias, $association);	×
165	$associationField = $associationFieldIdentifier;	×
166	} else {	×
167	$associationAlias = $alias;	×
168	$associationField = $field;	×
169	}	×
170
171	if (1 === \count($values)) {	×
172	$queryBuilder	×
173	->andWhere(sprintf('%s.%s = :%s', $associationAlias, $associationField, $valueParameter))	×
174	->setParameter($valueParameter, $values[0]);	×
175	} else {	×
176	$queryBuilder	×
177	->andWhere(sprintf('%s.%s IN (:%s)', $associationAlias, $associationField, $valueParameter))	×
178	->setParameter($valueParameter, $values);	×
179	}	×
180	}	×
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);	×
190	$valueParameter = $queryNameGenerator->generateParameterName($field);	×
191
192	switch ($strategy) {	×
193	case null:	×
194	case self::STRATEGY_EXACT:	×
195	$queryBuilder	×
196	->andWhere(sprintf($wrapCase('%s.%s').' = '.$wrapCase(':%s'), $alias, $field, $valueParameter))	×
197	->setParameter($valueParameter, $value);	×
198	break;	×
199	case self::STRATEGY_PARTIAL:	×
200	$queryBuilder	×
201	->andWhere(sprintf($wrapCase('%s.%s').' LIKE '.$wrapCase('CONCAT(\'%%\', :%s, \'%%\')'), $alias, $field, $valueParameter))	×
202	->setParameter($valueParameter, $value);	×
203	break;	×
204	case self::STRATEGY_START:	×
205	$queryBuilder	×
206	->andWhere(sprintf($wrapCase('%s.%s').' LIKE '.$wrapCase('CONCAT(:%s, \'%%\')'), $alias, $field, $valueParameter))	×
207	->setParameter($valueParameter, $value);	×
208	break;	×
209	case self::STRATEGY_END:	×
210	$queryBuilder	×
211	->andWhere(sprintf($wrapCase('%s.%s').' LIKE '.$wrapCase('CONCAT(\'%%\', :%s)'), $alias, $field, $valueParameter))	×
212	->setParameter($valueParameter, $value);	×
213	break;	×
214	case self::STRATEGY_WORD_START:	×
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))	×
217	->setParameter($valueParameter, $value);	×
218	break;	×
219	default:	×
220	throw new InvalidArgumentException(sprintf('strategy %s does not exist.', $strategy));	×
221	}	×
222	}	×
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) {	×
235	return $expr;	×
236	}	×
237
238	return sprintf('LOWER(%s)', $expr);	×
239	};	×
240	}	×
241
242	/**
243	* {@inheritdoc}
244	*/
245	protected function getType(string $doctrineType): string
246	{	×
247	switch ($doctrineType) {	×
248	case DBALType::TARRAY:	×
249	return 'array';	×
250	case DBALType::BIGINT:	×
251	case DBALType::INTEGER:	×
252	case DBALType::SMALLINT:	×
253	return 'int';	×
254	case DBALType::BOOLEAN:	×
255	return 'bool';	×
256	case DBALType::DATE:	×
257	case DBALType::TIME:	×
258	case DBALType::DATETIME:	×
259	case DBALType::DATETIMETZ:	×
260	return \DateTimeInterface::class;	×
261	case DBALType::FLOAT:	×
262	return 'float';	×
263	}	×
264
265	if (\defined(DBALType::class.'::DATE_IMMUTABLE')) {	×
266	switch ($doctrineType) {	×
267	case DBALType::DATE_IMMUTABLE:	×
268	case DBALType::TIME_IMMUTABLE:	×
269	case DBALType::DATETIME_IMMUTABLE:	×
270	case DBALType::DATETIMETZ_IMMUTABLE:	×
271	return \DateTimeInterface::class;	×
272	}	×
273	}	×
274
275	return 'string';	×
276	}	×
277	}

api-platform / core / #24786

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