fix(doctrine): remove context aware in the new namespace (#4779)

* fix(doctrine): remove context aware in the new namespace

Author: soyuka

CHANGELOG.md

@@ -1,5 +1,41 @@
 # Changelog
 
+## 2.7.0-beta
+
+Json-Ld: property metadata types and iris (#4769)
+Symfony: write listener uri variables converter (#4774)
+Metadata: extra properties operation inheritance (#4773)
+
+**BC**
+
+Doctrine: new interfaces for Filters and Extensions ready, switch to the `ApiPlatform\Doctrine` namespace after fixing your deprecations: (#4779)
+  - `ApiPlatform\Core\Bridge\Doctrine\Orm\Extension` interfaces have an `Operation` instead of the `$operationName`, the new namespace is `ApiPlatform\Doctrine\Orm\Extension`
+  - `ApiPlatform\Core\Bridge\Doctrine\MongoDbOdm\Extension` interfaces have an `Operation` instead of the `$operationName`, the new namespace is `ApiPlatform\Doctrine\Odm\Extension`
+
+## 2.7.0-alpha.7
+
+Metadata: defaults deprecation (#4772)
+
+## 2.7.0-alpha.6
+
+GraphQl: output creates its own type in TypeBuilder (#4766)
+Metadata: clear missing metadata cache pools (#4770)
+Metadata: property override when value is set (#4767)
+Metadata: add read and write to extractor (#4760) 
+JsonSchema: factory backward compatibility layer (#4758)
+Metadata: defaults properly overrides metadata (#4759) 
+Metadata: Add missing processor and provider to extractor (#4754)
+
+## 2.7.0-alpha.5
+
+* Backward compatibility: fix upgrade script for subresources (#4747)
+* Backward compatibility: fix dependency injection (#4748)
+
+## 2.7.0-alpha.4
+
+* Backward compatibility: fix dependency injection (#4744)
+* Metadata: allow extra keys within defaults (#4743)
+
 ## 2.7.0-alpha.3
 
 * Implements Skolem IRIs instead of blank nodes, can be disabled using `iri: false` (#4731)

phpstan.neon.dist

@@ -16,6 +16,7 @@ parameters:
 		- src/Symfony/Bundle/Test/Constraint/ArraySubset.php
 		- tests/Fixtures/app/AppKernel.php
 	excludePaths:
+		- src/deprecation.php
 		- src/Core/Bridge/Symfony/Bundle/Test/Constraint/ArraySubsetLegacy.php
 		# Class ... extends final class cannot be ignored...
 		- src/Core/Action/EntrypointAction.php
@@ -282,10 +283,6 @@ parameters:
 			paths:
 				- tests/Fixtures/TestBundle/Document/
 				- tests/Fixtures/TestBundle/Entity/
-		-
-			message: '#Strict comparison using !== between .+ and .+ will always evaluate to false\.#'
-			paths:
-				- src/Doctrine/Common/PropertyHelperTrait.php
 		- '#Access to an undefined property Prophecy\\Prophecy\\ObjectProphecy<(\\?[a-zA-Z0-9_]+)+>::\$[a-zA-Z0-9_]+#'
 		-
 			message: '#Call to an undefined method Doctrine\\Persistence\\ObjectManager::getConnection\(\)#'
@@ -296,14 +293,6 @@ parameters:
 			path: src/Symfony/EventListener/AddFormatListener.php
 		- '#Parameter \#1 \$vars of class GraphQL\\Language\\AST\\(IntValue|ObjectField|ObjectValue|BooleanValue|ListValue|StringValue)Node constructor expects array<bool\|float\|GraphQL\\Language\\AST\\Location\|GraphQL\\Language\\AST\\NameNode\|GraphQL\\Language\\AST\\NodeList\|GraphQL\\Language\\AST\\SelectionSetNode\|int\|string\|null>, array<string, .+> given\.#'
 		- '#Parameter \#1 \$defaultContext of class Symfony\\Component\\Serializer\\Encoder\\Json(De|En)code constructor expects array, (int|true) given\.#'
-		- '#Parameter \#(2|3) \$(resourceMetadataFactory|pagination) of class ApiPlatform\\Doctrine\\Orm\\Extension\\PaginationExtension constructor expects (ApiPlatform\\Core\\Metadata\\Resource\\Factory\\ResourceMetadataFactoryInterface\|Symfony\\Component\\HttpFoundation\\RequestStack|ApiPlatform\\Core\\Metadata\\Resource\\Factory\\ResourceMetadataFactoryInterface\|ApiPlatform\\State\\Pagination\\Pagination), stdClass given\.#'
-		-
-			message: '#Parameter \#[0-9] \$filterLocator of class .+ constructor expects ApiPlatform\\Core\\Api\\FilterCollection|Psr\\Container\\ContainerInterface, ArrayObject<mixed, mixed> given\.#'
-			paths:
-				- tests/Doctrine/Orm/Extension/FilterExtensionTest.php
-				- tests/Hydra/Serializer/CollectionFiltersNormalizerTest.php
-				- tests/Core/Swagger/Serializer/DocumentationNormalizerV2Test.php
-				- tests/Core/Swagger/Serializer/DocumentationNormalizerV3Test.php
 		-
 			message: '#Parameter \#1 \$objectValue of method GraphQL\\Type\\Definition\\InterfaceType::resolveType\(\) expects object, array(<string, string>)? given.#'
 			path: tests/GraphQl/Type/TypeBuilderTest.php
@@ -324,9 +313,6 @@ parameters:
 		- '#Constructor of class ApiPlatform\\Core\\Annotation\\ApiProperty has an unused parameter#'
 
 		# Expected, due to optional interfaces
-		- '#Method ApiPlatform\\Doctrine\\Orm\\Extension\\QueryCollectionExtensionInterface::applyToCollection\(\) invoked with 5 parameters, 3-4 required\.#'
-		- '#Method ApiPlatform\\\Doctrine\\Orm\\Extension\\QueryResult(Item|Collection)ExtensionInterface::getResult\(\) invoked with 4 parameters, 1 required\.#'
-		- '#Method ApiPlatform\\Doctrine\\Orm\\Extension\\QueryResult(Item|Collection)ExtensionInterface::supportsResult\(\) invoked with 3 parameters, 1-2 required\.#'
 		- '#Method ApiPlatform\\Core\\Bridge\\Symfony\\Routing\\RouteNameResolverInterface::getRouteName\(\) invoked with 3 parameters, 2 required\.#'
 		- '#Method ApiPlatform\\Core\\DataPersister\\DataPersisterInterface::persist\(\) invoked with 2 parameters, 1 required\.#'
 		- '#Method ApiPlatform\\Core\\DataPersister\\DataPersisterInterface::remove\(\) invoked with 2 parameters, 1 required\.#'
@@ -337,8 +323,6 @@ parameters:
 		- '#Method Symfony\\Component\\Serializer\\Normalizer\\NormalizerInterface::supportsNormalization\(\) invoked with 3 parameters, 1-2 required\.#'
 
 		# Expected, due to deprecations
-		- '#Method ApiPlatform\\Doctrine\\Orm\\Filter\\(Abstract|Exists|Order)Filter::filterProperty\(\) invoked with 7 parameters, 5-6 required\.#'
-		- '#Method ApiPlatform\\Doctrine\\Orm\\Filter\\(AbstractFilter|FilterInterface)::apply\(\) invoked with 5 parameters, 3-4 required\.#'
 		- '#Method ApiPlatform\\PathResolver\\OperationPathResolverInterface::resolveOperationPath\(\) invoked with 4 parameters, 3 required\.#'
 		- 
 			message: '#If condition is always false.#'
@@ -369,6 +353,9 @@ parameters:
 		- 
 			message: "#^Unreachable statement - code above always terminates.$#"
 			path: tests
+		- 
+			message: "#^Unreachable statement - code above always terminates.$#"
+			path: src/Core/Bridge/Doctrine/EventListener/PublishMercureUpdatesListener.php
 		-
 			message: "#Access to an undefined static property static\\([^)]+\\)::\\$container.$#"
 			path: tests

src/Api/FilterLocatorTrait.php

@@ -13,8 +13,6 @@
 
 namespace ApiPlatform\Api;
 
-use ApiPlatform\Core\Api\FilterCollection;
-use ApiPlatform\Exception\InvalidArgumentException;
 use Psr\Container\ContainerInterface;
 
 /**
@@ -26,24 +24,17 @@
  */
 trait FilterLocatorTrait
 {
+    /** @var ContainerInterface */
     private $filterLocator;
 
     /**
      * Sets a filter locator with a backward compatibility.
      *
-     * @param ContainerInterface|FilterCollection|null $filterLocator
+     * @param ContainerInterface|null $filterLocator
      */
     private function setFilterLocator($filterLocator, bool $allowNull = false): void
     {
-        if ($filterLocator instanceof ContainerInterface || $filterLocator instanceof FilterCollection || (null === $filterLocator && $allowNull)) {
-            if ($filterLocator instanceof FilterCollection) {
-                @trigger_error(sprintf('The %s class is deprecated since version 2.1 and will be removed in 3.0. Provide an implementation of %s instead.', FilterCollection::class, ContainerInterface::class), \E_USER_DEPRECATED);
-            }
-
-            $this->filterLocator = $filterLocator;
-        } else {
-            throw new InvalidArgumentException(sprintf('The "$filterLocator" argument is expected to be an implementation of the "%s" interface%s.', ContainerInterface::class, $allowNull ? ' or null' : ''));
-        }
+        $this->filterLocator = $filterLocator;
     }
 
     /**
@@ -55,12 +46,6 @@ private function getFilter(string $filterId): ?FilterInterface
             return $this->filterLocator->get($filterId);
         }
 
-        if ($this->filterLocator instanceof FilterCollection && $this->filterLocator->offsetExists($filterId)) {
-            return $this->filterLocator->offsetGet($filterId);
-        }
-
         return null;
     }
 }
-
-class_alias(FilterLocatorTrait::class, \ApiPlatform\Core\Api\FilterLocatorTrait::class);

src/Core/Api/FilterLocatorTrait.php

@@ -13,11 +13,51 @@
 
 namespace ApiPlatform\Core\Api;
 
-class_exists(\ApiPlatform\Api\FilterLocatorTrait::class);
+use ApiPlatform\Core\Exception\InvalidArgumentException;
+use Psr\Container\ContainerInterface;
 
-if (false) {
-    trait FilterLocatorTrait
+/**
+ * Manipulates filters with a backward compatibility between the new filter locator and the deprecated filter collection.
+ *
+ * @author Baptiste Meyer <[email protected]>
+ *
+ * @internal
+ */
+trait FilterLocatorTrait
+{
+    private $filterLocator;
+
+    /**
+     * Sets a filter locator with a backward compatibility.
+     *
+     * @param ContainerInterface|FilterCollection|null $filterLocator
+     */
+    private function setFilterLocator($filterLocator, bool $allowNull = false): void
+    {
+        if ($filterLocator instanceof ContainerInterface || $filterLocator instanceof FilterCollection || (null === $filterLocator && $allowNull)) {
+            if ($filterLocator instanceof FilterCollection) {
+                @trigger_error(sprintf('The %s class is deprecated since version 2.1 and will be removed in 3.0. Provide an implementation of %s instead.', FilterCollection::class, ContainerInterface::class), \E_USER_DEPRECATED);
+            }
+
+            $this->filterLocator = $filterLocator;
+        } else {
+            throw new InvalidArgumentException(sprintf('The "$filterLocator" argument is expected to be an implementation of the "%s" interface%s.', ContainerInterface::class, $allowNull ? ' or null' : ''));
+        }
+    }
+
+    /**
+     * Gets a filter with a backward compatibility.
+     */
+    private function getFilter(string $filterId): ?FilterInterface
     {
-        use \ApiPlatform\Api\FilterLocatorTrait;
+        if ($this->filterLocator instanceof ContainerInterface && $this->filterLocator->has($filterId)) {
+            return $this->filterLocator->get($filterId);
+        }
+
+        if ($this->filterLocator instanceof FilterCollection && $this->filterLocator->offsetExists($filterId)) {
+            return $this->filterLocator->offsetGet($filterId);
+        }
+
+        return null;
     }
 }

src/Core/Bridge/Doctrine/Common/Filter/BooleanFilterTrait.php

@@ -13,11 +13,87 @@
 
 namespace ApiPlatform\Core\Bridge\Doctrine\Common\Filter;
 
-class_exists(\ApiPlatform\Doctrine\Common\Filter\BooleanFilterTrait::class);
+use ApiPlatform\Core\Bridge\Doctrine\Common\PropertyHelperTrait;
+use ApiPlatform\Core\Exception\InvalidArgumentException;
+use Psr\Log\LoggerInterface;
 
-if (false) {
-    trait BooleanFilterTrait
+/**
+ * Trait for filtering the collection by boolean values.
+ *
+ * Filters collection on equality of boolean properties. The value is specified
+ * as one of ( "true" | "false" | "1" | "0" ) in the query.
+ *
+ * For each property passed, if the resource does not have such property or if
+ * the value is not one of ( "true" | "false" | "1" | "0" ) the property is ignored.
+ *
+ * @author Amrouche Hamza <[email protected]>
+ * @author Teoh Han Hui <[email protected]>
+ * @author Alan Poulain <[email protected]>
+ */
+trait BooleanFilterTrait
+{
+    use PropertyHelperTrait;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getDescription(string $resourceClass): array
+    {
+        $description = [];
+
+        $properties = $this->getProperties();
+        if (null === $properties) {
+            $properties = array_fill_keys($this->getClassMetadata($resourceClass)->getFieldNames(), null);
+        }
+
+        foreach ($properties as $property => $unused) {
+            if (!$this->isPropertyMapped($property, $resourceClass) || !$this->isBooleanField($property, $resourceClass)) {
+                continue;
+            }
+            $propertyName = $this->normalizePropertyName($property);
+            $description[$propertyName] = [
+                'property' => $propertyName,
+                'type' => 'bool',
+                'required' => false,
+            ];
+        }
+
+        return $description;
+    }
+
+    abstract protected function getProperties(): ?array;
+
+    abstract protected function getLogger(): LoggerInterface;
+
+    abstract protected function normalizePropertyName($property);
+
+    /**
+     * Determines whether the given property refers to a boolean field.
+     */
+    protected function isBooleanField(string $property, string $resourceClass): bool
+    {
+        return isset(self::DOCTRINE_BOOLEAN_TYPES[(string) $this->getDoctrineFieldType($property, $resourceClass)]);
+    }
+
+    private function normalizeValue($value, string $property): ?bool
     {
-        use \ApiPlatform\Doctrine\Common\Filter\BooleanFilterTrait;
+        if (\in_array($value, [true, 'true', '1'], true)) {
+            return true;
+        }
+
+        if (\in_array($value, [false, 'false', '0'], true)) {
+            return false;
+        }
+
+        $this->getLogger()->notice('Invalid filter ignored', [
+            'exception' => new InvalidArgumentException(sprintf('Invalid boolean value for "%s" property, expected one of ( "%s" )', $property, implode('" | "', [
+                'true',
+                'false',
+                '1',
+                '0',
+            ]))),
+        ]);
+
+        return null;
     }
 }

src/Core/Bridge/Doctrine/Common/Filter/DateFilterInterface.php

@@ -0,0 +1,33 @@
+<?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\Bridge\Doctrine\Common\Filter;
+
+/**
+ * Interface for filtering the collection by date intervals.
+ *
+ * @author Kévin Dunglas <[email protected]>
+ * @author Théo FIDRY <[email protected]>
+ * @author Alan Poulain <[email protected]>
+ */
+interface DateFilterInterface
+{
+    public const PARAMETER_BEFORE = 'before';
+    public const PARAMETER_STRICTLY_BEFORE = 'strictly_before';
+    public const PARAMETER_AFTER = 'after';
+    public const PARAMETER_STRICTLY_AFTER = 'strictly_after';
+    public const EXCLUDE_NULL = 'exclude_null';
+    public const INCLUDE_NULL_BEFORE = 'include_null_before';
+    public const INCLUDE_NULL_AFTER = 'include_null_after';
+    public const INCLUDE_NULL_BEFORE_AND_AFTER = 'include_null_before_and_after';
+}