#27616

pending completion

Build # #27616

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/9662977cae645bf7724c486dc98771c9cd76b1e2">9662977ca<a href="https://github.com/api-platform/core/commit/9662977cae645bf7724c486dc98771c9cd76b1e2">">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/c90e90ba1ae169c441f8f59e8033f3df036cfc77">c90e90ba1</a>">c90e90ba1</a><a href="https://github.com/api-platform/core/commit/9662977cae645bf7724c486dc98771c9cd76b1e2"> into 0204b7adb">0204b7adb</a>

Run Details

16 of 16 new or added lines in 2 files covered. (100.0%)

7555 of 12209 relevant lines covered (61.88%)

84.1 hits per line

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

84.48

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

api-platform / core / #27616

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