api-platform · teohhanhui · Apr 10, 2019
diff --git a/features/doctrine/date_filter.feature b/features/doctrine/date_filter.feature
diff --git a/features/hydra/collection.feature b/features/hydra/collection.feature
diff --git a/src/Bridge/Doctrine/Common/Filter/DateFilterTrait.php b/src/Bridge/Doctrine/Common/Filter/DateFilterTrait.php
@@ -14,6 +14,8 @@
 namespace ApiPlatform\Core\Bridge\Doctrine\Common\Filter;
 
 use ApiPlatform\Core\Bridge\Doctrine\Common\PropertyHelperTrait;
+use ApiPlatform\Core\Exception\InvalidArgumentException;
+use Psr\Log\LoggerInterface;
 
 /**
  * Trait for filtering the collection by date intervals.
@@ -54,6 +56,8 @@ public function getDescription(string $resourceClass): array
 
     abstract protected function getProperties(): ?array;
 
+    abstract protected function getLogger(): LoggerInterface;
+
     /**
      * Determines whether the given property refers to a date field.
      */
@@ -75,4 +79,17 @@ protected function getFilterDescription(string $property, string $period): array
             ],
         ];
     }
+
+    private function normalizeValue(string $value, string $dateTimeClass, string $property, string $parameterType): ?\DateTimeInterface
+    {
+        try {
+            return new $dateTimeClass($value);
+        } catch (\Exception $e) {
+            $this->getLogger()->notice('Invalid filter ignored', [
+                'exception' => new InvalidArgumentException(sprintf('Invalid value for "%s[%s]". Use date/time string supported by %s::__construct', $property, $parameterType, $dateTimeClass)),
+            ]);
+
+            return null;
+        }
+    }
 }
diff --git a/src/Bridge/Doctrine/MongoDbOdm/Filter/DateFilter.php b/src/Bridge/Doctrine/MongoDbOdm/Filter/DateFilter.php
@@ -69,7 +69,8 @@ protected function filterProperty(string $property, $values, Builder $aggregatio
                 $matchField,
                 self::PARAMETER_BEFORE,
                 $values[self::PARAMETER_BEFORE],
-                $nullManagement
+                $nullManagement,
+                $property
             );
         }
 
@@ -79,7 +80,8 @@ protected function filterProperty(string $property, $values, Builder $aggregatio
                 $matchField,
                 self::PARAMETER_STRICTLY_BEFORE,
                 $values[self::PARAMETER_STRICTLY_BEFORE],
-                $nullManagement
+                $nullManagement,
+                $property
             );
         }
 
@@ -89,7 +91,8 @@ protected function filterProperty(string $property, $values, Builder $aggregatio
                 $matchField,
                 self::PARAMETER_AFTER,
                 $values[self::PARAMETER_AFTER],
-                $nullManagement
+                $nullManagement,
+                $property
             );
         }
 
@@ -99,24 +102,18 @@ protected function filterProperty(string $property, $values, Builder $aggregatio
                 $matchField,
                 self::PARAMETER_STRICTLY_AFTER,
                 $values[self::PARAMETER_STRICTLY_AFTER],
-                $nullManagement
+                $nullManagement,
+                $property
             );
         }
     }
 
     /**
      * 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
+    private function addMatch(Builder $aggregationBuilder, string $field, string $operator, string $value, ?string $nullManagement, string $property): 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)),
-            ]);
-
+        if (null === $value = $this->normalizeValue($value, 'DateTime', $property, $operator)) {
             return;
         }
 
@@ -129,7 +126,7 @@ private function addMatch(Builder $aggregationBuilder, string $field, string $op
 
         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))
+            (self::INCLUDE_NULL_BEFORE_AND_AFTER === $nullManagement && \in_array($operator, [self::PARAMETER_BEFORE, self::PARAMETER_STRICTLY_BEFORE, self::PARAMETER_AFTER, self::PARAMETER_STRICTLY_AFTER], true))
         ) {
             $aggregationBuilder->match()->addOr(
                 $aggregationBuilder->matchExpr()->field($field)->operator($operatorValue[$operator], $value),

diff --git a/src/Bridge/Doctrine/Orm/Filter/DateFilter.php b/src/Bridge/Doctrine/Orm/Filter/DateFilter.php
@@ -79,7 +79,8 @@ protected function filterProperty(string $property, $values, QueryBuilder $query
                 self::PARAMETER_BEFORE,
                 $values[self::PARAMETER_BEFORE],
                 $nullManagement,
-                $type
+                $type,
+                $property
             );
         }
 
@@ -92,7 +93,8 @@ protected function filterProperty(string $property, $values, QueryBuilder $query
                 self::PARAMETER_STRICTLY_BEFORE,
                 $values[self::PARAMETER_STRICTLY_BEFORE],
                 $nullManagement,
-                $type
+                $type,
+                $property
             );
         }
 
@@ -105,7 +107,8 @@ protected function filterProperty(string $property, $values, QueryBuilder $query
                 self::PARAMETER_AFTER,
                 $values[self::PARAMETER_AFTER],
                 $nullManagement,
-                $type
+                $type,
+                $property
             );
         }
 
@@ -118,7 +121,8 @@ protected function filterProperty(string $property, $values, QueryBuilder $query
                 self::PARAMETER_STRICTLY_AFTER,
                 $values[self::PARAMETER_STRICTLY_AFTER],
                 $nullManagement,
-                $type
+                $type,
+                $property
             );
         }
     }
@@ -128,20 +132,35 @@ protected function filterProperty(string $property, $values, QueryBuilder $query
      *
      * @param string|DBALType $type
      */
-    protected function addWhere(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $alias, string $field, string $operator, string $value, string $nullManagement = null, $type = null)
+    protected function addWhere(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $alias, string $field, string $operator, string $value, string $nullManagement = null, $type = null/*, string $property*/)
     {
+        if (\func_num_args() > 8) {
+            $property = func_get_arg(8);
+        } else {
+            if (__CLASS__ !== \get_class($this)) {
+                $r = new \ReflectionMethod($this, __FUNCTION__);
+                if (__CLASS__ !== $r->getDeclaringClass()->getName()) {
+                    @trigger_error(sprintf('Method %s() will have 9 non-optional arguments in API Platform 3.0. Not passing arguments 7-9 is deprecated since API Platform 2.4.', __FUNCTION__), E_USER_DEPRECATED);
+                }
+            }
+        }
+
         $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)),
-            ]);
+        $dateTimeClass = false === strpos($type, '_immutable') ? 'DateTime' : 'DateTimeImmutable';
 
+        if (null === $value = $this->normalizeValue($value, $dateTimeClass, $property ?? $field, $operator)) {
             return;
         }
 
+        /*
+         * Doctrine ORM/DBAL uses the PHP default timezone
+         *
+         * @see https://www.doctrine-project.org/projects/doctrine-orm/en/current/cookbook/working-with-datetime.html#default-timezone-gotcha
+         */
+        if (false === strpos($type, 'tz')) {
+            $value = $value->setTimezone(new \DateTimeZone(date_default_timezone_get()));
+        }
+
         $valueParameter = $queryNameGenerator->generateParameterName($field);
         $operatorValue = [
             self::PARAMETER_BEFORE => '<=',
@@ -156,7 +175,7 @@ protected function addWhere(QueryBuilder $queryBuilder, QueryNameGeneratorInterf
         } 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))
+            (self::INCLUDE_NULL_BEFORE_AND_AFTER === $nullManagement && \in_array($operator, [self::PARAMETER_BEFORE, self::PARAMETER_STRICTLY_BEFORE, self::PARAMETER_AFTER, self::PARAMETER_STRICTLY_AFTER], true))
         ) {
             $queryBuilder->andWhere($queryBuilder->expr()->orX(
                 $baseWhere,

diff --git a/src/Hal/Serializer/CollectionNormalizer.php b/src/Hal/Serializer/CollectionNormalizer.php
@@ -32,7 +32,7 @@ final class CollectionNormalizer extends AbstractCollectionNormalizer
      */
     protected function getPaginationData($object, array $context = []): array
     {
-        [$paginator, $paginated, $currentPage, $itemsPerPage, $lastPage, $pageTotalItems, $totalItems] = $this->getPaginationConfig($object, $context);
+        [$isPaginator, $paginated, $currentPage, $itemsPerPage, $lastPage, $pageTotalItems, $totalItems] = $this->getPaginationConfig($object, $context);
         $parsed = IriHelper::parseIri($context['request_uri'] ?? '/', $this->pageParameterName);
 
         $data = [
@@ -51,7 +51,7 @@ protected function getPaginationData($object, array $context = []): array
                 $data['_links']['prev']['href'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage - 1.);
             }
 
-            if ((null !== $lastPage && $currentPage !== $lastPage) || (null === $lastPage && $pageTotalItems >= $itemsPerPage)) {
+            if (null !== $lastPage && $currentPage !== $lastPage || null === $lastPage && $pageTotalItems >= $itemsPerPage) {
                 $data['_links']['next']['href'] = IriHelper::createIri($parsed['parts'], $parsed['parameters'], $this->pageParameterName, $currentPage + 1.);
             }
         }
@@ -60,7 +60,7 @@ protected function getPaginationData($object, array $context = []): array
             $data['totalItems'] = $totalItems;
         }
 
-        if ($paginator) {
+        if ($isPaginator) {
             $data['itemsPerPage'] = (int) $itemsPerPage;
         }
 

diff --git a/src/Hydra/Serializer/PartialCollectionViewNormalizer.php b/src/Hydra/Serializer/PartialCollectionViewNormalizer.php
@@ -49,10 +49,14 @@ public function normalize($object, $format = null, array $context = [])
             return $data;
         }
 
-        $currentPage = $lastPage = $itemsPerPage = $pageTotalItems = null;
+        $currentPage = null;
+        $lastPage = null;
+        $itemsPerPage = null;
+        $pageTotalItems = null;
         if ($paginated = $object instanceof PartialPaginatorInterface) {
             if ($object instanceof PaginatorInterface) {
-                $paginated = 1. !== $lastPage = $object->getLastPage();
+                $paginated = true;
+                $lastPage = $object->getLastPage();
             } else {
                 $itemsPerPage = $object->getItemsPerPage();
                 $pageTotalItems = (float) \count($object);

diff --git a/src/JsonApi/Serializer/CollectionNormalizer.php b/src/JsonApi/Serializer/CollectionNormalizer.php
@@ -33,7 +33,7 @@ final class CollectionNormalizer extends AbstractCollectionNormalizer
      */
     protected function getPaginationData($object, array $context = []): array
     {
-        [$paginator, $paginated, $currentPage, $itemsPerPage, $lastPage, $pageTotalItems, $totalItems] = $this->getPaginationConfig($object, $context);
+        [$isPaginator, $paginated, $currentPage, $itemsPerPage, $lastPage, $pageTotalItems, $totalItems] = $this->getPaginationConfig($object, $context);
         $parsed = IriHelper::parseIri($context['request_uri'] ?? '/', $this->pageParameterName);
 
         $data = [
@@ -61,7 +61,7 @@ protected function getPaginationData($object, array $context = []): array
             $data['meta']['totalItems'] = $totalItems;
         }
 
-        if ($paginator) {
+        if ($isPaginator) {
             $data['meta']['itemsPerPage'] = (int) $itemsPerPage;
             $data['meta']['currentPage'] = (int) $currentPage;
         }

diff --git a/src/Serializer/AbstractCollectionNormalizer.php b/src/Serializer/AbstractCollectionNormalizer.php
@@ -116,13 +116,20 @@ protected function normalizeRawCollection($object, $format = null, array $contex
      */
     protected function getPaginationConfig($object, array $context = []): array
     {
-        $currentPage = $lastPage = $itemsPerPage = $pageTotalItems = $totalItems = null;
-        $paginated = $paginator = false;
+        $currentPage = null;
+        $lastPage = null;
+        $itemsPerPage = null;
+        $pageTotalItems = null;
+        $totalItems = null;
+        $paginated = false;
+        $isPaginator = false;
 
         if ($object instanceof PartialPaginatorInterface) {
-            $paginated = $paginator = true;
+            $paginated = true;
+            $isPaginator = true;
             if ($object instanceof PaginatorInterface) {
-                $paginated = 1. !== $lastPage = $object->getLastPage();
+                $paginated = true;
+                $lastPage = $object->getLastPage();
                 $totalItems = $object->getTotalItems();
             } else {
                 $pageTotalItems = (float) \count($object);
@@ -134,7 +141,7 @@ protected function getPaginationConfig($object, array $context = []): array
             $totalItems = \count($object);
         }
 
-        return [$paginator, $paginated, $currentPage, $itemsPerPage, $lastPage, $pageTotalItems, $totalItems];
+        return [$isPaginator, $paginated, $currentPage, $itemsPerPage, $lastPage, $pageTotalItems, $totalItems];
     }
 
     /**