#25333

pending completion

Build # #25333

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/0d536b74107a15dd2bd8cfaa2838714f4ee56ba7">0d536b741<a href="https://github.com/api-platform/core/commit/0d536b74107a15dd2bd8cfaa2838714f4ee56ba7">">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/e46d690cbbdc2a6ce0768e4aeba09f02d6674f2d">e46d690cb</a>">e46d690cb</a><a href="https://github.com/api-platform/core/commit/0d536b74107a15dd2bd8cfaa2838714f4ee56ba7"> into d83d50228">d83d50228</a>

Run Details

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

9270 of 10172 relevant lines covered (91.13%)

16.65 hits per line

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

77.27

/src/Bridge/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\Core\Bridge\Doctrine\Orm\Extension;

use ApiPlatform\Core\Api\FilterCollection;
use ApiPlatform\Core\Api\FilterLocatorTrait;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\FilterInterface;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\OrderFilter;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
use ApiPlatform\Core\Exception\InvalidArgumentException;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
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 ContextAwareQueryCollectionExtensionInterface
{
    use FilterLocatorTrait;

    private $resourceMetadataFactory;

    /**
     * @param ContainerInterface|FilterCollection $filterLocator The new filter locator or the deprecated filter collection
     */
    public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, $filterLocator)
    {
        $this->setFilterLocator($filterLocator);

        $this->resourceMetadataFactory = $resourceMetadataFactory;
    }

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

        $resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);
        $resourceFilters = $resourceMetadata->getCollectionOperationAttribute($operationName, 'filters', [], true);

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

        $orderFilters = [];

        foreach ($resourceFilters as $filterId) {
            $filter = $this->getFilter($filterId);
            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'] = $context['filters'] ?? [];
                $filter->apply($queryBuilder, $queryNameGenerator, $resourceClass, $operationName, $context);
            }
        }

        foreach ($orderFilters as $orderFilter) {
            $context['filters'] = $context['filters'] ?? [];
            $orderFilter->apply($queryBuilder, $queryNameGenerator, $resourceClass, $operationName, $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\Core\Bridge\Doctrine\Orm\Extension;
15
16	use ApiPlatform\Core\Api\FilterCollection;
17	use ApiPlatform\Core\Api\FilterLocatorTrait;
18	use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\FilterInterface;
19	use ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\OrderFilter;
20	use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
21	use ApiPlatform\Core\Exception\InvalidArgumentException;
22	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
23	use Doctrine\ORM\QueryBuilder;
24	use Psr\Container\ContainerInterface;
25
26	/**
27	* Applies filters on a resource query.
28	*
29	* @author Kévin Dunglas <dunglas@gmail.com>
30	* @author Samuel ROZE <samuel.roze@gmail.com>
31	*/
32	final class FilterExtension implements ContextAwareQueryCollectionExtensionInterface
33	{
34	use FilterLocatorTrait;
35
36	private $resourceMetadataFactory;
37
38	/**
39	* @param ContainerInterface\|FilterCollection $filterLocator The new filter locator or the deprecated filter collection
40	*/
41	public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, $filterLocator)
42	{
43	$this->setFilterLocator($filterLocator);	4✔
44
45	$this->resourceMetadataFactory = $resourceMetadataFactory;	3✔
46	}	3✔
47
48	/**
49	* {@inheritdoc}
50	*/
51	public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass = null, string $operationName = null, array $context = [])
52	{
53	if (null === $resourceClass) {	3✔
54	throw new InvalidArgumentException('The "$resourceClass" parameter must not be null');	×
55	}
56
57	$resourceMetadata = $this->resourceMetadataFactory->create($resourceClass);	3✔
58	$resourceFilters = $resourceMetadata->getCollectionOperationAttribute($operationName, 'filters', [], true);	3✔
59
60	if (empty($resourceFilters)) {	3✔
61	return;	1✔
62	}
63
64	$orderFilters = [];	2✔
65
66	foreach ($resourceFilters as $filterId) {	2✔
67	$filter = $this->getFilter($filterId);	2✔
68	if ($filter instanceof FilterInterface) {	2✔
69	// Apply the OrderFilter after every other filter to avoid an edge case where OrderFilter would do a LEFT JOIN instead of an INNER JOIN
70	if ($filter instanceof OrderFilter) {	2✔
71	$orderFilters[] = $filter;	×
72	continue;	×
73	}
74
75	$context['filters'] = $context['filters'] ?? [];	2✔
76	$filter->apply($queryBuilder, $queryNameGenerator, $resourceClass, $operationName, $context);	2✔
77	}
78	}
79
80	foreach ($orderFilters as $orderFilter) {	2✔
81	$context['filters'] = $context['filters'] ?? [];	×
82	$orderFilter->apply($queryBuilder, $queryNameGenerator, $resourceClass, $operationName, $context);	×
83	}
84	}	2✔
85	}

api-platform / core / #25333

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