Class yii\db\conditions\InConditionBuilder
| Inheritance | yii\db\conditions\InConditionBuilder |
|---|---|
| Implements | yii\db\ExpressionBuilderInterface |
| Uses Traits | yii\db\ExpressionBuilderTrait |
| Subclasses | yii\db\mssql\conditions\InConditionBuilder, yii\db\oci\conditions\InConditionBuilder, yii\db\sqlite\conditions\InConditionBuilder |
| Available since version | 2.0.14 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/db/conditions/InConditionBuilder.php |
Class InConditionBuilder builds objects of yii\db\conditions\InCondition
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $queryBuilder | yii\db\QueryBuilder | yii\db\ExpressionBuilderTrait |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __construct() | ExpressionBuilderTrait constructor. | yii\db\ExpressionBuilderTrait |
| build() | Method builds the raw SQL from the $expression that will not be additionally escaped or quoted. | yii\db\conditions\InConditionBuilder |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| buildCompositeInCondition() | Builds SQL for IN condition. | yii\db\conditions\InConditionBuilder |
| buildSubqueryInCondition() | Builds SQL for IN condition. | yii\db\conditions\InConditionBuilder |
| buildValues() | Builds $values to be used in yii\db\conditions\InCondition | yii\db\conditions\InConditionBuilder |
| getNullCondition() | Builds is null/is not null condition for column based on operator | yii\db\conditions\InConditionBuilder |
| getRawValuesFromTraversableObject() | yii\db\conditions\InConditionBuilder |
Method Details
Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.
| public string build ( yii\db\ExpressionInterface $expression, array &$params = [] ) | ||
| $expression | yii\db\ExpressionInterface|yii\db\conditions\InCondition | The expression to be built. |
| $params | array | The binding parameters. |
| return | string | The raw SQL that will not be additionally escaped or quoted. |
|---|---|---|
Builds SQL for IN condition.
| protected string buildCompositeInCondition ( $operator, $columns, $values, &$params ) | ||
| $operator | string | |
| $columns | array|Traversable | |
| $values | array | |
| $params | array | |
| return | string | SQL |
|---|---|---|
Builds SQL for IN condition.
| protected string buildSubqueryInCondition ( $operator, $columns, $values, &$params ) | ||
| $operator | string | |
| $columns | array|string | |
| $values | yii\db\Query | |
| $params | array | |
| return | string | SQL |
|---|---|---|
Builds $values to be used in yii\db\conditions\InCondition
| protected array buildValues ( yii\db\conditions\ConditionInterface $condition, $values, &$params ) | ||
| $condition | yii\db\conditions\ConditionInterface|yii\db\conditions\InCondition | |
| $values | array | |
| $params | array | The binding parameters |
| return | array | Of prepared for SQL placeholders |
|---|---|---|
Builds is null/is not null condition for column based on operator
| protected string getNullCondition ( $operator, $column ) | ||
| $operator | string | |
| $column | string | |
| return | string | Is null or is not null condition |
|---|---|---|
| protected array getRawValuesFromTraversableObject ( Traversable $traversableObject ) | ||
| $traversableObject | Traversable | |
| return | array | Raw values |
|---|---|---|