Merge pull request #63212 from nextcloud/carl/orderby-sortdirection

feat(db): Add support for SortDirection to addSortBy and sortBy

lib/private/DB/QueryBuilder/ExtendedQueryBuilder.php

@@ -10,7 +10,10 @@ namespace OC\DB\QueryBuilder;
 
 use OCP\DB\IResult;
 use OCP\DB\QueryBuilder\ConflictResolutionMode;
+use OCP\DB\QueryBuilder\ILiteral;
+use OCP\DB\QueryBuilder\IParameter;
 use OCP\DB\QueryBuilder\IQueryBuilder;
+use OCP\DB\QueryBuilder\IQueryFunction;
 use OCP\IDBConnection;
 
 /**
@@ -251,13 +254,13 @@ abstract class ExtendedQueryBuilder extends TypedQueryBuilder {
 	}
 
 	#[\Override]
-	public function orderBy($sort, $order = null) {
+	public function orderBy(string|ILiteral|IParameter|IQueryFunction $sort, string|\SortDirection|null $order = null): self {
 		$this->builder->orderBy($sort, $order);
 		return $this;
 	}
 
 	#[\Override]
-	public function addOrderBy($sort, $order = null) {
+	public function addOrderBy(string|ILiteral|IParameter|IQueryFunction $sort, string|\SortDirection|null $order = null): self {
 		$this->builder->addOrderBy($sort, $order);
 		return $this;
 	}

lib/private/DB/QueryBuilder/QueryBuilder.php

@@ -1115,19 +1115,14 @@ class QueryBuilder extends TypedQueryBuilder {
 		return $this;
 	}
 
-	/**
-	 * Specifies an ordering for the query results.
-	 * Replaces any previously specified orderings, if any.
-	 *
-	 * @param string|IQueryFunction|ILiteral|IParameter $sort The ordering expression.
-	 * @param string $order The ordering direction.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
 	#[\Override]
-	public function orderBy($sort, $order = null) {
-		if ($order !== null && !in_array(strtoupper((string)$order), ['ASC', 'DESC'], true)) {
-			$order = null;
+	public function orderBy(string|ILiteral|IParameter|IQueryFunction $sort, string|\SortDirection|null $order = null): self {
+		if ($order === \SortDirection::Ascending) {
+			$order = 'ASC';
+		} elseif ($order === \SortDirection::Descending) {
+			$order = 'DESC';
+		} elseif ($order !== null && !in_array(strtoupper($order), ['ASC', 'DESC'], true)) {
+			throw new \InvalidArgumentException('Only ASC or DESC are supported');
 		}
 
 		$this->queryBuilder->orderBy(
@@ -1138,18 +1133,14 @@ class QueryBuilder extends TypedQueryBuilder {
 		return $this;
 	}
 
-	/**
-	 * Adds an ordering to the query results.
-	 *
-	 * @param string|ILiteral|IParameter|IQueryFunction $sort The ordering expression.
-	 * @param string $order The ordering direction.
-	 *
-	 * @return $this This QueryBuilder instance.
-	 */
 	#[\Override]
-	public function addOrderBy($sort, $order = null) {
-		if ($order !== null && !in_array(strtoupper((string)$order), ['ASC', 'DESC'], true)) {
-			$order = null;
+	public function addOrderBy(string|ILiteral|IParameter|IQueryFunction $sort, string|\SortDirection|null $order = null): self {
+		if ($order === \SortDirection::Ascending) {
+			$order = 'ASC';
+		} elseif ($order === \SortDirection::Descending) {
+			$order = 'DESC';
+		} elseif ($order !== null && !in_array(strtoupper($order), ['ASC', 'DESC'], true)) {
+			throw new \InvalidArgumentException('Only ASC or DESC are supported');
 		}
 
 		$this->queryBuilder->addOrderBy(

lib/private/DB/QueryBuilder/Sharded/ShardedQueryBuilder.php

@@ -12,7 +12,10 @@ use OC\DB\QueryBuilder\CompositeExpression;
 use OC\DB\QueryBuilder\ExtendedQueryBuilder;
 use OC\DB\QueryBuilder\Parameter;
 use OCP\DB\IResult;
+use OCP\DB\QueryBuilder\ILiteral;
+use OCP\DB\QueryBuilder\IParameter;
 use OCP\DB\QueryBuilder\IQueryBuilder;
+use OCP\DB\QueryBuilder\IQueryFunction;
 use OCP\IDBConnection;
 
 /**
@@ -295,24 +298,34 @@ class ShardedQueryBuilder extends ExtendedQueryBuilder {
 	}
 
 	#[\Override]
-	public function addOrderBy($sort, $order = null) {
-		if ($order !== null && !in_array(strtoupper((string)$order), ['ASC', 'DESC'], true)) {
-			$order = null;
+	public function addOrderBy(string|ILiteral|IParameter|IQueryFunction $sort, string|\SortDirection|null $order = null): self {
+		if ($order === \SortDirection::Ascending) {
+			$order = 'ASC';
+		} elseif ($order === \SortDirection::Descending) {
+			$order = 'DESC';
+		} elseif ($order !== null && !in_array(strtoupper($order), ['ASC', 'DESC'], true)) {
+			throw new \InvalidArgumentException('Only ASC or DESC are supported');
 		}
 
-		$this->registerOrder((string)$sort, (string)($order ?? 'ASC'));
-		return parent::addOrderBy($sort, $order);
+		$this->registerOrder((string)$sort, $order ?? 'ASC');
+		parent::addOrderBy($sort, $order);
+		return $this;
 	}
 
 	#[\Override]
-	public function orderBy($sort, $order = null) {
-		if ($order !== null && !in_array(strtoupper((string)$order), ['ASC', 'DESC'], true)) {
-			$order = null;
+	public function orderBy(string|ILiteral|IParameter|IQueryFunction $sort, string|\SortDirection|null $order = null): self {
+		if ($order === \SortDirection::Ascending) {
+			$order = 'ASC';
+		} elseif ($order === \SortDirection::Descending) {
+			$order = 'DESC';
+		} elseif ($order !== null && !in_array(strtoupper($order), ['ASC', 'DESC'], true)) {
+			throw new \InvalidArgumentException('Only ASC or DESC are supported');
 		}
 
 		$this->sortList = [];
-		$this->registerOrder((string)$sort, (string)($order ?? 'ASC'));
-		return parent::orderBy($sort, $order);
+		$this->registerOrder((string)$sort, $order ?? 'ASC');
+		parent::orderBy($sort, $order);
+		return $this;
 	}
 
 	private function registerOrder(string $column, string $order): void {

lib/public/AppFramework/ORM/Repository.php

@@ -478,7 +478,7 @@ class Repository {
 
 		foreach ($orderBy as $field => $direction) {
 			$column = $entityInfo->mappingPropertyToColumn[$field];
-			$qb->addOrderBy('e.' . $column, $direction === \SortDirection::Ascending ? 'ASC' : 'DESC');
+			$qb->addOrderBy('e.' . $column, $direction);
 		}
 
 		return [$qb, $relations];

lib/public/DB/QueryBuilder/IQueryBuilder.php

@@ -857,7 +857,7 @@ interface IQueryBuilder {
 	 * Replaces any previously specified orderings, if any.
 	 *
 	 * @param string|IQueryFunction|ILiteral|IParameter $sort The ordering expression.
-	 * @param string $order The ordering direction.
+	 * @param 'ASC'|'DESC'|'asc'|'desc'|\SortDirection|null $order The ordering direction.
 	 *
 	 * @return $this This QueryBuilder instance.
 	 * @since 8.2.0
@@ -865,13 +865,13 @@ interface IQueryBuilder {
 	 * @psalm-taint-sink sql $sort
 	 * @psalm-taint-sink sql $order
 	 */
-	public function orderBy($sort, $order = null);
+	public function orderBy(string|ILiteral|IParameter|IQueryFunction $sort, string|\SortDirection|null $order = null): self;
 
 	/**
 	 * Adds an ordering to the query results.
 	 *
 	 * @param string|ILiteral|IParameter|IQueryFunction $sort The ordering expression.
-	 * @param string $order The ordering direction.
+	 * @param 'ASC'|'DESC'|'asc'|'desc'|\SortDirection|null $order The ordering direction.
 	 *
 	 * @return $this This QueryBuilder instance.
 	 * @since 8.2.0
@@ -879,7 +879,7 @@ interface IQueryBuilder {
 	 * @psalm-taint-sink sql $sort
 	 * @psalm-taint-sink sql $order
 	 */
-	public function addOrderBy($sort, $order = null);
+	public function addOrderBy(string|ILiteral|IParameter|IQueryFunction $sort, string|\SortDirection|null $order = null): self;
 
 	/**
 	 * Gets a query part by its name.

lib/public/DB/QueryBuilder/ITypedQueryBuilder.php

@@ -293,20 +293,18 @@ interface ITypedQueryBuilder extends IQueryBuilder {
 	/**
 	 * @inheritDoc
 	 * @return $this
-	 * @psalm-suppress MissingParamType
 	 * @since 34.0.0
 	 */
 	#[Override]
-	public function orderBy($sort, $order = null);
+	public function orderBy(string|ILiteral|IParameter|IQueryFunction $sort, string|\SortDirection|null $order = null): self;
 
 	/**
 	 * @inheritDoc
 	 * @return $this
-	 * @psalm-suppress MissingParamType
 	 * @since 34.0.0
 	 */
 	#[Override]
-	public function addOrderBy($sort, $order = null);
+	public function addOrderBy(string|ILiteral|IParameter|IQueryFunction $sort, string|\SortDirection|null $order = null): self;
 
 	/**
 	 * @inheritDoc