Refactor Expression class (#1058)

vjik · web-flow · commit 13e8b4d2c0f5 · 2025-09-04T19:11:43.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -147,6 +147,8 @@
 - Chg #1054: Rename `ArrayExpression` to `ArrayValue`, `JsonExpression` to `JsonValue`,
   `StructuredExpression` to `StructuredValue` (@Tigrov)
 - Chg #1056: Remove unused exceptions (@Tigrov)
+- Chg #1058: Refactor `Expression` class: declare `$expression` and `$params` as public readonly properties, remove 
+  `getParams()` method (@vjik)
 
 ## 1.3.0 March 21, 2024
 
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -280,4 +280,5 @@ Each table column has its own class in the `Yiisoft\Db\Schema\Column` namespace
 - Rename `StructuredExpressionBuilder` to `StructuredValueBuilder` and move it to `Yiisoft\Db\Expression\Value\Builder`
   namespace;
 - Remove `StaleObjectException`, `UnknownMethodException`, `UnknownPropertyException` classes;
+- Remove `Expression::getParams()` method, use `$params` property instead;
 
diff --git a/src/Expression/Expression.php b/src/Expression/Expression.php
@@ -29,10 +29,16 @@
 final class Expression implements ExpressionInterface, Stringable
 {
     /**
+     * @param string $expression The DB expression.
+     * @param array $params List of parameters to bind to this expression. The keys are placeholders appearing in
+     * {@see expression} and the values are the corresponding parameter values.
+     *
      * @psalm-param ParamsType $params
      */
-    public function __construct(private readonly string $expression, private readonly array $params = [])
-    {
+    public function __construct(
+        public readonly string $expression,
+        public readonly array $params = [],
+    ) {
     }
 
     /**
@@ -42,15 +48,4 @@ public function __toString(): string
     {
         return $this->expression;
     }
-
-    /**
-     * @return array List of parameters to bind to this expression. The keys are placeholders appearing in
-     * {@see expression} and the values are the corresponding parameter values.
-     *
-     * @psalm-return ParamsType
-     */
-    public function getParams(): array
-    {
-        return $this->params;
-    }
 }
diff --git a/src/Expression/ExpressionBuilder.php b/src/Expression/ExpressionBuilder.php
@@ -44,8 +44,8 @@ public function __construct(private readonly QueryBuilderInterface $queryBuilder
      */
     public function build(ExpressionInterface $expression, array &$params = []): string
     {
-        $sql = $expression->__toString();
-        $expressionParams = $expression->getParams();
+        $sql = $expression->expression;
+        $expressionParams = $expression->params;
 
         if (empty($expressionParams)) {
             return $sql;
