From 7fc3153dde1e1b657fc4c62e00fa5491400c8308 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan=20B=C3=B6hmer?= <mail@jan-boehmer.de>
Date: Fri, 23 Aug 2024 22:58:04 +0200
Subject: [PATCH] Fixed filter logic for exclusion of  entities. Before parts
 with null values as property value were wrongly not shown

This fixes  issue #658
---
 .../Filters/Constraints/EntityConstraint.php         | 10 ++++++----
 src/DataTables/Filters/Constraints/FilterTrait.php   | 12 +++++++++++-
 2 files changed, 17 insertions(+), 5 deletions(-)

diff --git a/src/DataTables/Filters/Constraints/EntityConstraint.php b/src/DataTables/Filters/Constraints/EntityConstraint.php
index 671b743f..6e9721f4 100644
--- a/src/DataTables/Filters/Constraints/EntityConstraint.php
+++ b/src/DataTables/Filters/Constraints/EntityConstraint.php
@@ -137,7 +137,7 @@ class EntityConstraint extends AbstractConstraint
         }
 
         //We need to handle null values differently, as they can not be compared with == or !=
-        if (!$this->value instanceof AbstractDBElement) {
+        if ($this->value === null) {
             if($this->operator === '=' || $this->operator === 'INCLUDING_CHILDREN') {
                 $queryBuilder->andWhere(sprintf("%s IS NULL", $this->property));
                 return;
@@ -152,8 +152,9 @@ class EntityConstraint extends AbstractConstraint
         }
 
         if($this->operator === '=' || $this->operator === '!=') {
-           $this->addSimpleAndConstraint($queryBuilder, $this->property, $this->identifier, $this->operator, $this->value);
-           return;
+            //Include null values on != operator, so that really all values are returned that are not equal to the given value
+            $this->addSimpleAndConstraint($queryBuilder, $this->property, $this->identifier, $this->operator, $this->value, $this->operator === '!=');
+            return;
         }
 
         //Otherwise retrieve the children list and apply the operator to it
@@ -168,7 +169,8 @@ class EntityConstraint extends AbstractConstraint
             }
 
             if ($this->operator === 'EXCLUDING_CHILDREN') {
-                $this->addSimpleAndConstraint($queryBuilder, $this->property, $this->identifier, 'NOT IN', $list);
+                //Include null values in the result, so that all elements that are not in the list are returned
+                $this->addSimpleAndConstraint($queryBuilder, $this->property, $this->identifier, 'NOT IN', $list, true);
                 return;
             }
         } else {
diff --git a/src/DataTables/Filters/Constraints/FilterTrait.php b/src/DataTables/Filters/Constraints/FilterTrait.php
index 26707841..3260e4e3 100644
--- a/src/DataTables/Filters/Constraints/FilterTrait.php
+++ b/src/DataTables/Filters/Constraints/FilterTrait.php
@@ -56,8 +56,14 @@ trait FilterTrait
 
     /**
      * Adds a simple constraint in the form of (property OPERATOR value) (e.g. "part.name = :name") to the given query builder.
+     * @param  QueryBuilder  $queryBuilder The query builder to add the constraint to
+     * @param  string  $property The property to compare
+     * @param  string  $parameterIdentifier The identifier for the parameter
+     * @param  string  $comparison_operator The comparison operator to use
+     * @param  mixed  $value The value to compare to
+     * @param  bool  $include_null If true, the result of this constraint will also include null values of this property (useful for exclusion filters)
      */
-    protected function addSimpleAndConstraint(QueryBuilder $queryBuilder, string $property, string $parameterIdentifier, string $comparison_operator, mixed $value): void
+    protected function addSimpleAndConstraint(QueryBuilder $queryBuilder, string $property, string $parameterIdentifier, string $comparison_operator, mixed $value, bool $include_null = false): void
     {
         if ($comparison_operator === 'IN' || $comparison_operator === 'NOT IN') {
             $expression = sprintf("%s %s (:%s)", $property, $comparison_operator, $parameterIdentifier);
@@ -65,6 +71,10 @@ trait FilterTrait
             $expression = sprintf("%s %s :%s", $property, $comparison_operator, $parameterIdentifier);
         }
 
+        if ($include_null) {
+            $expression = sprintf("(%s OR %s IS NULL)", $expression, $property);
+        }
+
         if($this->useHaving || $this->isAggregateFunctionString($property)) { //If the property is an aggregate function, we have to use the "having" instead of the "where"
             $queryBuilder->andHaving($expression);
         } else {