use simple filtering joinst for simple ANY relationship condition

nextras · Mar 11, 2024 · f5994ba · f5994ba
1 parent 884a1ef
commit f5994ba
Show file tree

Hide file tree

Showing 29 changed files with 119 additions and 46 deletions.
diff --git a/src/Collection/Aggregations/AnyAggregator.php b/src/Collection/Aggregations/AnyAggregator.php
@@ -4,6 +4,7 @@
 
 
 use Nextras\Dbal\QueryBuilder\QueryBuilder;
+use Nextras\Orm\Collection\Expression\ExpressionContext;
 use Nextras\Orm\Collection\Functions\Result\DbalExpressionResult;
 use Nextras\Orm\Collection\Functions\Result\DbalTableJoin;
 use Nextras\Orm\Exception\InvalidArgumentException;
@@ -50,8 +51,15 @@ public function aggregateValues(array $values): bool
 	public function aggregateExpression(
 		QueryBuilder $queryBuilder,
 		DbalExpressionResult $expression,
+		ExpressionContext $context,
 	): DbalExpressionResult
 	{
+		if ($context !== ExpressionContext::FilterOr) {
+			// When we are not in OR expression, we may simply filter the joined table by the condition.
+			// Otherwise, we have to employ a HAVING clause with aggregation function.
+			return $expression;
+		}
+
 		$joins = $expression->joins;
 		$join = array_pop($joins);
 		if ($join === null) {

diff --git a/src/Collection/Aggregations/CountAggregator.php b/src/Collection/Aggregations/CountAggregator.php
@@ -4,6 +4,7 @@
 
 
 use Nextras\Dbal\QueryBuilder\QueryBuilder;
+use Nextras\Orm\Collection\Expression\ExpressionContext;
 use Nextras\Orm\Collection\Functions\Result\DbalExpressionResult;
 use Nextras\Orm\Collection\Functions\Result\DbalTableJoin;
 use Nextras\Orm\Exception\InvalidArgumentException;
@@ -56,6 +57,7 @@ public function aggregateValues(array $values): bool
 	public function aggregateExpression(
 		QueryBuilder $queryBuilder,
 		DbalExpressionResult $expression,
+		ExpressionContext $context,
 	): DbalExpressionResult
 	{
 		$joins = $expression->joins;

diff --git a/src/Collection/Aggregations/IDbalAggregator.php b/src/Collection/Aggregations/IDbalAggregator.php
@@ -4,6 +4,7 @@
 
 
 use Nextras\Dbal\QueryBuilder\QueryBuilder;
+use Nextras\Orm\Collection\Expression\ExpressionContext;
 use Nextras\Orm\Collection\Functions\Result\DbalExpressionResult;
 
 
@@ -12,5 +13,6 @@ interface IDbalAggregator extends IAggregator
 	public function aggregateExpression(
 		QueryBuilder $queryBuilder,
 		DbalExpressionResult $expression,
+		ExpressionContext $context,
 	): DbalExpressionResult;
 }
diff --git a/src/Collection/Aggregations/NoneAggregator.php b/src/Collection/Aggregations/NoneAggregator.php
@@ -4,6 +4,7 @@
 
 
 use Nextras\Dbal\QueryBuilder\QueryBuilder;
+use Nextras\Orm\Collection\Expression\ExpressionContext;
 use Nextras\Orm\Collection\Functions\Result\DbalExpressionResult;
 use Nextras\Orm\Collection\Functions\Result\DbalTableJoin;
 use Nextras\Orm\Exception\InvalidArgumentException;
@@ -50,6 +51,7 @@ public function aggregateValues(array $values): bool
 	public function aggregateExpression(
 		QueryBuilder $queryBuilder,
 		DbalExpressionResult $expression,
+		ExpressionContext $context,
 	): DbalExpressionResult
 	{
 		$joins = $expression->joins;

diff --git a/src/Collection/Aggregations/NumericAggregator.php b/src/Collection/Aggregations/NumericAggregator.php
@@ -4,6 +4,7 @@
 
 
 use Nextras\Dbal\QueryBuilder\QueryBuilder;
+use Nextras\Orm\Collection\Expression\ExpressionContext;
 use Nextras\Orm\Collection\Functions\Result\DbalExpressionResult;
 
 
@@ -41,6 +42,7 @@ public function aggregateValues(array $values): mixed
 	public function aggregateExpression(
 		QueryBuilder $queryBuilder,
 		DbalExpressionResult $expression,
+		ExpressionContext $context,
 	): DbalExpressionResult
 	{
 		return new DbalExpressionResult(

diff --git a/src/Collection/DbalCollection.php b/src/Collection/DbalCollection.php
@@ -6,6 +6,7 @@
 use Iterator;
 use Nextras\Dbal\IConnection;
 use Nextras\Dbal\QueryBuilder\QueryBuilder;
+use Nextras\Orm\Collection\Expression\ExpressionContext;
 use Nextras\Orm\Collection\Functions\Result\DbalExpressionResult;
 use Nextras\Orm\Collection\Helpers\DbalQueryBuilderHelper;
 use Nextras\Orm\Collection\Helpers\FetchPairsHelper;
@@ -122,13 +123,13 @@ public function orderBy($expression, string $direction = ICollection::ASC): ICol
 
 			foreach ($expression as $subExpression => $subDirection) {
 				$collection->ordering[] = [
-					$helper->processExpression($collection->queryBuilder, $subExpression, null),
+					$helper->processExpression($collection->queryBuilder, $subExpression, ExpressionContext::FilterAnd, null),
 					$subDirection,
 				];
 			}
 		} else {
 			$collection->ordering[] = [
-				$helper->processExpression($collection->queryBuilder, $expression, null),
+				$helper->processExpression($collection->queryBuilder, $expression, ExpressionContext::ValueExpression, null),
 				$direction,
 			];
 		}
@@ -307,9 +308,10 @@ public function getQueryBuilder(): QueryBuilder
 		if (count($args) > 0) {
 			array_unshift($args, ICollection::AND);
 			$expression = $helper->processExpression(
-				$this->queryBuilder,
-				$args,
-				null,
+				builder: $this->queryBuilder,
+				expression: $args,
+				context: ExpressionContext::FilterAnd,
+				aggregator: null,
 			);
 			$joins = $expression->joins;
 			if ($expression->isHavingClause) {

diff --git a/src/Collection/Expression/ExpressionContext.php b/src/Collection/Expression/ExpressionContext.php
@@ -0,0 +1,17 @@
+<?php declare(strict_types = 1);
+
+namespace Nextras\Orm\Collection\Expression;
+
+
+/**
+ * @internal
+ *
+ * Determines if the expression is processed for AND subtree, OR subtree or pure expression, e.g., a sorting expression.
+ * OR subtree requires more complex SQL construction, in other modes we may optimize the resulting SQL.
+ */
+enum ExpressionContext
+{
+	case FilterAnd;
+	case FilterOr;
+	case ValueExpression;
+}
diff --git a/src/Collection/Functions/BaseCompareFunction.php b/src/Collection/Functions/BaseCompareFunction.php
@@ -6,6 +6,7 @@
 use Nextras\Dbal\QueryBuilder\QueryBuilder;
 use Nextras\Orm\Collection\Aggregations\IArrayAggregator;
 use Nextras\Orm\Collection\Aggregations\IDbalAggregator;
+use Nextras\Orm\Collection\Expression\ExpressionContext;
 use Nextras\Orm\Collection\Functions\Result\ArrayExpressionResult;
 use Nextras\Orm\Collection\Functions\Result\DbalExpressionResult;
 use Nextras\Orm\Collection\Helpers\ArrayCollectionHelper;
@@ -59,12 +60,13 @@ public function processDbalExpression(
 		DbalQueryBuilderHelper $helper,
 		QueryBuilder $builder,
 		array $args,
+		ExpressionContext $context,
 		?IDbalAggregator $aggregator = null,
 	): DbalExpressionResult
 	{
 		assert(count($args) === 2);
 
-		$expression = $helper->processExpression($builder, $args[0], $aggregator);
+		$expression = $helper->processExpression($builder, $args[0], $context, $aggregator);
 
 		if ($expression->valueNormalizer !== null) {
 			$cb = $expression->valueNormalizer;

diff --git a/src/Collection/Functions/BaseNumericAggregateFunction.php b/src/Collection/Functions/BaseNumericAggregateFunction.php
@@ -7,6 +7,7 @@
 use Nextras\Orm\Collection\Aggregations\IArrayAggregator;
 use Nextras\Orm\Collection\Aggregations\IDbalAggregator;
 use Nextras\Orm\Collection\Aggregations\NumericAggregator;
+use Nextras\Orm\Collection\Expression\ExpressionContext;
 use Nextras\Orm\Collection\Functions\Result\ArrayExpressionResult;
 use Nextras\Orm\Collection\Functions\Result\DbalExpressionResult;
 use Nextras\Orm\Collection\Helpers\ArrayCollectionHelper;
@@ -54,6 +55,7 @@ public function processDbalExpression(
 		DbalQueryBuilderHelper $helper,
 		QueryBuilder $builder,
 		array $args,
+		ExpressionContext $context,
 		?IDbalAggregator $aggregator = null,
 	): DbalExpressionResult
 	{
@@ -63,6 +65,7 @@ public function processDbalExpression(
 			throw new InvalidStateException("Cannot apply two aggregations simultaneously.");
 		}
 
-		return $helper->processExpression($builder, $args[0], $this->aggregator)->applyAggregator($builder);
+		return $helper->processExpression($builder, $args[0], $context, $this->aggregator)
+			->applyAggregator($builder, ExpressionContext::ValueExpression);
 	}
 }
diff --git a/src/Collection/Functions/CollectionFunction.php b/src/Collection/Functions/CollectionFunction.php
@@ -6,6 +6,7 @@
 use Nextras\Dbal\QueryBuilder\QueryBuilder;
 use Nextras\Orm\Collection\Aggregations\IArrayAggregator;
 use Nextras\Orm\Collection\Aggregations\IDbalAggregator;
+use Nextras\Orm\Collection\Expression\ExpressionContext;
 use Nextras\Orm\Collection\Functions\Result\ArrayExpressionResult;
 use Nextras\Orm\Collection\Functions\Result\DbalExpressionResult;
 use Nextras\Orm\Collection\Helpers\ArrayCollectionHelper;
@@ -45,6 +46,7 @@ public function processDbalExpression(
 		DbalQueryBuilderHelper $helper,
 		QueryBuilder $builder,
 		array $args,
+		ExpressionContext $context,
 		?IDbalAggregator $aggregator = null,
 	): DbalExpressionResult;
 }
diff --git a/src/Collection/Functions/CompareLikeFunction.php b/src/Collection/Functions/CompareLikeFunction.php
@@ -7,6 +7,7 @@
 use Nextras\Dbal\QueryBuilder\QueryBuilder;
 use Nextras\Orm\Collection\Aggregations\IArrayAggregator;
 use Nextras\Orm\Collection\Aggregations\IDbalAggregator;
+use Nextras\Orm\Collection\Expression\ExpressionContext;
 use Nextras\Orm\Collection\Expression\LikeExpression;
 use Nextras\Orm\Collection\Functions\Result\ArrayExpressionResult;
 use Nextras\Orm\Collection\Functions\Result\DbalExpressionResult;
@@ -64,12 +65,13 @@ public function processDbalExpression(
 		DbalQueryBuilderHelper $helper,
 		QueryBuilder $builder,
 		array $args,
+		ExpressionContext $context,
 		?IDbalAggregator $aggregator = null,
 	): DbalExpressionResult
 	{
 		assert(count($args) === 2);
 
-		$expression = $helper->processExpression($builder, $args[0], $aggregator);
+		$expression = $helper->processExpression($builder, $args[0], $context, $aggregator);
 
 		$likeExpression = $args[1];
 		assert($likeExpression instanceof LikeExpression);

diff --git a/src/Collection/Functions/ConjunctionOperatorFunction.php b/src/Collection/Functions/ConjunctionOperatorFunction.php
@@ -6,6 +6,7 @@
 use Nextras\Dbal\QueryBuilder\QueryBuilder;
 use Nextras\Orm\Collection\Aggregations\IArrayAggregator;
 use Nextras\Orm\Collection\Aggregations\IDbalAggregator;
+use Nextras\Orm\Collection\Expression\ExpressionContext;
 use Nextras\Orm\Collection\Functions\Result\ArrayExpressionResult;
 use Nextras\Orm\Collection\Functions\Result\DbalExpressionResult;
 use Nextras\Orm\Collection\Helpers\ArrayCollectionHelper;
@@ -105,6 +106,7 @@ public function processDbalExpression(
 		DbalQueryBuilderHelper $helper,
 		QueryBuilder $builder,
 		array $args,
+		ExpressionContext $context,
 		?IDbalAggregator $aggregator = null,
 	): DbalExpressionResult
 	{
@@ -113,6 +115,7 @@ public function processDbalExpression(
 			helper: $helper,
 			builder: $builder,
 			args: $args,
+			context: $context,
 			aggregator: $aggregator,
 		);
 	}

diff --git a/src/Collection/Functions/DisjunctionOperatorFunction.php b/src/Collection/Functions/DisjunctionOperatorFunction.php
@@ -6,6 +6,7 @@
 use Nextras\Dbal\QueryBuilder\QueryBuilder;
 use Nextras\Orm\Collection\Aggregations\IArrayAggregator;
 use Nextras\Orm\Collection\Aggregations\IDbalAggregator;
+use Nextras\Orm\Collection\Expression\ExpressionContext;
 use Nextras\Orm\Collection\Functions\Result\ArrayExpressionResult;
 use Nextras\Orm\Collection\Functions\Result\DbalExpressionResult;
 use Nextras\Orm\Collection\Helpers\ArrayCollectionHelper;
@@ -98,6 +99,7 @@ public function processDbalExpression(
 		DbalQueryBuilderHelper $helper,
 		QueryBuilder $builder,
 		array $args,
+		ExpressionContext $context,
 		?IDbalAggregator $aggregator = null,
 	): DbalExpressionResult
 	{
@@ -106,6 +108,7 @@ public function processDbalExpression(
 			helper: $helper,
 			builder: $builder,
 			args: $args,
+			context: ExpressionContext::FilterOr,
 			aggregator: $aggregator,
 		);
 	}

diff --git a/src/Collection/Functions/FetchPropertyFunction.php b/src/Collection/Functions/FetchPropertyFunction.php
@@ -10,6 +10,7 @@
 use Nextras\Orm\Collection\Aggregations\IAggregator;
 use Nextras\Orm\Collection\Aggregations\IArrayAggregator;
 use Nextras\Orm\Collection\Aggregations\IDbalAggregator;
+use Nextras\Orm\Collection\Expression\ExpressionContext;
 use Nextras\Orm\Collection\Functions\Result\ArrayExpressionResult;
 use Nextras\Orm\Collection\Functions\Result\DbalExpressionResult;
 use Nextras\Orm\Collection\Functions\Result\DbalTableJoin;
@@ -154,6 +155,7 @@ public function processDbalExpression(
 		DbalQueryBuilderHelper $helper,
 		QueryBuilder $builder,
 		array $args,
+		ExpressionContext $context,
 		?IDbalAggregator $aggregator = null,
 	): DbalExpressionResult
 	{
@@ -257,7 +259,6 @@ private function processTokens(
 			joins: $joins,
 			groupBy: $groupBy,
 			aggregator: $makeDistinct ? ($aggregator ?? new AnyAggregator()) : null,
-			isHavingClause: $makeDistinct,
 			propertyMetadata: $propertyMetadata,
 			valueNormalizer: function ($value) use ($propertyMetadata, $currentConventions) {
 				return $this->normalizeValue($value, $propertyMetadata, $currentConventions);

diff --git a/src/Collection/Functions/JunctionFunctionTrait.php b/src/Collection/Functions/JunctionFunctionTrait.php
@@ -6,6 +6,7 @@
 use Nextras\Dbal\QueryBuilder\QueryBuilder;
 use Nextras\Orm\Collection\Aggregations\IAggregator;
 use Nextras\Orm\Collection\Aggregations\IDbalAggregator;
+use Nextras\Orm\Collection\Expression\ExpressionContext;
 use Nextras\Orm\Collection\Functions\Result\DbalExpressionResult;
 use Nextras\Orm\Collection\Helpers\DbalQueryBuilderHelper;
 use Nextras\Orm\Exception\InvalidArgumentException;
@@ -61,6 +62,7 @@ protected function processQueryBuilderExpressionWithModifier(
 		DbalQueryBuilderHelper $helper,
 		QueryBuilder $builder,
 		array $args,
+		ExpressionContext $context,
 		?IDbalAggregator $aggregator,
 	): DbalExpressionResult
 	{
@@ -77,8 +79,8 @@ protected function processQueryBuilderExpressionWithModifier(
 		}
 
 		foreach ($normalized as $collectionFunctionArgs) {
-			$expression = $helper->processExpression($builder, $collectionFunctionArgs, $aggregator);
-			$expression = $expression->applyAggregator($builder);
+			$expression = $helper->processExpression($builder, $collectionFunctionArgs, $context, $aggregator);
+			$expression = $expression->applyAggregator($builder, $context);
 			$processedArgs[] = $expression->getArgumentsForExpansion();
 			$joins = array_merge($joins, $expression->joins);
 			$groupBy = array_merge($groupBy, $expression->groupBy);

diff --git a/src/Collection/Functions/Result/DbalExpressionResult.php b/src/Collection/Functions/Result/DbalExpressionResult.php
@@ -5,16 +5,20 @@
 
 use Nextras\Dbal\QueryBuilder\QueryBuilder;
 use Nextras\Orm\Collection\Aggregations\IDbalAggregator;
+use Nextras\Orm\Collection\Expression\ExpressionContext;
 use Nextras\Orm\Entity\Reflection\PropertyMetadata;
-use Nextras\Orm\Exception\InvalidArgumentException;
 use function array_unshift;
 use function array_values;
 
 
 /**
- * Represents an SQL expression.
- * This class hold the main expression and its attributes.
- * If possible, also holds a reference to a backing property of the expression.
+ * Represents an SQL expression. This class hold the main expression and its attributes.
+ *
+ * The class is used either in WHERE clause or in HAVING clause, it is decided from the outside of this class,
+ * yet this expression may force its using in HAVING clause by setting {@see $isHavingClause}.
+ *
+ * If possible, the expression holds a reference to a backing property of the expression {@see $propertyMetadata};
+ * this is utilized to provide a value normalization.
  */
 class DbalExpressionResult
 {
@@ -64,6 +68,7 @@ class DbalExpressionResult
 	 */
 	public readonly ?string $dbalModifier;
 
+
 	/**
 	 * @param literal-string $expression
 	 * @param list<mixed> $args
@@ -93,10 +98,6 @@ public function __construct(
 		$this->propertyMetadata = $propertyMetadata;
 		$this->valueNormalizer = $valueNormalizer;
 		$this->dbalModifier = $dbalModifier;
-
-		if ($aggregator !== null && !$isHavingClause) {
-			throw new InvalidArgumentException('Dbal expression with aggregator is expected to be defined as HAVING clause.');
-		}
 	}
 
 
@@ -155,12 +156,8 @@ public function withArgs(string $expression, array $args): DbalExpressionResult
 	/**
 	 * Applies the aggregator and returns modified expression result.
 	 */
-	public function applyAggregator(QueryBuilder $queryBuilder): DbalExpressionResult
+	public function applyAggregator(QueryBuilder $queryBuilder, ExpressionContext $context): DbalExpressionResult
 	{
-		if ($this->aggregator === null) {
-			return $this;
-		}
-
-		return $this->aggregator->aggregateExpression($queryBuilder, $this);
+		return $this->aggregator?->aggregateExpression($queryBuilder, $this, $context) ?? $this;
 	}
 }