Add a deprecation message when the old syntax is used

(and consider the feedback: order of the constructor parameters, final class,
keep constant, ...)

Author: jpdz8005

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

@@ -34,20 +34,28 @@
  * Request: GET /products?brand[exists]
  * Interpretation: filter products which have a brand
  *
+ * @author Teoh Han Hui <teohhanhui@gmail.com>
  * @author Julien Verger <julien.verger@gmail.com>
  */
 class ExistsFilter extends AbstractContextAwareFilter
 {
+    const QUERY_PARAMETER_KEY = 'exists';
+
     /**
      * @var string Keyword used to retrieve the value
      */
-    protected $existsParameterName;
+    private $existsParameterName;
 
     /**
      * @param RequestStack|null $requestStack No prefix to prevent autowiring of this deprecated property
      */
-    public function __construct(ManagerRegistry $managerRegistry, $requestStack = null, string $existsParameterName = 'exists', LoggerInterface $logger = null, array $properties = null)
-    {
+    public function __construct(
+        ManagerRegistry $managerRegistry,
+        $requestStack = null,
+        LoggerInterface $logger = null,
+        array $properties = null,
+        string $existsParameterName = self::QUERY_PARAMETER_KEY
+    ) {
         parent::__construct($managerRegistry, $requestStack, $logger, $properties);
 
         $this->existsParameterName = $existsParameterName;
@@ -85,11 +93,7 @@ public function getDescription(string $resourceClass): array
      */
     public function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, string $operationName = null, array $context = [])
     {
-        if (isset($context['filters']) && !isset($context['filters'][$this->existsParameterName])) {
-            return;
-        }
-
-        if (!isset($context['filters'][$this->existsParameterName]) || !\is_array($context['filters'][$this->existsParameterName])) {
+        if (!\is_array($context['filters'][$this->existsParameterName] ?? null)) {
             parent::apply($queryBuilder, $queryNameGenerator, $resourceClass, $operationName, $context);
 
             return;
@@ -113,6 +117,14 @@ protected function filterProperty(string $property, $value, QueryBuilder $queryB
             return;
         }
 
+        if (\is_array($value) && isset($value[self::QUERY_PARAMETER_KEY])) {
+            @trigger_error(
+                sprintf('The ExistsFilter syntax "%s[exists]=true/false" is deprecated. Use the syntax "exists[%s]=true/false" instead.', $property, $property),
+                E_USER_DEPRECATED
+            );
+            $value = $value['exists'];
+        }
+
         if (\in_array($value, [true, 'true', '1', '', null], true)) {
             $value = true;
         } elseif (\in_array($value, [false, 'false', '0'], true)) {

src/Bridge/Symfony/Bundle/Resources/config/doctrine_orm.xml

@@ -91,8 +91,9 @@
         <service id="api_platform.doctrine.orm.exists_filter" class="ApiPlatform\Core\Bridge\Doctrine\Orm\Filter\ExistsFilter" public="false" abstract="true">
             <argument type="service" id="doctrine" />
             <argument>null</argument>
-            <argument>%api_platform.collection.notnull_parameter_name%</argument>
             <argument type="service" id="logger" on-invalid="ignore" />
+            <argument>null</argument>
+            <argument>%api_platform.collection.notnull_parameter_name%</argument>
         </service>
 
         <!-- Metadata loader -->

tests/Bridge/Doctrine/Orm/Filter/ExistsFilterTest.php

@@ -28,7 +28,7 @@ class ExistsFilterTest extends DoctrineOrmFilterTestCase
 
     public function testGetDescription()
     {
-        $filter = new ExistsFilter($this->managerRegistry, null, 'exists', null, ['name' => null, 'description' => null]);
+        $filter = new ExistsFilter($this->managerRegistry, null, null, ['name' => null, 'description' => null]);
 
         $this->assertEquals([
             'exists[description]' => [
@@ -39,6 +39,19 @@ public function testGetDescription()
         ], $filter->getDescription($this->resourceClass));
     }
 
+    public function testGetDescriptionWithCustomExistsParameterName()
+    {
+        $filter = new ExistsFilter($this->managerRegistry, null, null, ['name' => null, 'description' => null], 'notnull');
+
+        $this->assertEquals([
+            'notnull[description]' => [
+                'property' => 'description',
+                'type' => 'bool',
+                'required' => false,
+            ],
+        ], $filter->getDescription($this->resourceClass));
+    }
+
     public function testGetDescriptionDefaultFields()
     {
         $filter = new ExistsFilter($this->managerRegistry);
@@ -100,10 +113,10 @@ public function testGetDescriptionDefaultFields()
     public function provideApplyTestData(): array
     {
         $existsFilterFactory = function (ManagerRegistry $managerRegistry, RequestStack $requestStack = null, array $properties = null): ExistsFilter {
-            return new ExistsFilter($managerRegistry, $requestStack, 'exists', null, $properties);
+            return new ExistsFilter($managerRegistry, $requestStack, null, $properties, 'exists');
         };
         $customExistsFilterFactory = function (ManagerRegistry $managerRegistry, RequestStack $requestStack = null, array $properties = null): ExistsFilter {
-            return new ExistsFilter($managerRegistry, $requestStack, 'customExists', null, $properties);
+            return new ExistsFilter($managerRegistry, $requestStack, null, $properties, 'customExists');
         };
 
         return [