Yiisoft\Db\Expression\Expression

Complexity

Total Complexity

3

Size/Duplication

Total Lines	26
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__toString()	0	3	1
A	getParams()	0	3	1
A	__construct()	0	2	1

<?php

declare(strict_types=1);

namespace Yiisoft\Db\Expression;

use Stringable;
use Yiisoft\Db\Connection\ConnectionInterface;

/**
 * Represents a DB expression that doesn't need escaping or quoting.
 *
 * When an Expression object is embedded within a SQL statement or fragment, it will be replaced with the
 * {@see expression} property value without any DB escaping or quoting.
 *
 * For example,
 *
 * ```php
 * $expression = new Expression('NOW()');
 * $now = (new \Yiisoft\Db\Query\Query)->select($expression)->scalar();  // SELECT NOW();
 * echo $now; // prints the current date
 * ```
 *
 * Expression objects are mainly created for passing raw SQL expressions to methods of
 * {@see \Yiisoft\Db\Query\QueryInterface} and related classes.
 *
 * @psalm-import-type ParamsType from ConnectionInterface
 */
class Expression implements ExpressionInterface, Stringable
{
    /**
     * @psalm-param ParamsType $params
     */
    public function __construct(private string $expression, private array $params = [])
    {
    }

    /**
     * @return string The expression.
     */
    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;
    }
}