#26817

pending completion

Build # #26817

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/13ee4990e8039cd2f50aca4d14bdfac226abdee7">13ee4990e<a href="https://github.com/api-platform/core/commit/13ee4990e8039cd2f50aca4d14bdfac226abdee7">">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/5ff91050e486775f2e23b9d8a234d29c4cf1081e">5ff91050e</a>">5ff91050e</a><a href="https://github.com/api-platform/core/commit/13ee4990e8039cd2f50aca4d14bdfac226abdee7"> into 4717bd564">4717bd564</a>

Run Details

90 of 90 new or added lines in 15 files covered. (100.0%)

9652 of 11641 relevant lines covered (82.91%)

14.3 hits per line

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

0.0

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

use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\OrderFilterInterface;
use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\OrderFilterTrait;
use Doctrine\ODM\MongoDB\Aggregation\Builder;
use Doctrine\Persistence\ManagerRegistry;
use Psr\Log\LoggerInterface;
use Symfony\Component\Serializer\NameConverter\NameConverterInterface;

/**
 * Order the collection by given properties.
 *
 * The ordering is done in the same sequence as they are specified in the query,
 * and for each property a direction value can be specified.
 *
 * For each property passed, if the resource does not have such property or if the
 * direction value is different from "asc" or "desc" (case insensitive), the property
 * is ignored.
 *
 * @experimental
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 * @author Théo FIDRY <theo.fidry@gmail.com>
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
final class OrderFilter extends AbstractFilter implements OrderFilterInterface
{
    use OrderFilterTrait;

    public function __construct(ManagerRegistry $managerRegistry, string $orderParameterName = 'order', LoggerInterface $logger = null, array $properties = null, NameConverterInterface $nameConverter = null)
    {
        if (null !== $properties) {
            $properties = array_map(static function ($propertyOptions) {
                // shorthand for default direction
                if (\is_string($propertyOptions)) {
                    $propertyOptions = [
                        'default_direction' => $propertyOptions,
                    ];
                }

                return $propertyOptions;
            }, $properties);
        }

        parent::__construct($managerRegistry, $logger, $properties, $nameConverter);

        $this->orderParameterName = $orderParameterName;
    }

    /**
     * {@inheritdoc}
     */
    public function apply(Builder $aggregationBuilder, string $resourceClass, string $operationName = null, array &$context = [])
    {
        if (isset($context['filters']) && !isset($context['filters'][$this->orderParameterName])) {
            return;
        }

        if (!isset($context['filters'][$this->orderParameterName]) || !\is_array($context['filters'][$this->orderParameterName])) {
            parent::apply($aggregationBuilder, $resourceClass, $operationName, $context);

            return;
        }

        foreach ($context['filters'][$this->orderParameterName] as $property => $value) {
            $this->filterProperty($this->denormalizePropertyName($property, $resourceClass, $context), $value, $aggregationBuilder, $resourceClass, $operationName, $context);
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function filterProperty(string $property, $direction, Builder $aggregationBuilder, string $resourceClass, string $operationName = null, array &$context = [])
    {
        if (!$this->isPropertyEnabled($property, $resourceClass) || !$this->isPropertyMapped($property, $resourceClass)) {
            return;
        }

        $direction = $this->normalizeValue($direction, $property);
        if (null === $direction) {
            return;
        }

        $matchField = $property;

        if ($this->isPropertyNested($property, $resourceClass)) {
            [$matchField] = $this->addLookupsForNestedProperty($property, $aggregationBuilder, $resourceClass);
        }

        $aggregationBuilder->sort(
            $context['mongodb_odm_sort_fields'] = ($context['mongodb_odm_sort_fields'] ?? []) + [$matchField => $direction]
        );
    }
}

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\MongoDbOdm\Filter;
15
16	use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\OrderFilterInterface;
17	use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\OrderFilterTrait;
18	use Doctrine\ODM\MongoDB\Aggregation\Builder;
19	use Doctrine\Persistence\ManagerRegistry;
20	use Psr\Log\LoggerInterface;
21	use Symfony\Component\Serializer\NameConverter\NameConverterInterface;
22
23	/**
24	* Order the collection by given properties.
25	*
26	* The ordering is done in the same sequence as they are specified in the query,
27	* and for each property a direction value can be specified.
28	*
29	* For each property passed, if the resource does not have such property or if the
30	* direction value is different from "asc" or "desc" (case insensitive), the property
31	* is ignored.
32	*
33	* @experimental
34	*
35	* @author Kévin Dunglas <dunglas@gmail.com>
36	* @author Théo FIDRY <theo.fidry@gmail.com>
37	* @author Alan Poulain <contact@alanpoulain.eu>
38	*/
39	final class OrderFilter extends AbstractFilter implements OrderFilterInterface
40	{
41	use OrderFilterTrait;
42
43	public function __construct(ManagerRegistry $managerRegistry, string $orderParameterName = 'order', LoggerInterface $logger = null, array $properties = null, NameConverterInterface $nameConverter = null)
44	{
45	if (null !== $properties) {	×
46	$properties = array_map(static function ($propertyOptions) {
47	// shorthand for default direction
48	if (\is_string($propertyOptions)) {	×
49	$propertyOptions = [
50	'default_direction' => $propertyOptions,	×
51	];
52	}
53
54	return $propertyOptions;	×
55	}, $properties);	×
56	}
57
58	parent::__construct($managerRegistry, $logger, $properties, $nameConverter);	×
59
60	$this->orderParameterName = $orderParameterName;	×
61	}	×
62
63	/**
64	* {@inheritdoc}
65	*/
66	public function apply(Builder $aggregationBuilder, string $resourceClass, string $operationName = null, array &$context = [])
67	{
68	if (isset($context['filters']) && !isset($context['filters'][$this->orderParameterName])) {	×
69	return;	×
70	}
71
72	if (!isset($context['filters'][$this->orderParameterName]) \|\| !\is_array($context['filters'][$this->orderParameterName])) {	×
73	parent::apply($aggregationBuilder, $resourceClass, $operationName, $context);	×
74
75	return;	×
76	}
77
78	foreach ($context['filters'][$this->orderParameterName] as $property => $value) {	×
79	$this->filterProperty($this->denormalizePropertyName($property, $resourceClass, $context), $value, $aggregationBuilder, $resourceClass, $operationName, $context);	×
80	}
81	}	×
82
83	/**
84	* {@inheritdoc}
85	*/
86	protected function filterProperty(string $property, $direction, Builder $aggregationBuilder, string $resourceClass, string $operationName = null, array &$context = [])
87	{
88	if (!$this->isPropertyEnabled($property, $resourceClass) \|\| !$this->isPropertyMapped($property, $resourceClass)) {	×
89	return;	×
90	}
91
92	$direction = $this->normalizeValue($direction, $property);	×
93	if (null === $direction) {	×
94	return;	×
95	}
96
97	$matchField = $property;	×
98
99	if ($this->isPropertyNested($property, $resourceClass)) {	×
100	[$matchField] = $this->addLookupsForNestedProperty($property, $aggregationBuilder, $resourceClass);	×
101	}
102
103	$aggregationBuilder->sort(	×
104	$context['mongodb_odm_sort_fields'] = ($context['mongodb_odm_sort_fields'] ?? []) + [$matchField => $direction]	×
105	);
106	}	×
107	}

api-platform / core / #26817

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