BREAKING operators cannot return null anymore #10257

PowerKiKi · PowerKiKi · commit 9ce071d70edb · 2025-04-24T18:22:42.000+09:00
Instead, return an empty string, which will have the same effect as
returning null. Removing null removes the confusion semantics difference
between null and empty string. There never was any difference, and
null should never have been allowed.
diff --git a/src/Definition/Operator/AbstractAssociationOperatorType.php b/src/Definition/Operator/AbstractAssociationOperatorType.php
@@ -10,10 +10,10 @@
 
 abstract class AbstractAssociationOperatorType extends AbstractOperator
 {
-    final public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string
+    final public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string
     {
         if ($args === null) {
-            return null;
+            return '';
         }
 
         if ($metadata->isSingleValuedAssociation($field)) {
@@ -23,7 +23,7 @@ final public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, Clas
         return $this->getCollectionValuedDqlCondition($uniqueNameFactory, $metadata, $queryBuilder, $alias, $field, $args);
     }
 
-    abstract protected function getSingleValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): ?string;
+    abstract protected function getSingleValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): string;
 
-    abstract protected function getCollectionValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): ?string;
+    abstract protected function getCollectionValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): string;
 }
diff --git a/src/Definition/Operator/AbstractOperator.php b/src/Definition/Operator/AbstractOperator.php
@@ -62,5 +62,5 @@ abstract protected function getConfiguration(LeafType $leafType): array;
      * @param string $field the field for the entity on which to apply the filter
      * @param null|array $args all arguments specific to this operator as declared in its configuration
      */
-    abstract public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string;
+    abstract public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string;
 }
diff --git a/src/Definition/Operator/AbstractSimpleOperator.php b/src/Definition/Operator/AbstractSimpleOperator.php
@@ -33,10 +33,10 @@ final protected function getConfiguration(LeafType $leafType): array
         ];
     }
 
-    final public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string
+    final public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string
     {
         if ($args === null) {
-            return null;
+            return '';
         }
 
         $param = $uniqueNameFactory->createParameterName();
diff --git a/src/Definition/Operator/BetweenOperatorType.php b/src/Definition/Operator/BetweenOperatorType.php
@@ -32,10 +32,10 @@ protected function getConfiguration(LeafType $leafType): array
         ];
     }
 
-    public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string
+    public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string
     {
         if ($args === null) {
-            return null;
+            return '';
         }
 
         $from = $uniqueNameFactory->createParameterName();
diff --git a/src/Definition/Operator/EmptyOperatorType.php b/src/Definition/Operator/EmptyOperatorType.php
@@ -25,7 +25,7 @@ protected function getConfiguration(LeafType $leafType): array
         ];
     }
 
-    protected function getSingleValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): ?string
+    protected function getSingleValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): string
     {
         $null = $this->types->getOperator(NullOperatorType::class, self::id());
 
diff --git a/src/Definition/Operator/GroupOperatorType.php b/src/Definition/Operator/GroupOperatorType.php
@@ -32,10 +32,10 @@ protected function getConfiguration(LeafType $leafType): array
         ];
     }
 
-    public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string
+    public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string
     {
         $queryBuilder->addGroupBy($alias . '.' . $field);
 
-        return null;
+        return '';
     }
 }
diff --git a/src/Definition/Operator/HaveOperatorType.php b/src/Definition/Operator/HaveOperatorType.php
@@ -30,7 +30,7 @@ protected function getConfiguration(LeafType $leafType): array
         ];
     }
 
-    protected function getSingleValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): ?string
+    protected function getSingleValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): string
     {
         $in = $this->types->getOperator(InOperatorType::class, self::id());
 
diff --git a/src/Definition/Operator/InOperatorType.php b/src/Definition/Operator/InOperatorType.php
@@ -28,10 +28,10 @@ protected function getConfiguration(LeafType $leafType): array
         ];
     }
 
-    public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string
+    public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string
     {
         if ($args === null) {
-            return null;
+            return '';
         }
 
         $values = $uniqueNameFactory->createParameterName();
diff --git a/src/Definition/Operator/NullOperatorType.php b/src/Definition/Operator/NullOperatorType.php
@@ -24,10 +24,10 @@ protected function getConfiguration(LeafType $leafType): array
         ];
     }
 
-    public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string
+    public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string
     {
         if ($args === null) {
-            return null;
+            return '';
         }
 
         $not = $args['not'] ? 'NOT ' : '';
diff --git a/tests/Blog/Filtering/ModuloOperatorType.php b/tests/Blog/Filtering/ModuloOperatorType.php
@@ -25,10 +25,10 @@ protected function getConfiguration(LeafType $leafType): array
         ];
     }
 
-    public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string
+    public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string
     {
         if (!$args) {
-            return null;
+            return '';
         }
 
         $param = $uniqueNameFactory->createParameterName();
diff --git a/tests/Blog/Filtering/SearchOperatorType.php b/tests/Blog/Filtering/SearchOperatorType.php
@@ -25,15 +25,15 @@ protected function getConfiguration(LeafType $leafType): array
         ];
     }
 
-    public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string
+    public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string
     {
         if (!$args) {
-            return null;
+            return '';
         }
 
         $words = preg_split('/[[:space:]]+/', (string) $args['term'], -1, PREG_SPLIT_NO_EMPTY);
         if (!$words) {
-            return null;
+            return '';
         }
 
         $fields = $this->getSearchableFields($metadata, $alias);
diff --git a/tests/Definition/Operator/OperatorsTest.php b/tests/Definition/Operator/OperatorsTest.php
@@ -32,7 +32,7 @@ final class OperatorsTest extends TestCase
      * @param class-string<AbstractOperator> $className
      */
     #[DataProvider('providerOperator')]
-    public function testOperator(?string $expected, string $className, ?array $args, string $field = 'field'): void
+    public function testOperator(string $expected, string $className, ?array $args, string $field = 'field'): void
     {
         $operator = new $className($this->types, Type::string());
         $uniqueNameFactory = new UniqueNameFactory();
@@ -60,7 +60,7 @@ public static function providerOperator(): array
     {
         return [
             [
-                null,
+                '',
                 BetweenOperatorType::class,
                 null,
             ],
@@ -82,7 +82,7 @@ public static function providerOperator(): array
                 ],
             ],
             [
-                null,
+                '',
                 HaveOperatorType::class,
                 null,
                 'posts',
@@ -106,7 +106,7 @@ public static function providerOperator(): array
                 'posts',
             ],
             [
-                null,
+                '',
                 HaveOperatorType::class,
                 null,
                 'manager',
@@ -148,7 +148,7 @@ public static function providerOperator(): array
                 'favoritePosts',
             ],
             [
-                null,
+                '',
                 EmptyOperatorType::class,
                 null,
                 'posts',
@@ -170,7 +170,7 @@ public static function providerOperator(): array
                 'posts',
             ],
             [
-                null,
+                '',
                 EmptyOperatorType::class,
                 null,
                 'manager',
@@ -192,7 +192,7 @@ public static function providerOperator(): array
                 'manager',
             ],
             [
-                null,
+                '',
                 EqualOperatorType::class,
                 null,
             ],
@@ -213,7 +213,7 @@ public static function providerOperator(): array
                 ],
             ],
             [
-                null,
+                '',
                 GreaterOperatorType::class,
                 null,
             ],
@@ -234,7 +234,7 @@ public static function providerOperator(): array
                 ],
             ],
             [
-                null,
+                '',
                 GreaterOrEqualOperatorType::class,
                 null,
             ],
@@ -255,7 +255,7 @@ public static function providerOperator(): array
                 ],
             ],
             [
-                null,
+                '',
                 InOperatorType::class,
                 null,
             ],
@@ -276,7 +276,7 @@ public static function providerOperator(): array
                 ],
             ],
             [
-                null,
+                '',
                 LessOperatorType::class,
                 null,
             ],
@@ -297,7 +297,7 @@ public static function providerOperator(): array
                 ],
             ],
             [
-                null,
+                '',
                 LessOrEqualOperatorType::class,
                 null,
             ],
@@ -318,7 +318,7 @@ public static function providerOperator(): array
                 ],
             ],
             [
-                null,
+                '',
                 LikeOperatorType::class,
                 null,
             ],
@@ -339,7 +339,7 @@ public static function providerOperator(): array
                 ],
             ],
             [
-                null,
+                '',
                 NullOperatorType::class,
                 null,
             ],
@@ -360,19 +360,19 @@ public static function providerOperator(): array
                 ],
             ],
             [
-                null,
+                '',
                 GroupOperatorType::class,
                 null,
             ],
             [
-                null,
+                '',
                 GroupOperatorType::class,
                 [
                     'value' => null,
                 ],
             ],
             [
-                null,
+                '',
                 GroupOperatorType::class,
                 [
                     'value' => true,

Original file line number	Diff line number	Diff line change
`@@ -10,10 +10,10 @@`
`10`	`10`
`11`	`11`	`abstract class AbstractAssociationOperatorType extends AbstractOperator`
`12`	`12`	`{`
`13`		`- final public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string`
	`13`	`+ final public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string`
`14`	`14`	`{`
`15`	`15`	`if ($args === null) {`
`16`		`- return null;`
	`16`	`+ return '';`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`if ($metadata->isSingleValuedAssociation($field)) {`
`@@ -23,7 +23,7 @@ final public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, Clas`
`23`	`23`	`return $this->getCollectionValuedDqlCondition($uniqueNameFactory, $metadata, $queryBuilder, $alias, $field, $args);`
`24`	`24`	`}`
`25`	`25`
`26`		`- abstract protected function getSingleValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): ?string;`
	`26`	`+ abstract protected function getSingleValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): string;`
`27`	`27`
`28`		`- abstract protected function getCollectionValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): ?string;`
	`28`	`+ abstract protected function getCollectionValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): string;`
`29`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -62,5 +62,5 @@ abstract protected function getConfiguration(LeafType $leafType): array;`
`62`	`62`	`* @param string $field the field for the entity on which to apply the filter`
`63`	`63`	`* @param null\|array $args all arguments specific to this operator as declared in its configuration`
`64`	`64`	`*/`
`65`		`- abstract public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string;`
	`65`	`+ abstract public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string;`
`66`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,10 +33,10 @@ final protected function getConfiguration(LeafType $leafType): array`
`33`	`33`	`];`
`34`	`34`	`}`
`35`	`35`
`36`		`- final public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string`
	`36`	`+ final public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string`
`37`	`37`	`{`
`38`	`38`	`if ($args === null) {`
`39`		`- return null;`
	`39`	`+ return '';`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`$param = $uniqueNameFactory->createParameterName();`
Original file line number	Diff line number	Diff line change
`@@ -32,10 +32,10 @@ protected function getConfiguration(LeafType $leafType): array`
`32`	`32`	`];`
`33`	`33`	`}`
`34`	`34`
`35`		`- public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string`
	`35`	`+ public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string`
`36`	`36`	`{`
`37`	`37`	`if ($args === null) {`
`38`		`- return null;`
	`38`	`+ return '';`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`$from = $uniqueNameFactory->createParameterName();`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ protected function getConfiguration(LeafType $leafType): array`
`25`	`25`	`];`
`26`	`26`	`}`
`27`	`27`
`28`		`- protected function getSingleValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): ?string`
	`28`	`+ protected function getSingleValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): string`
`29`	`29`	`{`
`30`	`30`	`$null = $this->types->getOperator(NullOperatorType::class, self::id());`
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ protected function getConfiguration(LeafType $leafType): array`
`30`	`30`	`];`
`31`	`31`	`}`
`32`	`32`
`33`		`- protected function getSingleValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): ?string`
	`33`	`+ protected function getSingleValuedDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, array $args): string`
`34`	`34`	`{`
`35`	`35`	`$in = $this->types->getOperator(InOperatorType::class, self::id());`
`36`	`36`
Original file line number	Diff line number	Diff line change
`@@ -28,10 +28,10 @@ protected function getConfiguration(LeafType $leafType): array`
`28`	`28`	`];`
`29`	`29`	`}`
`30`	`30`
`31`		`- public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string`
	`31`	`+ public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string`
`32`	`32`	`{`
`33`	`33`	`if ($args === null) {`
`34`		`- return null;`
	`34`	`+ return '';`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`$values = $uniqueNameFactory->createParameterName();`
Original file line number	Diff line number	Diff line change
`@@ -24,10 +24,10 @@ protected function getConfiguration(LeafType $leafType): array`
`24`	`24`	`];`
`25`	`25`	`}`
`26`	`26`
`27`		`- public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string`
	`27`	`+ public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string`
`28`	`28`	`{`
`29`	`29`	`if ($args === null) {`
`30`		`- return null;`
	`30`	`+ return '';`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`$not = $args['not'] ? 'NOT ' : '';`
Original file line number	Diff line number	Diff line change
`@@ -25,10 +25,10 @@ protected function getConfiguration(LeafType $leafType): array`
`25`	`25`	`];`
`26`	`26`	`}`
`27`	`27`
`28`		`- public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): ?string`
	`28`	`+ public function getDqlCondition(UniqueNameFactory $uniqueNameFactory, ClassMetadata $metadata, QueryBuilder $queryBuilder, string $alias, string $field, ?array $args): string`
`29`	`29`	`{`
`30`	`30`	`if (!$args) {`
`31`		`- return null;`
	`31`	`+ return '';`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`$param = $uniqueNameFactory->createParameterName();`