0 follower

Abstract Class Yiisoft\Db\Expression\Function\MultiOperandFunction

InheritanceYiisoft\Db\Expression\Function\MultiOperandFunction
ImplementsYiisoft\Db\Expression\ExpressionInterface
SubclassesYiisoft\Db\Expression\Function\ArrayMerge, Yiisoft\Db\Expression\Function\Greatest, Yiisoft\Db\Expression\Function\Least, Yiisoft\Db\Expression\Function\Longest, Yiisoft\Db\Expression\Function\Shortest

Base class for functions that operate on multiple operands with the same type.

It provides methods to add operands and retrieve them.

See also Yiisoft\Db\Expression\Function\Builder\MultiOperandFunctionBuilder base class for building SQL representation of multi-operand function expressions.

Protected Properties

Hide inherited properties

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

Property Details

Hide inherited properties

$operands protected property

List of operands.

protected array $operands = []

Method Details

Hide inherited methods

__construct() public method

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

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

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

            
getOperands() public method

public array getOperands ( )
return array

List of operands.

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