Class yii\db\conditions\InCondition
| Inheritance | yii\db\conditions\InCondition |
|---|---|
| Implements | yii\db\conditions\ConditionInterface |
| Available since version | 2.0.14 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/db/conditions/InCondition.php |
Class InCondition represents IN condition.
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __construct() | SimpleCondition constructor | yii\db\conditions\InCondition |
| fromArrayDefinition() | Creates object by array-definition as described in Query Builder – Operator format guide article. | yii\db\conditions\InCondition |
| getColumn() | yii\db\conditions\InCondition | |
| getOperator() | yii\db\conditions\InCondition | |
| getValues() | yii\db\conditions\InCondition |
Method Details
SimpleCondition constructor
| public void __construct ( $column, $operator, $values ) | ||
| $column | ||
| $operator | string |
The operator to use (e.g. |
| $values | ||
public function __construct($column, $operator, $values)
{
$this->column = $column;
$this->operator = $operator;
$this->values = $values;
}
Creates object by array-definition as described in Query Builder – Operator format guide article.
| public static $this fromArrayDefinition ( $operator, $operands ) | ||
| $operator | string |
Operator in uppercase. |
| $operands | array |
Array of corresponding operands |
| throws | yii\base\InvalidArgumentException |
if wrong number of operands have been given. |
|---|---|---|
public static function fromArrayDefinition($operator, $operands)
{
if (!isset($operands[0], $operands[1])) {
throw new InvalidArgumentException("Operator '$operator' requires two operands.");
}
return new static($operands[0], $operator, $operands[1]);
}
| public yii\db\ExpressionInterface[]|string[]|integer[] getValues ( ) |
public function getValues()
{
return $this->values;
}