BetweenColumnsCondition

API reference › yii › db › conditions › BetweenColumnsCondition

class	`yii\db\conditions\BetweenColumnsCondition`
Implements	`ConditionInterface`
Since	2.0.14
Source	`framework/db/conditions/BetweenColumnsCondition.php`

Class BetweenColumnCondition represents a BETWEEN condition where values is between two columns. For example:

new BetweenColumnsCondition(42, 'BETWEEN', 'min_value', 'max_value')
// Will be build to:
// 42 BETWEEN min_value AND max_value

And a more complex example:

new BetweenColumnsCondition(
   new Expression('NOW()'),
   'NOT BETWEEN',
   (new Query)->select('time')->from('log')->orderBy('id ASC')->limit(1),
   'update_time'
);

// Will be built to:
// NOW() NOT BETWEEN (SELECT time FROM log ORDER BY id ASC LIMIT 1) AND update_time

Methods

Method	Description	Defined by
`__construct()`	Creates a condition with the `BETWEEN` operator.	`BetweenColumnsCondition`
`fromArrayDefinition()` static	Creates object by array-definition as described in Query Builder – Operator format guide article.	`BetweenColumnsCondition`
`getIntervalEndColumn()`		`BetweenColumnsCondition`
`getIntervalStartColumn()`		`BetweenColumnsCondition`
`getOperator()`		`BetweenColumnsCondition`
`getValue()`		`BetweenColumnsCondition`

Method details

__construct()

public function __construct(mixed $value, string $operator, string|yii\db\ExpressionInterface $intervalStartColumn, string|yii\db\ExpressionInterface $intervalEndColumn)

Creates a condition with the BETWEEN operator.

Parameters

Parameter	Type	Description
`$value`	`mixed`	The value to compare against
`$operator`	`string`	The operator to use (e.g. `BETWEEN` or `NOT BETWEEN`)
`$intervalStartColumn`	`string\|yii\db\ExpressionInterface`	The column name or expression that is a beginning of the interval
`$intervalEndColumn`	`string\|yii\db\ExpressionInterface`	The column name or expression that is an end of the interval

fromArrayDefinition()

public static function fromArrayDefinition(mixed $operator, mixed $operands): static

Creates object by array-definition as described in Query Builder – Operator format guide article.

Parameters

Parameter	Type	Description
`$operator`	`mixed`	Operator in uppercase.
`$operands`	`mixed`	Array of corresponding operands

Returns

static

Throws

yii\base\InvalidArgumentException: if wrong number of operands have been given.

getIntervalEndColumn()

public function getIntervalEndColumn(): string|yii\db\ExpressionInterface|yii\db\Query

Returns

string|yii\db\ExpressionInterface|yii\db\Query

getIntervalStartColumn()

public function getIntervalStartColumn(): string|yii\db\ExpressionInterface|yii\db\Query

Returns

string|yii\db\ExpressionInterface|yii\db\Query

getOperator()

public function getOperator(): string

Returns

string

getValue()

public function getValue(): mixed

Returns

mixed