0 follower

Abstract Class Yiisoft\Db\QueryBuilder\Condition\AbstractCompare

All Classes | Properties | Methods
InheritanceYiisoft\Db\QueryBuilder\Condition\AbstractCompare
ImplementsYiisoft\Db\QueryBuilder\Condition\ConditionInterface
SubclassesYiisoft\Db\QueryBuilder\Condition\Equals, Yiisoft\Db\QueryBuilder\Condition\GreaterThan, Yiisoft\Db\QueryBuilder\Condition\GreaterThanOrEqual, Yiisoft\Db\QueryBuilder\Condition\LessThan, Yiisoft\Db\QueryBuilder\Condition\LessThanOrEqual, Yiisoft\Db\QueryBuilder\Condition\NotEquals

Abstract condition that represents comparison operators.

Public Properties

Hide inherited properties

Property Type Description Defined By
$column string|Yiisoft\Db\Expression\ExpressionInterface Yiisoft\Db\QueryBuilder\Condition\AbstractCompare
$value mixed Yiisoft\Db\QueryBuilder\Condition\AbstractCompare

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Db\QueryBuilder\Condition\AbstractCompare
fromArrayDefinition() Creates a condition based on the given operator and operands. Yiisoft\Db\QueryBuilder\Condition\AbstractCompare

Property Details

Hide inherited properties

$column public property
public string|Yiisoft\Db\Expression\ExpressionInterface $column = null
$value public property
public mixed $value = null

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( Yiisoft\Db\Expression\ExpressionInterface|string $column, mixed $value )
$column Yiisoft\Db\Expression\ExpressionInterface|string

The column name or an expression.
$value mixed

The value to compare with.

 

                final public function __construct(
    public readonly string|ExpressionInterface $column,
    public readonly mixed $value,
) {}
fromArrayDefinition() public static method

Creates a condition based on the given operator and operands.

public static Yiisoft\Db\QueryBuilder\Condition\AbstractCompare fromArrayDefinition ( string $operator, array $operands )
$operator string
$operands array
throws InvalidArgumentException 

                final public static function fromArrayDefinition(string $operator, array $operands): static
{
    if (!array_key_exists(0, $operands)) {
        throw new InvalidArgumentException("Operator '$operator' requires first operand as column.");
    }
    if (!array_key_exists(1, $operands)) {
        throw new InvalidArgumentException("Operator '$operator' requires second operand as value.");
    }
    [$column, $value] = $operands;
    if (!is_string($column) && !$column instanceof ExpressionInterface) {
        throw new InvalidArgumentException("Operator '$operator' requires column to be string or ExpressionInterface.");
    }
    return new static($column, $value);
}