Fix DateFilter for datetime_immutable

Author: antograssiot

features/bootstrap/FeatureContext.php

@@ -23,6 +23,7 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyDate;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyFriend;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyGroup;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyImmutableDate;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyOffer;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyProduct;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyProperty;
@@ -773,4 +774,20 @@ public function thereIsDummyDateObjectsWithDummyDate(int $nb)
 
         $this->manager->flush();
     }
+
+    /**
+     * @Given there are :nb dummyimmutabledate objects with dummyDate
+     */
+    public function thereIsDummyImmutableDateObjectsWithDummyDate(int $nb)
+    {
+        for ($i = 1; $i <= $nb; ++$i) {
+            $date = new \DateTimeImmutable(sprintf('2015-04-%d', $i), new \DateTimeZone('UTC'));
+            $dummy = new DummyImmutableDate();
+            $dummy->dummyDate = $date;
+
+            $this->manager->persist($dummy);
+        }
+
+        $this->manager->flush();
+    }
 }

features/doctrine/date_filter.feature

@@ -660,7 +660,16 @@ Feature: Date filter on collections
     Given there are 30 dummydate objects with dummyDate
     When I send a "GET" request to "/dummy_dates?dummyDate[after]=2015-04-28"
     Then the response status code should be 200
-    And the response should be in JSON
+    And the JSON node "hydra:totalItems" should be equal to 3
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+
+  @dropSchema
+  @createSchema
+  Scenario: Get collection filtered by date that is an immutable date variant
+    Given there are 30 dummyimmutabledate objects with dummyDate
+    When I send a "GET" request to "/dummy_immutable_dates?dummyDate[after]=2015-04-28"
+    Then the response status code should be 200
+    And the JSON node "hydra:totalItems" should be equal to 3
     And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
 
   @dropSchema

src/Bridge/Doctrine/Orm/Filter/DateFilter.php

@@ -167,7 +167,7 @@ protected function filterProperty(string $property, $values, QueryBuilder $query
     protected function addWhere(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $alias, string $field, string $operator, string $value, string $nullManagement = null, $type = null)
     {
         try {
-            $value = new \DateTime($value);
+            $value = false !== strpos('_immutable', $type) ? 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', [

tests/Fixtures/TestBundle/Entity/DummyDate.php

@@ -21,11 +21,9 @@
  *
  * @author Antoine Bluchet <[email protected]>
  *
- * @ApiResource
+ *
  * @ApiResource(attributes={
- *     "filters"={
- *         "my_dummy_date.date",
- *     }
+ *     "filters"={"my_dummy_date.date"}
  * })
  * @ORM\Entity
  */

tests/Fixtures/TestBundle/Entity/DummyImmutableDate.php

@@ -0,0 +1,54 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * 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\Tests\Fixtures\TestBundle\Entity;
+
+use ApiPlatform\Core\Annotation\ApiResource;
+use Doctrine\ORM\Mapping as ORM;
+
+/**
+ * Dummy Immutable Date.
+ *
+ * @ApiResource(attributes={
+ *     "filters"={"my_dummy_immutable_date.date"}
+ * })
+ * @ORM\Entity
+ */
+class DummyImmutableDate
+{
+    /**
+     * @var int The id
+     *
+     * @ORM\Column(type="integer")
+     * @ORM\Id
+     * @ORM\GeneratedValue(strategy="AUTO")
+     */
+    private $id;
+
+    /**
+     * @var \DateTimeImmutable The dummy date
+     *
+     * @ORM\Column(type="date_immutable")
+     */
+    public $dummyDate;
+
+    /**
+     * Get id.
+     *
+     * @return int
+     */
+    public function getId()
+    {
+        return $this->id;
+    }
+}

tests/Fixtures/app/bootstrap.php

@@ -12,6 +12,8 @@
 declare(strict_types=1);
 
 use Doctrine\Common\Annotations\AnnotationRegistry;
+use Doctrine\DBAL\Types\DateType;
+use Doctrine\DBAL\Types\Type;
 
 date_default_timezone_set('UTC');
 
@@ -20,4 +22,9 @@
 
 AnnotationRegistry::registerLoader('class_exists');
 
+if (!array_key_exists('date_immutable', Type::getTypesMap())) {
+    // Hack to avoid Unknown column type "date_immutable" requested with doctrine < 2.6 when loading DummyImmutableDate
+    Type::addType('date_immutable', DateType::class);
+}
+
 return $loader;

tests/Fixtures/app/config/config_test.yml

@@ -119,6 +119,11 @@ services:
         arguments: [ { 'dummyDate': ~ } ]
         tags:      [ { name: 'api_platform.filter', id: 'my_dummy_date.date' } ]
 
+    my_dummy_immutable_date.date:
+        parent:    'api_platform.doctrine.orm.date_filter'
+        arguments: [ { 'dummyDate': ~ } ]
+        tags:      [ { name: 'api_platform.filter' } ]
+
     app.my_dummy_resource.range_filter:
         parent:    'api_platform.doctrine.orm.range_filter'
         arguments: [ { 'dummyFloat': ~, 'dummyPrice': ~ } ]