#25317

pending completion

Build # #25317

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/207d1b0ea5ab850154550a6f57ded516543ec3ec">207d1b0ea<a href="https://github.com/api-platform/core/commit/207d1b0ea5ab850154550a6f57ded516543ec3ec">">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/10c6430b423d64a523584be5afeab0efa36dede1">10c6430b4</a>">10c6430b4</a><a href="https://github.com/api-platform/core/commit/207d1b0ea5ab850154550a6f57ded516543ec3ec"> into 563e01756">563e01756</a>

Run Details

8131 of 9627 relevant lines covered (84.46%)

14.84 hits per line

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

0.0

/src/Bridge/Doctrine/MongoDbOdm/Filter/DateFilter.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\DateFilterInterface;
use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\DateFilterTrait;
use ApiPlatform\Core\Exception\InvalidArgumentException;
use Doctrine\ODM\MongoDB\Aggregation\Builder;
use Doctrine\ODM\MongoDB\Types\Type as MongoDbType;

/**
 * Filters the collection by date intervals.
 *
 * @experimental
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 * @author Théo FIDRY <theo.fidry@gmail.com>
 * @author Alan Poulain <contact@alanpoulain.eu>
 */
class DateFilter extends AbstractFilter implements DateFilterInterface
{
    use DateFilterTrait;

    public const DOCTRINE_DATE_TYPES = [
        MongoDbType::DATE => true,
    ];

    /**
     * {@inheritdoc}
     */
    protected function filterProperty(string $property, $values, Builder $aggregationBuilder, string $resourceClass, string $operationName = null, array &$context = [])
    {
        // Expect $values to be an array having the period as keys and the date value as values
        if (
            !\is_array($values) ||
            !$this->isPropertyEnabled($property, $resourceClass) ||
            !$this->isPropertyMapped($property, $resourceClass) ||
            !$this->isDateField($property, $resourceClass)
        ) {
            return;
        }

        $matchField = $property;

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

        $nullManagement = $this->properties[$property] ?? null;

        if (self::EXCLUDE_NULL === $nullManagement) {
            $aggregationBuilder->match()->field($matchField)->notEqual(null);
        }

        if (isset($values[self::PARAMETER_BEFORE])) {
            $this->addMatch(
                $aggregationBuilder,
                $matchField,
                self::PARAMETER_BEFORE,
                $values[self::PARAMETER_BEFORE],
                $nullManagement
            );
        }

        if (isset($values[self::PARAMETER_STRICTLY_BEFORE])) {
            $this->addMatch(
                $aggregationBuilder,
                $matchField,
                self::PARAMETER_STRICTLY_BEFORE,
                $values[self::PARAMETER_STRICTLY_BEFORE],
                $nullManagement
            );
        }

        if (isset($values[self::PARAMETER_AFTER])) {
            $this->addMatch(
                $aggregationBuilder,
                $matchField,
                self::PARAMETER_AFTER,
                $values[self::PARAMETER_AFTER],
                $nullManagement
            );
        }

        if (isset($values[self::PARAMETER_STRICTLY_AFTER])) {
            $this->addMatch(
                $aggregationBuilder,
                $matchField,
                self::PARAMETER_STRICTLY_AFTER,
                $values[self::PARAMETER_STRICTLY_AFTER],
                $nullManagement
            );
        }
    }

    /**
     * Adds the match stage according to the chosen null management.
     */
    private function addMatch(Builder $aggregationBuilder, string $field, string $operator, string $value, string $nullManagement = null): void
    {
        try {
            $value = new \DateTime($value);
        } catch (\Exception $e) {
            // Silently ignore this filter if it can not be transformed to a \DateTime
            $this->logger->notice('Invalid filter ignored', [
                'exception' => new InvalidArgumentException(sprintf('The field "%s" has a wrong date format. Use one accepted by the \DateTime constructor', $field)),
            ]);

            return;
        }

        $operatorValue = [
            self::PARAMETER_BEFORE => '$lte',
            self::PARAMETER_STRICTLY_BEFORE => '$lt',
            self::PARAMETER_AFTER => '$gte',
            self::PARAMETER_STRICTLY_AFTER => '$gt',
        ];

        if ((self::INCLUDE_NULL_BEFORE === $nullManagement && \in_array($operator, [self::PARAMETER_BEFORE, self::PARAMETER_STRICTLY_BEFORE], true)) ||
            (self::INCLUDE_NULL_AFTER === $nullManagement && \in_array($operator, [self::PARAMETER_AFTER, self::PARAMETER_STRICTLY_AFTER], true)) ||
            (self::INCLUDE_NULL_BEFORE_AND_AFTER === $nullManagement && \in_array($operator, [self::PARAMETER_AFTER, self::PARAMETER_STRICTLY_AFTER, self::PARAMETER_BEFORE, self::PARAMETER_STRICTLY_BEFORE], true))
        ) {
            $aggregationBuilder->match()->addOr(
                $aggregationBuilder->matchExpr()->field($field)->operator($operatorValue[$operator], $value),
                $aggregationBuilder->matchExpr()->field($field)->equals(null)
            );

            return;
        }

        $aggregationBuilder->match()->addAnd($aggregationBuilder->matchExpr()->field($field)->operator($operatorValue[$operator], $value));
    }
}

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\DateFilterInterface;
17	use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\DateFilterTrait;
18	use ApiPlatform\Core\Exception\InvalidArgumentException;
19	use Doctrine\ODM\MongoDB\Aggregation\Builder;
20	use Doctrine\ODM\MongoDB\Types\Type as MongoDbType;
21
22	/**
23	* Filters the collection by date intervals.
24	*
25	* @experimental
26	*
27	* @author Kévin Dunglas <dunglas@gmail.com>
28	* @author Théo FIDRY <theo.fidry@gmail.com>
29	* @author Alan Poulain <contact@alanpoulain.eu>
30	*/
31	class DateFilter extends AbstractFilter implements DateFilterInterface
32	{
33	use DateFilterTrait;
34
35	public const DOCTRINE_DATE_TYPES = [
36	MongoDbType::DATE => true,
37	];
38
39	/**
40	* {@inheritdoc}
41	*/
42	protected function filterProperty(string $property, $values, Builder $aggregationBuilder, string $resourceClass, string $operationName = null, array &$context = [])
43	{
44	// Expect $values to be an array having the period as keys and the date value as values
45	if (
46	!\is_array($values) \|\|	×
47	!$this->isPropertyEnabled($property, $resourceClass) \|\|	×
48	!$this->isPropertyMapped($property, $resourceClass) \|\|	×
49	!$this->isDateField($property, $resourceClass)	×
50	) {
51	return;	×
52	}
53
54	$matchField = $property;	×
55
56	if ($this->isPropertyNested($property, $resourceClass)) {	×
57	[$matchField] = $this->addLookupsForNestedProperty($property, $aggregationBuilder, $resourceClass);	×
58	}
59
60	$nullManagement = $this->properties[$property] ?? null;	×
61
62	if (self::EXCLUDE_NULL === $nullManagement) {	×
63	$aggregationBuilder->match()->field($matchField)->notEqual(null);	×
64	}
65
66	if (isset($values[self::PARAMETER_BEFORE])) {	×
67	$this->addMatch(	×
68	$aggregationBuilder,	×
69	$matchField,
70	self::PARAMETER_BEFORE,	×
71	$values[self::PARAMETER_BEFORE],	×
72	$nullManagement
73	);
74	}
75
76	if (isset($values[self::PARAMETER_STRICTLY_BEFORE])) {	×
77	$this->addMatch(	×
78	$aggregationBuilder,	×
79	$matchField,
80	self::PARAMETER_STRICTLY_BEFORE,	×
81	$values[self::PARAMETER_STRICTLY_BEFORE],	×
82	$nullManagement
83	);
84	}
85
86	if (isset($values[self::PARAMETER_AFTER])) {	×
87	$this->addMatch(	×
88	$aggregationBuilder,	×
89	$matchField,
90	self::PARAMETER_AFTER,	×
91	$values[self::PARAMETER_AFTER],	×
92	$nullManagement
93	);
94	}
95
96	if (isset($values[self::PARAMETER_STRICTLY_AFTER])) {	×
97	$this->addMatch(	×
98	$aggregationBuilder,	×
99	$matchField,
100	self::PARAMETER_STRICTLY_AFTER,	×
101	$values[self::PARAMETER_STRICTLY_AFTER],	×
102	$nullManagement
103	);
104	}
105	}	×
106
107	/**
108	* Adds the match stage according to the chosen null management.
109	*/
110	private function addMatch(Builder $aggregationBuilder, string $field, string $operator, string $value, string $nullManagement = null): void
111	{
112	try {
113	$value = new \DateTime($value);	×
114	} catch (\Exception $e) {	×
115	// Silently ignore this filter if it can not be transformed to a \DateTime
116	$this->logger->notice('Invalid filter ignored', [	×
117	'exception' => new InvalidArgumentException(sprintf('The field "%s" has a wrong date format. Use one accepted by the \DateTime constructor', $field)),	×
118	]);
119
120	return;	×
121	}
122
123	$operatorValue = [
124	self::PARAMETER_BEFORE => '$lte',	×
125	self::PARAMETER_STRICTLY_BEFORE => '$lt',	×
126	self::PARAMETER_AFTER => '$gte',	×
127	self::PARAMETER_STRICTLY_AFTER => '$gt',	×
128	];
129
130	if ((self::INCLUDE_NULL_BEFORE === $nullManagement && \in_array($operator, [self::PARAMETER_BEFORE, self::PARAMETER_STRICTLY_BEFORE], true)) \|\|	×
131	(self::INCLUDE_NULL_AFTER === $nullManagement && \in_array($operator, [self::PARAMETER_AFTER, self::PARAMETER_STRICTLY_AFTER], true)) \|\|	×
132	(self::INCLUDE_NULL_BEFORE_AND_AFTER === $nullManagement && \in_array($operator, [self::PARAMETER_AFTER, self::PARAMETER_STRICTLY_AFTER, self::PARAMETER_BEFORE, self::PARAMETER_STRICTLY_BEFORE], true))	×
133	) {
134	$aggregationBuilder->match()->addOr(	×
135	$aggregationBuilder->matchExpr()->field($field)->operator($operatorValue[$operator], $value),	×
136	$aggregationBuilder->matchExpr()->field($field)->equals(null)	×
137	);
138
139	return;	×
140	}
141
142	$aggregationBuilder->match()->addAnd($aggregationBuilder->matchExpr()->field($field)->operator($operatorValue[$operator], $value));	×
143	}	×
144	}

api-platform / core / #25317

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