Added ->setWhere() as force method ->where() (#944)

lav45 · web-flow · commit 22da3a537bc4 · 2025-04-14T22:05:17.000+07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -74,6 +74,7 @@
 - New #939: Add `caseSensitive` option to like condition (@vjik)
 - New #942: Allow PHP backed enums as values (@Tigrov)
 - Enh #943: Add `getCacheKey()` and `getCacheTag()` methods to `AbstractPdoSchema` class (@Tigrov)
+- Enh #944: Added `setWhere()` as method a forced for overwriting `where()` (@lav45)
 - Enh #925, #951: Add callback to `Query::all()` and `Query::one()` methods (@Tigrov, @vjik)
 - New #954: Add `DbArrayHelper::arrange()` method (@Tigrov)
 - Chg #956: Remove nullable from `PdoConnectionInterface::getActivePdo()` result (@vjik)
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -120,6 +120,7 @@ Each table column has its own class in the `Yiisoft\Db\Schema\Column` namespace
 - `QueryInterface::resultCallback()` - allows to use a callback, to be called on all rows of the query result;
 - `QueryInterface::getResultCallback()` - returns the callback to be called on all rows of the query result or 
   `null` if the callback is not set;
+- `QueryPartsInterface::setWhere()` - overwrites the `WHERE` part of the query;
 - `ConnectionInterface::getColumnFactory()` - returns the column factory object for concrete DBMS;
 - `ConnectionInterface::getServerInfo()` - returns `ServerInfoInterface` instance which provides server information;
 - `QueryBuilderInterface::buildColumnDefinition()` - builds column definition for `CREATE TABLE` statement;
diff --git a/src/Query/Query.php b/src/Query/Query.php
@@ -5,6 +5,7 @@
 namespace Yiisoft\Db\Query;
 
 use Closure;
+use LogicException;
 use Throwable;
 use Yiisoft\Db\Command\CommandInterface;
 use Yiisoft\Db\Connection\ConnectionInterface;
@@ -694,6 +695,17 @@ public function union(QueryInterface|string $sql, bool $all = false): static
     }
 
     public function where(array|string|ExpressionInterface|null $condition, array $params = []): static
+    {
+        if ($this->where === null) {
+            $this->where = $condition;
+        } else {
+            throw new LogicException('The `where` condition was set earlier. Use the `setWhere()`, `andWhere()` or `orWhere()` method.');
+        }
+        $this->addParams($params);
+        return $this;
+    }
+
+    public function setWhere(array|string|ExpressionInterface|null $condition, array $params = []): static
     {
         $this->where = $condition;
         $this->addParams($params);
diff --git a/src/Query/QueryPartsInterface.php b/src/Query/QueryPartsInterface.php
@@ -5,6 +5,7 @@
 namespace Yiisoft\Db\Query;
 
 use Closure;
+use LogicException;
 use Yiisoft\Db\Connection\ConnectionInterface;
 use Yiisoft\Db\Exception\NotSupportedException;
 use Yiisoft\Db\Expression\ExpressionInterface;
@@ -580,7 +581,7 @@ public function setUnions(array $value): static;
     public function union(QueryInterface|string $sql, bool $all = false): static;
 
     /**
-     * Sets the `WHERE` part of the query.
+     * Initially sets the `WHERE` part of the query.
      *
      * The `$condition` specified as an array can be in one of the following two formats:
      *
@@ -671,11 +672,25 @@ public function union(QueryInterface|string $sql, bool $all = false): static;
      *
      * @psalm-param ParamsType $params
      *
+     * @throws LogicException If `where` was set previously.
+     *
      * @see andWhere()
      * @see orWhere()
      */
     public function where(array|string|ExpressionInterface|null $condition, array $params = []): static;
 
+    /**
+     * Overwrites the `WHERE` part of the query.
+     *
+     * @param array|ExpressionInterface|string|null $condition The conditions to put in the `WHERE` part.
+     * @param array $params The parameters (name => value) to bind to the query.
+     *
+     * @psalm-param ParamsType $params
+     *
+     * @see where()
+     */
+    public function setWhere(array|string|ExpressionInterface|null $condition, array $params = []): static;
+
     /**
      * Prepends an SQL statement using `WITH` syntax.
      *
diff --git a/tests/AbstractQueryBuilderTest.php b/tests/AbstractQueryBuilderTest.php
@@ -6,6 +6,7 @@
 
 use Closure;
 use JsonException;
+use LogicException;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\DataProviderExternal;
 use PHPUnit\Framework\TestCase;
@@ -306,7 +307,7 @@ public function testBuildIssue15653(): void
 
         $qb = $db->getQueryBuilder();
         $query = (new Query($db))->from('admin_user')->where(['is_deleted' => false]);
-        $query->where([])->andWhere(['in', 'id', ['1', '0']]);
+        $query->setWhere([])->andWhere(['in', 'id', ['1', '0']]);
 
         [$sql, $params] = $qb->build($query);
 
@@ -474,6 +475,28 @@ public function testBuildLikeCondition(
         }
     }
 
+    /**
+     * @throws LogicException
+     */
+    public function testOverwriteWhereCondition(): void
+    {
+        $db = $this->getConnection();
+
+        try {
+            (new Query($db))
+                ->where(['like', 'name', 'foo%'])
+                ->where(['not like', 'name', 'foo%']);
+        } catch (LogicException $e) {
+            $this->assertEquals('The `where` condition was set earlier. Use the `setWhere()`, `andWhere()` or `orWhere()` method.', $e->getMessage());
+        }
+
+        $query = (new Query($db))
+            ->where(['like', 'name', 'foo%'])
+            ->setWhere(['not like', 'name', 'foo%']);
+
+        $this->assertEquals(['not like', 'name', 'foo%'], $query->getWhere());
+    }
+
     public function testBuildLimit(): void
     {
         $db = $this->getConnection();
