0 follower

Final Class Yiisoft\Db\Expression\Function\Least

All Classes | Properties | Methods

Inheritance	Yiisoft\Db\Expression\Function\Least » Yiisoft\Db\Expression\Function\MultiOperandFunction
Implements	Yiisoft\Db\Expression\ExpressionInterface

Represents a SQL LEAST() function that returns the least value from a list of values or expressions.

Example usage:

$least = new Least(1, '(a + b)', $db->select('column')->from('table')->where(['id' => 1]));

LEAST(1, (a + b), (SELECT "column" FROM "table" WHERE "id" = 1))

See also Yiisoft\Db\Expression\Function\Builder\LeastBuilder for building SQL representations of this function expression.

Protected Properties

Property	Type	Description	Defined By
$operands	array	List of operands.	Yiisoft\Db\Expression\Function\MultiOperandFunction

Method	Description	Defined By
__construct()		Yiisoft\Db\Expression\Function\MultiOperandFunction
add()		Yiisoft\Db\Expression\Function\MultiOperandFunction
getOperands()		Yiisoft\Db\Expression\Function\MultiOperandFunction

__construct() public method

Defined in: Yiisoft\Db\Expression\Function\MultiOperandFunction::__construct()

public mixed __construct ( mixed $operands )
$operands	mixed	The values or expressions to operate on. String values will be treated as column names, except when they contain a parentheses `(`, in which case they will be treated as raw SQL expressions.

                public function __construct(mixed ...$operands)
{
    $this->operands = $operands;
}

add() public method

Defined in: Yiisoft\Db\Expression\Function\MultiOperandFunction::add()

public Yiisoft\Db\Expression\Function\Least add ( mixed $operand )
$operand	mixed

                public function add(mixed $operand): static
{
    $this->operands[] = $operand;
    return $this;
}

getOperands() public method

Defined in: Yiisoft\Db\Expression\Function\MultiOperandFunction::getOperands()

public array getOperands ( )
return	array	List of operands.

                public function getOperands(): array
{
    return $this->operands;
}