15133993414

Committed 20 May 2025 09:30AM UTC coverage: 26.313% (-1.2%) from 27.493%

Build # 15133993414

Build Type

Pull #7161

github

Committed by

web-flow

Commit Message

Merge e2c03d45f into 5459ba375

Pull Request Pull Request #7161: fix(metadata): infer parameter string type from schema

Run Details

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

11019 existing lines in 363 files now uncovered.

12898 of 49018 relevant lines covered (26.31%)

34.33 hits per line

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

94.44

/src/Doctrine/Orm/Extension/FilterExtension.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\Orm\Extension;

use ApiPlatform\Doctrine\Orm\Filter\FilterInterface;
use ApiPlatform\Doctrine\Orm\Filter\OrderFilter;
use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
use ApiPlatform\Metadata\Exception\InvalidArgumentException;
use ApiPlatform\Metadata\Operation;
use Doctrine\ORM\QueryBuilder;
use Psr\Container\ContainerInterface;

/**
 * Applies filters on a resource query.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 * @author Samuel ROZE <samuel.roze@gmail.com>
 */
final class FilterExtension implements QueryCollectionExtensionInterface
{
    public function __construct(private readonly ContainerInterface $filterLocator)
    {
    }

    /**
     * {@inheritdoc}
     */
    public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, ?string $resourceClass = null, ?Operation $operation = null, array $context = []): void
    {
        if (null === $resourceClass) {
            throw new InvalidArgumentException('The "$resourceClass" parameter must not be null');
        }

        $resourceFilters = $operation?->getFilters();

        if (empty($resourceFilters)) {
            return;
        }

        $orderFilters = [];

        foreach ($resourceFilters as $filterId) {
            $filter = $this->filterLocator->has($filterId) ? $this->filterLocator->get($filterId) : null;
            if ($filter instanceof FilterInterface) {
                // Apply the OrderFilter after every other filter to avoid an edge case where OrderFilter would do a LEFT JOIN instead of an INNER JOIN
                if ($filter instanceof OrderFilter) {
                    $orderFilters[] = $filter;
                    continue;
                }

                $context['filters'] ??= [];
                $filter->apply($queryBuilder, $queryNameGenerator, $resourceClass, $operation, $context);
            }
        }

        foreach ($orderFilters as $orderFilter) {
            $context['filters'] ??= [];
            $orderFilter->apply($queryBuilder, $queryNameGenerator, $resourceClass, $operation, $context);
        }
    }
}

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\Orm\Extension;
15
16	use ApiPlatform\Doctrine\Orm\Filter\FilterInterface;
17	use ApiPlatform\Doctrine\Orm\Filter\OrderFilter;
18	use ApiPlatform\Doctrine\Orm\Util\QueryNameGeneratorInterface;
19	use ApiPlatform\Metadata\Exception\InvalidArgumentException;
20	use ApiPlatform\Metadata\Operation;
21	use Doctrine\ORM\QueryBuilder;
22	use Psr\Container\ContainerInterface;
23
24	/**
25	* Applies filters on a resource query.
26	*
27	* @author Kévin Dunglas <dunglas@gmail.com>
28	* @author Samuel ROZE <samuel.roze@gmail.com>
29	*/
30	final class FilterExtension implements QueryCollectionExtensionInterface
31	{
32	public function __construct(private readonly ContainerInterface $filterLocator)
33	{
UNCOV 34	}	104✔
35
36	/**
37	* {@inheritdoc}
38	*/
39	public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, ?string $resourceClass = null, ?Operation $operation = null, array $context = []): void
40	{
UNCOV 41	if (null === $resourceClass) {	104✔
42	throw new InvalidArgumentException('The "$resourceClass" parameter must not be null');	×
43	}
44
UNCOV 45	$resourceFilters = $operation?->getFilters();	104✔
46
UNCOV 47	if (empty($resourceFilters)) {	104✔
UNCOV 48	return;	100✔
49	}
50
UNCOV 51	$orderFilters = [];	4✔
52
UNCOV 53	foreach ($resourceFilters as $filterId) {	4✔
UNCOV 54	$filter = $this->filterLocator->has($filterId) ? $this->filterLocator->get($filterId) : null;	4✔
UNCOV 55	if ($filter instanceof FilterInterface) {	4✔
56	// Apply the OrderFilter after every other filter to avoid an edge case where OrderFilter would do a LEFT JOIN instead of an INNER JOIN
UNCOV 57	if ($filter instanceof OrderFilter) {	4✔
UNCOV 58	$orderFilters[] = $filter;	2✔
UNCOV 59	continue;	2✔
60	}
61
UNCOV 62	$context['filters'] ??= [];	4✔
UNCOV 63	$filter->apply($queryBuilder, $queryNameGenerator, $resourceClass, $operation, $context);	4✔
64	}
65	}
66
UNCOV 67	foreach ($orderFilters as $orderFilter) {	4✔
UNCOV 68	$context['filters'] ??= [];	2✔
UNCOV 69	$orderFilter->apply($queryBuilder, $queryNameGenerator, $resourceClass, $operation, $context);	2✔
70	}
71	}
72	}

api-platform / core / 15133993414

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