#27263

pending completion

Build # #27263

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/207c9f1071b6da7745183fe0fcab264bfd1145f2">207c9f107<a href="https://github.com/api-platform/core/commit/207c9f1071b6da7745183fe0fcab264bfd1145f2">">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/14e3a2de0df4e1ef08e04b21318bae4ac19ab902">14e3a2de0</a>">14e3a2de0</a><a href="https://github.com/api-platform/core/commit/207c9f1071b6da7745183fe0fcab264bfd1145f2"> into 45fda88cc">45fda88cc</a>

Run Details

9716 of 11644 relevant lines covered (83.44%)

14.65 hits per line

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

96.55

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

use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\DateFilterInterface;
use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\DateFilterTrait;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
use ApiPlatform\Core\Exception\InvalidArgumentException;
use Doctrine\DBAL\Types\Type as DBALType;
use Doctrine\ORM\QueryBuilder;

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

    public const DOCTRINE_DATE_TYPES = [
        DBALType::DATE => true,
        DBALType::DATETIME => true,
        DBALType::DATETIMETZ => true,
        DBALType::TIME => true,
        DBALType::DATE_IMMUTABLE => true,
        DBALType::DATETIME_IMMUTABLE => true,
        DBALType::DATETIMETZ_IMMUTABLE => true,
        DBALType::TIME_IMMUTABLE => true,
    ];

    /**
     * {@inheritdoc}
     */
    protected function filterProperty(string $property, $values, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
    {
        // 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;
        }

        $alias = $queryBuilder->getRootAliases()[0];
        $field = $property;

        if ($this->isPropertyNested($property, $resourceClass)) {
            [$alias, $field] = $this->addJoinsForNestedProperty($property, $alias, $queryBuilder, $queryNameGenerator, $resourceClass);
        }

        $nullManagement = $this->properties[$property] ?? null;
        $type = (string) $this->getDoctrineFieldType($property, $resourceClass);

        if (self::EXCLUDE_NULL === $nullManagement) {
            $queryBuilder->andWhere($queryBuilder->expr()->isNotNull(sprintf('%s.%s', $alias, $field)));
        }

        if (isset($values[self::PARAMETER_BEFORE])) {
            $this->addWhere(
                $queryBuilder,
                $queryNameGenerator,
                $alias,
                $field,
                self::PARAMETER_BEFORE,
                $values[self::PARAMETER_BEFORE],
                $nullManagement,
                $type
            );
        }

        if (isset($values[self::PARAMETER_STRICTLY_BEFORE])) {
            $this->addWhere(
                $queryBuilder,
                $queryNameGenerator,
                $alias,
                $field,
                self::PARAMETER_STRICTLY_BEFORE,
                $values[self::PARAMETER_STRICTLY_BEFORE],
                $nullManagement,
                $type
            );
        }

        if (isset($values[self::PARAMETER_AFTER])) {
            $this->addWhere(
                $queryBuilder,
                $queryNameGenerator,
                $alias,
                $field,
                self::PARAMETER_AFTER,
                $values[self::PARAMETER_AFTER],
                $nullManagement,
                $type
            );
        }

        if (isset($values[self::PARAMETER_STRICTLY_AFTER])) {
            $this->addWhere(
                $queryBuilder,
                $queryNameGenerator,
                $alias,
                $field,
                self::PARAMETER_STRICTLY_AFTER,
                $values[self::PARAMETER_STRICTLY_AFTER],
                $nullManagement,
                $type
            );
        }
    }

    /**
     * Adds the where clause according to the chosen null management.
     *
     * @param string|DBALType $type
     */
    protected function addWhere(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $alias, string $field, string $operator, string $value, string $nullManagement = null, $type = null)
    {
        $type = (string) $type;
        try {
            $value = false === strpos($type, '_immutable') ? new \DateTime($value) : new \DateTimeImmutable($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;
        }

        $valueParameter = $queryNameGenerator->generateParameterName($field);
        $operatorValue = [
            self::PARAMETER_BEFORE => '<=',
            self::PARAMETER_STRICTLY_BEFORE => '<',
            self::PARAMETER_AFTER => '>=',
            self::PARAMETER_STRICTLY_AFTER => '>',
        ];
        $baseWhere = sprintf('%s.%s %s :%s', $alias, $field, $operatorValue[$operator], $valueParameter);

        if (null === $nullManagement || self::EXCLUDE_NULL === $nullManagement) {
            $queryBuilder->andWhere($baseWhere);
        } elseif (
            (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))
        ) {
            $queryBuilder->andWhere($queryBuilder->expr()->orX(
                $baseWhere,
                $queryBuilder->expr()->isNull(sprintf('%s.%s', $alias, $field))
            ));
        } else {
            $queryBuilder->andWhere($queryBuilder->expr()->andX(
                $baseWhere,
                $queryBuilder->expr()->isNotNull(sprintf('%s.%s', $alias, $field))
            ));
        }

        $queryBuilder->setParameter($valueParameter, $value, $type);
    }
}

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\Bridge\Doctrine\Common\Filter\DateFilterInterface;
17	use ApiPlatform\Core\Bridge\Doctrine\Common\Filter\DateFilterTrait;
18	use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
19	use ApiPlatform\Core\Exception\InvalidArgumentException;
20	use Doctrine\DBAL\Types\Type as DBALType;
21	use Doctrine\ORM\QueryBuilder;
22
23	/**
24	* Filters the collection by date intervals.
25	*
26	* @author Kévin Dunglas <dunglas@gmail.com>
27	* @author Théo FIDRY <theo.fidry@gmail.com>
28	*/
29	class DateFilter extends AbstractContextAwareFilter implements DateFilterInterface
30	{
31	use DateFilterTrait;
32
33	public const DOCTRINE_DATE_TYPES = [
34	DBALType::DATE => true,
35	DBALType::DATETIME => true,
36	DBALType::DATETIMETZ => true,
37	DBALType::TIME => true,
38	DBALType::DATE_IMMUTABLE => true,
39	DBALType::DATETIME_IMMUTABLE => true,
40	DBALType::DATETIMETZ_IMMUTABLE => true,
41	DBALType::TIME_IMMUTABLE => true,
42	];
43
44	/**
45	* {@inheritdoc}
46	*/
47	protected function filterProperty(string $property, $values, QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null)
48	{
49	// Expect $values to be an array having the period as keys and the date value as values
50	if (
51	!\is_array($values) \|\|	40✔
52	!$this->isPropertyEnabled($property, $resourceClass) \|\|	40✔
53	!$this->isPropertyMapped($property, $resourceClass) \|\|	40✔
54	!$this->isDateField($property, $resourceClass)	40✔
55	) {
56	return;	2✔
57	}
58
59	$alias = $queryBuilder->getRootAliases()[0];	38✔
60	$field = $property;	38✔
61
62	if ($this->isPropertyNested($property, $resourceClass)) {	38✔
63	[$alias, $field] = $this->addJoinsForNestedProperty($property, $alias, $queryBuilder, $queryNameGenerator, $resourceClass);	2✔
64	}
65
66	$nullManagement = $this->properties[$property] ?? null;	38✔
67	$type = (string) $this->getDoctrineFieldType($property, $resourceClass);	38✔
68
69	if (self::EXCLUDE_NULL === $nullManagement) {	38✔
70	$queryBuilder->andWhere($queryBuilder->expr()->isNotNull(sprintf('%s.%s', $alias, $field)));	2✔
71	}
72
73	if (isset($values[self::PARAMETER_BEFORE])) {	38✔
74	$this->addWhere(	8✔
75	$queryBuilder,	8✔
76	$queryNameGenerator,
77	$alias,
78	$field,
79	self::PARAMETER_BEFORE,	8✔
80	$values[self::PARAMETER_BEFORE],	8✔
81	$nullManagement,
82	$type
83	);
84	}
85
86	if (isset($values[self::PARAMETER_STRICTLY_BEFORE])) {	38✔
87	$this->addWhere(	8✔
88	$queryBuilder,	8✔
89	$queryNameGenerator,
90	$alias,
91	$field,
92	self::PARAMETER_STRICTLY_BEFORE,	8✔
93	$values[self::PARAMETER_STRICTLY_BEFORE],	8✔
94	$nullManagement,
95	$type
96	);
97	}
98
99	if (isset($values[self::PARAMETER_AFTER])) {	38✔
100	$this->addWhere(	22✔
101	$queryBuilder,	22✔
102	$queryNameGenerator,
103	$alias,
104	$field,
105	self::PARAMETER_AFTER,	22✔
106	$values[self::PARAMETER_AFTER],	22✔
107	$nullManagement,
108	$type
109	);
110	}
111
112	if (isset($values[self::PARAMETER_STRICTLY_AFTER])) {	38✔
113	$this->addWhere(	8✔
114	$queryBuilder,	8✔
115	$queryNameGenerator,
116	$alias,
117	$field,
118	self::PARAMETER_STRICTLY_AFTER,	8✔
119	$values[self::PARAMETER_STRICTLY_AFTER],	8✔
120	$nullManagement,
121	$type
122	);
123	}
124	}	38✔
125
126	/**
127	* Adds the where clause according to the chosen null management.
128	*
129	* @param string\|DBALType $type
130	*/
131	protected function addWhere(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $alias, string $field, string $operator, string $value, string $nullManagement = null, $type = null)
132	{
133	$type = (string) $type;	38✔
134	try {
135	$value = false === strpos($type, '_immutable') ? new \DateTime($value) : new \DateTimeImmutable($value);	38✔
136	} catch (\Exception $e) {	2✔
137	// Silently ignore this filter if it can not be transformed to a \DateTime
138	$this->logger->notice('Invalid filter ignored', [	2✔
139	'exception' => new InvalidArgumentException(sprintf('The field "%s" has a wrong date format. Use one accepted by the \DateTime constructor', $field)),	2✔
140	]);
141
142	return;	2✔
143	}
144
145	$valueParameter = $queryNameGenerator->generateParameterName($field);	36✔
146	$operatorValue = [	36✔
147	self::PARAMETER_BEFORE => '<=',	36✔
148	self::PARAMETER_STRICTLY_BEFORE => '<',	36✔
149	self::PARAMETER_AFTER => '>=',	36✔
150	self::PARAMETER_STRICTLY_AFTER => '>',	36✔
151	];
152	$baseWhere = sprintf('%s.%s %s :%s', $alias, $field, $operatorValue[$operator], $valueParameter);	36✔
153
154	if (null === $nullManagement \|\| self::EXCLUDE_NULL === $nullManagement) {	36✔
155	$queryBuilder->andWhere($baseWhere);	32✔
156	} elseif (
157	(self::INCLUDE_NULL_BEFORE === $nullManagement && \in_array($operator, [self::PARAMETER_BEFORE, self::PARAMETER_STRICTLY_BEFORE], true)) \|\|	4✔
158	(self::INCLUDE_NULL_AFTER === $nullManagement && \in_array($operator, [self::PARAMETER_AFTER, self::PARAMETER_STRICTLY_AFTER], true)) \|\|	4✔
159	(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))	4✔
160	) {
161	$queryBuilder->andWhere($queryBuilder->expr()->orX(	4✔
162	$baseWhere,
163	$queryBuilder->expr()->isNull(sprintf('%s.%s', $alias, $field))	4✔
164	));
165	} else {
166	$queryBuilder->andWhere($queryBuilder->expr()->andX(	×
167	$baseWhere,
168	$queryBuilder->expr()->isNotNull(sprintf('%s.%s', $alias, $field))	×
169	));
170	}
171
172	$queryBuilder->setParameter($valueParameter, $value, $type);	36✔
173	}	36✔
174	}

api-platform / core / #27263

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