0 follower

Final Class Yiisoft\Db\Expression\Function\Shortest

All Classes | Properties | Methods
InheritanceYiisoft\Db\Expression\Function\Shortest » Yiisoft\Db\Expression\Function\MultiOperandFunction
ImplementsYiisoft\Db\Expression\ExpressionInterface

Represents SQL expression that returns the shortest string from a list of operands.

This function compares the lengths of the provided strings or expressions and returns the shortest one. If multiple strings have the same minimum length, it returns the first one encountered.

Example usage:

$shortest = new Shortest(new Value('short'), 'column_name');

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

Protected Properties

Hide inherited properties

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

Public Methods

Hide inherited methods

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

Method Details

Hide inherited methods

__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\Shortest 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;
}