# Class yii\db\ActiveQuery

Inheritance | yii\db\ActiveQuery » yii\db\Query » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable, yii\db\ActiveQueryInterface, yii\db\ExpressionInterface, yii\db\QueryInterface
Uses Traits | yii\db\ActiveQueryTrait, yii\db\ActiveRelationTrait, yii\db\QueryTrait
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQuery.php

ActiveQuery represents a DB query associated with an Active Record class.

An ActiveQuery can be a normal query or be used in a relational context.

ActiveQuery instances are usually created by yii\db\ActiveRecord::find() and yii\db\ActiveRecord::findBySql(). Relational queries are created by yii\db\ActiveRecord::hasOne() and yii\db\ActiveRecord::hasMany().

## Normal Query ¶

ActiveQuery mainly provides the following methods to retrieve the query results:

- one(): returns a single record populated with the first row of data.
- all(): returns all records based on the query results.
- count(): returns the number of records.
- sum(): returns the sum over the specified column.
- average(): returns the average over the specified column.
- min(): returns the min over the specified column.
- max(): returns the max over the specified column.
- scalar(): returns the value of the first column in the first row of the query result.
- column(): returns the value of the first column in the query result.
- exists(): returns a value indicating whether the query result has data or not.

Because ActiveQuery extends from yii\db\Query, one can use query methods, such as where(), orderBy() to customize the query options.

ActiveQuery also provides the following additional query options:

- with(): list of relations that this query should be performed with.
- joinWith(): reuse a relation query definition to add a join to a query.
- indexBy(): the name of the column by which the query result should be indexed.
- asArray(): whether to return each record as an array.

These options can be configured using methods of the same name. For example:

    $customers = Customer::find()->with('orders')->asArray()->all();

## Relational query ¶

In relational context ActiveQuery represents a relation between two Active Record classes.

Relational ActiveQuery instances are usually created by calling yii\db\ActiveRecord::hasOne() and yii\db\ActiveRecord::hasMany(). An Active Record class declares a relation by defining a getter method which calls one of the above methods and returns the created ActiveQuery object.

A relation is specified by $link which represents the association between columns of different tables; and the multiplicity of the relation is indicated by $multiple.

If a relation involves a junction table, it may be specified by via() or viaTable() method. These methods may only be called in a relational context. Same is true for inverseOf(), which marks a relation as inverse of another relation and onCondition() which adds a condition that is to be added to relational query join condition.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$asArray | boolean | Whether to return each record as an array. | yii\db\ActiveQueryTrait
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. | yii\base\Component
$distinct | boolean | Whether to select distinct rows of data only. | yii\db\Query
$emulateExecution | boolean | Whether to emulate the actual query execution, returning empty or false results. | yii\db\QueryTrait
$from | array|null | The table(s) to be selected from. | yii\db\Query
$groupBy | array|null | How to group the query results. | yii\db\Query
$having | string|array|yii\db\ExpressionInterface|null | The condition to be applied in the GROUP BY clause. | yii\db\Query
$indexBy | string|callable|null | The name of the column by which the query results should be indexed by. | yii\db\QueryTrait
$inverseOf | string | The name of the relation that is the inverse of this relation. | yii\db\ActiveRelationTrait
$join | array|null | How to join with other tables. | yii\db\Query
$joinWith | array|null | A list of relations that this query should be joined with | yii\db\ActiveQuery
$limit | integer|yii\db\ExpressionInterface|null | Maximum number of records to be returned. | yii\db\QueryTrait
$link | array | The columns of the primary and foreign tables that establish a relation. | yii\db\ActiveRelationTrait
$modelClass | string | The name of the ActiveRecord class. | yii\db\ActiveQueryTrait
$multiple | boolean | Whether this query represents a relation to more than one record. | yii\db\ActiveRelationTrait
$offset | integer|yii\db\ExpressionInterface|null | Zero-based offset from where the records are to be returned. | yii\db\QueryTrait
$on | string|array|null | The join condition to be used when this query is used in a relational context. | yii\db\ActiveQuery
$orderBy | array|null | How to sort the query results. | yii\db\QueryTrait
$params | array|null | List of query parameter values indexed by parameter placeholders. | yii\db\Query
$primaryModel | yii\db\ActiveRecord | The primary model of a relational query. | yii\db\ActiveRelationTrait
$queryCacheDependency | yii\caching\Dependency|null | The dependency to be associated with the cached query result for this query | yii\db\Query
$queryCacheDuration | integer|boolean|null | The default number of seconds that query results can remain valid in cache. | yii\db\Query
$select | array|null | The columns being selected. | yii\db\Query
$selectOption | string|null | Additional option that should be appended to the 'SELECT' keyword. | yii\db\Query
$sql | string|null | The SQL statement to be executed for retrieving AR records. | yii\db\ActiveQuery
$tablesUsedInFrom | string[] | Table names indexed by aliases. | yii\db\Query
$union | array|null | This is used to construct the UNION clause(s) in a SQL statement. | yii\db\Query
$via | array|object | The query associated with the junction table. | yii\db\ActiveRelationTrait
$where | string|array|yii\db\ExpressionInterface|null | Query condition. | yii\db\QueryTrait
$with | array | A list of relations that this query should be performed with | yii\db\ActiveQueryTrait
$withQueries | array|null | This is used to construct the WITH section in a SQL query. | yii\db\Query

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\Component
__clone() | Clones internal objects. | yii\db\ActiveRelationTrait
__construct() | Constructor. | yii\db\ActiveQuery
__get() | Returns the value of a component property. | yii\base\Component
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component
__set() | Sets the value of a component property. | yii\base\Component
__toString() | Returns the SQL representation of Query | yii\db\Query
__unset() | Sets a component property to be null. | yii\base\Component
addGroupBy() | Adds additional group-by columns to the existing ones. | yii\db\Query
addOrderBy() | Adds additional ORDER BY columns to the query. | yii\db\QueryTrait
addParams() | Adds additional parameters to be bound to the query. | yii\db\Query
addSelect() | Add more columns to the SELECT part of the query. | yii\db\Query
alias() | Define an alias for the table defined in $modelClass. | yii\db\ActiveQuery
all() | Executes query and returns all results as an array. | yii\db\ActiveQuery
andFilterCompare() | Adds a filtering condition for a specific column and allow the user to choose a filter operator. | yii\db\Query
andFilterHaving() | Adds an additional HAVING condition to the existing one but ignores empty operands. | yii\db\Query
andFilterWhere() | Adds an additional WHERE condition to the existing one but ignores empty operands. | yii\db\QueryTrait
andHaving() | Adds an additional HAVING condition to the existing one. | yii\db\Query
andOnCondition() | Adds an additional ON condition to the existing one. | yii\db\ActiveQuery
andWhere() | Adds an additional WHERE condition to the existing one. | yii\db\QueryTrait
asArray() | Sets the asArray() property. | yii\db\ActiveQueryTrait
attachBehavior() | Attaches a behavior to this component. | yii\base\Component
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component
average() | Returns the average of the specified column values. | yii\db\Query
batch() | Starts a batch query. | yii\db\Query
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component
cache() | Enables query cache for this Query. | yii\db\Query
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
column() | Executes the query and returns the first column of the result. | yii\db\Query
count() | Returns the number of records. | yii\db\Query
create() | Creates a new Query object and copies its property values from an existing one. | yii\db\Query
createCommand() | Creates a DB command that can be used to execute this query. | yii\db\ActiveQuery
detachBehavior() | Detaches a behavior from the component. | yii\base\Component
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component
distinct() | Sets the value indicating whether to SELECT DISTINCT or not. | yii\db\Query
each() | Starts a batch query and retrieves data row by row. | yii\db\Query
emulateExecution() | Sets whether to emulate query execution, preventing any interaction with data storage. | yii\db\QueryTrait
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component
exists() | Returns a value indicating whether the query result contains any row of data. | yii\db\Query
filterHaving() | Sets the HAVING part of the query but ignores empty operands. | yii\db\Query
filterWhere() | Sets the WHERE part of the query but ignores empty operands. | yii\db\QueryTrait
findFor() | Finds the related records for the specified primary record. | yii\db\ActiveRelationTrait
findWith() | Finds records corresponding to one or multiple relations and populates them into the primary models. | yii\db\ActiveQueryTrait
from() | Sets the FROM part of the query. | yii\db\Query
getBehavior() | Returns the named behavior object. | yii\base\Component
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component
getTablesUsedInFrom() | Returns table names used in from() indexed by aliases. | yii\db\ActiveQuery
groupBy() | Sets the GROUP BY part of the query. | yii\db\Query
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component
having() | Sets the HAVING part of the query. | yii\db\Query
indexBy() | Sets the indexBy() property. | yii\db\QueryTrait
init() | Initializes the object. | yii\db\ActiveQuery
innerJoin() | Appends an INNER JOIN part to the query. | yii\db\Query
innerJoinWith() | Inner joins with the specified relations. | yii\db\ActiveQuery
inverseOf() | Sets the name of the relation that is the inverse of this relation. | yii\db\ActiveRelationTrait
join() | Appends a JOIN part to the query. | yii\db\Query
joinWith() | Joins with the specified relations. | yii\db\ActiveQuery
leftJoin() | Appends a LEFT OUTER JOIN part to the query. | yii\db\Query
limit() | Sets the LIMIT part of the query. | yii\db\QueryTrait
max() | Returns the maximum of the specified column values. | yii\db\Query
min() | Returns the minimum of the specified column values. | yii\db\Query
noCache() | Disables query cache for this Query. | yii\db\Query
off() | Detaches an existing event handler from this component. | yii\base\Component
offset() | Sets the OFFSET part of the query. | yii\db\QueryTrait
on() | Attaches an event handler to an event. | yii\base\Component
onCondition() | Sets the ON condition for a relational query. | yii\db\ActiveQuery
one() | Executes query and returns a single row of result. | yii\db\ActiveQuery
orFilterHaving() | Adds an additional HAVING condition to the existing one but ignores empty operands. | yii\db\Query
orFilterWhere() | Adds an additional WHERE condition to the existing one but ignores empty operands. | yii\db\QueryTrait
orHaving() | Adds an additional HAVING condition to the existing one. | yii\db\Query
orOnCondition() | Adds an additional ON condition to the existing one. | yii\db\ActiveQuery
orWhere() | Adds an additional WHERE condition to the existing one. | yii\db\QueryTrait
orderBy() | Sets the ORDER BY part of the query. | yii\db\QueryTrait
params() | Sets the parameters to be bound to the query. | yii\db\Query
populate() | Converts the raw query results into the format as specified by this query. | yii\db\ActiveQuery
populateRelation() | Finds the related records and populates them into the primary models. | yii\db\ActiveRelationTrait
prepare() | Prepares for building SQL. | yii\db\ActiveQuery
rightJoin() | Appends a RIGHT OUTER JOIN part to the query. | yii\db\Query
scalar() | Returns the query result as a scalar value. | yii\db\Query
select() | Sets the SELECT part of the query. | yii\db\Query
sum() | Returns the sum of the specified column values. | yii\db\Query
trigger() | Triggers an event. | yii\base\Component
union() | Appends a SQL statement using UNION operator. | yii\db\Query
via() | Specifies the relation associated with the junction table. | yii\db\ActiveRelationTrait
viaTable() | Specifies the junction table for a relational query. | yii\db\ActiveQuery
where() | Sets the WHERE part of the query. | yii\db\QueryTrait
with() | Specifies the relations with which this query should be performed. | yii\db\ActiveQueryTrait
withQuery() | Prepends a SQL statement using WITH syntax. | yii\db\Query

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
cleanUpTableNames() | Clean up table names and aliases Both aliases and names are enclosed into {{ and }}. | yii\db\Query
createModels() | Converts found rows into model instances. | yii\db\ActiveQueryTrait
filterCondition() | Removes empty operands from the given query condition. | yii\db\QueryTrait
getPrimaryTableName() |  | yii\db\ActiveQuery
getTableNameAndAlias() | Returns the table name and the table alias for $modelClass. | yii\db\ActiveQuery
getUnaliasedColumnsFromSelect() |  | yii\db\Query
getUniqueColumns() | Returns unique column names excluding duplicates. | yii\db\Query
isEmpty() | Returns a value indicating whether the give value is "empty". | yii\db\QueryTrait
normalizeOrderBy() | Normalizes format of ORDER BY data. | yii\db\QueryTrait
normalizeSelect() | Normalizes the SELECT columns passed to select() or addSelect(). | yii\db\Query
queryScalar() | Queries a scalar value by setting select() first. | yii\db\ActiveQuery
setCommandCache() | Sets $command cache, if this query has enabled caching. | yii\db\Query

## Events

Hide inherited events

Event | Type | Description | Defined By
--- | --- | --- | ---
EVENT_INIT | yii\db\Event | An event that is triggered when the query is initialized via init(). | yii\db\ActiveQuery

## Property Details

Hide inherited properties

$joinWith public property

A list of relations that this query should be joined with

public array|null $joinWith = null
$on public property

The join condition to be used when this query is used in a relational context. The condition will be used in the ON part when yii\db\ActiveQuery::joinWith() is called. Otherwise, the condition will be used in the WHERE part of a query. Please refer to yii\db\Query::where() on how to specify this parameter.

See also onCondition().

public string|array|null $on = null
$sql public property

The SQL statement to be executed for retrieving AR records. This is set by yii\db\ActiveRecord::findBySql().

public string|null $sql = null

## Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\Component::__call()

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name | string | The method name
$params | array | Method parameters
return | mixed | The method return value
throws | yii\base\UnknownMethodException | when calling unknown method

Source code

                    public function __call($name, $params)
    {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $object) {
            if ($object->hasMethod($name)) {
                return call_user_func_array([$object, $name], $params);
            }
        }
        throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
    }

__clone() public method

Defined in: yii\db\ActiveRelationTrait::__clone()

Clones internal objects.

public void __clone ( )

Source code

                    public function __clone()
    {
        parent::__clone();
        // make a clone of "via" object so that the same query object can be reused multiple times
        if (is_object($this->via)) {
            $this->via = clone $this->via;
        } elseif (is_array($this->via)) {
            $this->via = [$this->via[0], clone $this->via[1], $this->via[2]];
        }
    }

__construct() public method

Constructor.

public void __construct ( $modelClass, $config = [] )
$modelClass | string | The model class associated with this query
$config | array | Configurations to be applied to the newly created query object

Source code

                    public function __construct($modelClass, $config = [])
    {
        $this->modelClass = $modelClass;
        parent::__construct($config);
    }

__get() public method

Defined in: yii\base\Component::__get()

Returns the value of a component property.

This method will check in the following order and act accordingly:

- a property defined by a getter: return the getter result
- a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `$value = $component->property;`.

See also __set().

public mixed __get ( $name )
$name | string | The property name
return | mixed | The property value or the value of a behavior's property
throws | yii\base\UnknownPropertyException | if the property is not defined
throws | yii\base\InvalidCallException | if the property is write-only.

Source code

                    public function __get($name)
    {
        $getter = 'get' . $name;
        if (method_exists($this, $getter)) {
            // read property, e.g. getName()
            return $this->$getter();
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name)) {
                return $behavior->$name;
            }
        }
        if (method_exists($this, 'set' . $name)) {
            throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
        }
        throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
    }

__isset() public method

Defined in: yii\base\Component::__isset()

Checks if a property is set, i.e. defined and not null.

This method will check in the following order and act accordingly:

- a property defined by a setter: return whether the property is set
- a property of a behavior: return whether the property is set
- return `false` for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `isset($component->property)`.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name | string | The property name or the event name
return | boolean | Whether the named property is set

Source code

                    public function __isset($name)
    {
        $getter = 'get' . $name;
        if (method_exists($this, $getter)) {
            return $this->$getter() !== null;
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name)) {
                return $behavior->$name !== null;
            }
        }
        return false;
    }

__set() public method

Defined in: yii\base\Component::__set()

Sets the value of a component property.

This method will check in the following order and act accordingly:

- a property defined by a setter: set the property value
- an event in the format of "on xyz": attach the handler to the event "xyz"
- a behavior in the format of "as xyz": attach the behavior named as "xyz"
- a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `$component->property = $value;`.

See also __get().

public void __set ( $name, $value )
$name | string | The property name or the event name
$value | mixed | The property value
throws | yii\base\UnknownPropertyException | if the property is not defined
throws | yii\base\InvalidCallException | if the property is read-only.

Source code

                    public function __set($name, $value)
    {
        $setter = 'set' . $name;
        if (method_exists($this, $setter)) {
            // set property
            $this->$setter($value);
            return;
        } elseif (strncmp($name, 'on ', 3) === 0) {
            // on event: attach event handler
            $this->on(trim(substr($name, 3)), $value);
            return;
        } elseif (strncmp($name, 'as ', 3) === 0) {
            // as behavior: attach behavior
            $name = trim(substr($name, 3));
            $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
            return;
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name)) {
                $behavior->$name = $value;
                return;
            }
        }
        if (method_exists($this, 'get' . $name)) {
            throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
        }
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }

__toString() public method

Defined in: yii\db\Query::__toString()

Returns the SQL representation of Query

public string __toString ( )

Source code

                    public function __toString()
    {
        return serialize($this);
    }

__unset() public method

Defined in: yii\base\Component::__unset()

Sets a component property to be null.

This method will check in the following order and act accordingly:

- a property defined by a setter: set the property value to be null
- a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `unset($component->property)`.

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name | string | The property name
throws | yii\base\InvalidCallException | if the property is read only.

Source code

                    public function __unset($name)
    {
        $setter = 'set' . $name;
        if (method_exists($this, $setter)) {
            $this->$setter(null);
            return;
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name)) {
                $behavior->$name = null;
                return;
            }
        }
        throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
    }

addGroupBy() public method

Defined in: yii\db\Query::addGroupBy()

Adds additional group-by columns to the existing ones.

See also groupBy().

public $this addGroupBy ( $columns )

$columns

string|array|yii\db\ExpressionInterface

Additional columns to be grouped by. Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression).

Note that if your group-by is an expression containing commas, you should always use an array to represent the group-by information. Otherwise, the method will not be able to correctly determine the group-by columns.

Since version 2.0.7, an yii\db\Expression object can be passed to specify the GROUP BY part explicitly in plain SQL. Since version 2.0.14, an yii\db\ExpressionInterface object can be passed as well.

return | $this | The query object itself

Source code

                    public function addGroupBy($columns)
    {
        if ($columns instanceof ExpressionInterface) {
            $columns = [$columns];
        } elseif (!is_array($columns)) {
            $columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
        }
        if ($this->groupBy === null) {
            $this->groupBy = $columns;
        } else {
            $this->groupBy = array_merge($this->groupBy, $columns);
        }
        return $this;
    }

addOrderBy() public method

Defined in: yii\db\QueryTrait::addOrderBy()

Adds additional ORDER BY columns to the query.

See also orderBy().

public $this addOrderBy ( $columns )

$columns

string|array|yii\db\ExpressionInterface

The columns (and the directions) to be ordered by. Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array (e.g. `['id' => SORT_ASC, 'name' => SORT_DESC]`).

The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression).

Note that if your order-by is an expression containing commas, you should always use an array to represent the order-by information. Otherwise, the method will not be able to correctly determine the order-by columns.

Since version 2.0.7, an yii\db\ExpressionInterface object can be passed to specify the ORDER BY part explicitly in plain SQL.

return | $this | The query object itself

Source code

                    public function addOrderBy($columns)
    {
        $columns = $this->normalizeOrderBy($columns);
        if ($this->orderBy === null) {
            $this->orderBy = $columns;
        } else {
            $this->orderBy = array_merge($this->orderBy, $columns);
        }
        return $this;
    }

addParams() public method

Defined in: yii\db\Query::addParams()

Adds additional parameters to be bound to the query.

See also params().

public $this addParams ( $params )
$params | array | List of query parameter values indexed by parameter placeholders. For example, `[':name' => 'Dan', ':age' => 31]`.
return | $this | The query object itself

Source code

                    public function addParams($params)
    {
        if (!empty($params)) {
            if (empty($this->params)) {
                $this->params = $params;
            } else {
                foreach ($params as $name => $value) {
                    if (is_int($name)) {
                        $this->params[] = $value;
                    } else {
                        $this->params[$name] = $value;
                    }
                }
            }
        }
        return $this;
    }

addSelect() public method

Defined in: yii\db\Query::addSelect()

Add more columns to the SELECT part of the query.

Note, that if select() has not been specified before, you should include `*` explicitly if you want to select all remaining columns too:

    $query->addSelect(["*", "CONCAT(first_name, ' ', last_name) AS full_name"])->one();

See also select().

public $this addSelect ( $columns )
$columns | string|array|yii\db\ExpressionInterface | The columns to add to the select. See select() for more details about the format of this parameter.
return | $this | The query object itself

Source code

                    public function addSelect($columns)
    {
        if ($this->select === null) {
            return $this->select($columns);
        }
        if (!is_array($this->select)) {
            $this->select = $this->normalizeSelect($this->select);
        }
        $this->select = array_merge($this->select, $this->normalizeSelect($columns));
        return $this;
    }

alias() public method (available since version 2.0.7)

Define an alias for the table defined in $modelClass.

This method will adjust from() so that an already defined alias will be overwritten. If none was defined, from() will be populated with the given alias.

public $this alias ( $alias )
$alias | string | The table alias.
return | $this | The query object itself

Source code

                    public function alias($alias)
    {
        if (empty($this->from) || count($this->from) < 2) {
            list($tableName) = $this->getTableNameAndAlias();
            $this->from = [$alias => $tableName];
        } else {
            $tableName = $this->getPrimaryTableName();
            foreach ($this->from as $key => $table) {
                if ($table === $tableName) {
                    unset($this->from[$key]);
                    $this->from[$alias] = $tableName;
                }
            }
        }
        return $this;
    }

all() public method

Executes query and returns all results as an array.

public array|yii\db\ActiveRecord[] all ( $db = null )
$db | yii\db\Connection|null | The DB connection used to create the DB command. If null, the DB connection returned by $modelClass will be used.
return | array|yii\db\ActiveRecord[] | The query results. If the query results in nothing, an empty array will be returned.

Source code

                    public function all($db = null)
    {
        return parent::all($db);
    }

andFilterCompare() public method (available since version 2.0.8)

Defined in: yii\db\Query::andFilterCompare()

Adds a filtering condition for a specific column and allow the user to choose a filter operator.

It adds an additional WHERE condition for the given field and determines the comparison operator based on the first few characters of the given value. The condition is added in the same way as in andFilterWhere() so empty values are ignored. The new condition and the existing one will be joined using the `AND` operator.

The comparison operator is intelligently determined based on the first few characters in the given value. In particular, it recognizes the following operators if they appear as the leading characters in the given value:

- `<`: the column must be less than the given value.
- `>`: the column must be greater than the given value.
- `<=`: the column must be less than or equal to the given value.
- `>=`: the column must be greater than or equal to the given value.
- `<>`: the column must not be the same as the given value.
- `=`: the column must be equal to the given value.
- If none of the above operators is detected, the `$defaultOperator` will be used.

public $this andFilterCompare ( $name, $value, $defaultOperator = '=' )
$name | string | The column name.
$value | string | The column value optionally prepended with the comparison operator.
$defaultOperator | string | The operator to use, when no operator is given in `$value`. Defaults to `=`, performing an exact match.
return | $this | The query object itself

Source code

                    public function andFilterCompare($name, $value, $defaultOperator = '=')
    {
        if (preg_match('/^(<>|>=|>|<=|<|=)/', (string)$value, $matches)) {
            $operator = $matches[1];
            $value = substr($value, strlen($operator));
        } else {
            $operator = $defaultOperator;
        }
        return $this->andFilterWhere([$operator, $name, $value]);
    }

andFilterHaving() public method (available since version 2.0.11)

Defined in: yii\db\Query::andFilterHaving()

Adds an additional HAVING condition to the existing one but ignores empty operands.

The new condition and the existing one will be joined using the `AND` operator.

This method is similar to andHaving(). The main difference is that this method will remove empty query operands. As a result, this method is best suited for building query conditions based on filter values entered by users.

See also:

- filterHaving()
- orFilterHaving()

public $this andFilterHaving ( array $condition )
$condition | array | The new HAVING condition. Please refer to having() on how to specify this parameter.
return | $this | The query object itself

Source code

                    public function andFilterHaving(array $condition)
    {
        $condition = $this->filterCondition($condition);
        if ($condition !== []) {
            $this->andHaving($condition);
        }
        return $this;
    }

andFilterWhere() public method

Defined in: yii\db\QueryTrait::andFilterWhere()

Adds an additional WHERE condition to the existing one but ignores empty operands.

The new condition and the existing one will be joined using the 'AND' operator.

This method is similar to andWhere(). The main difference is that this method will remove empty query operands. As a result, this method is best suited for building query conditions based on filter values entered by users.

See also:

- filterWhere()
- orFilterWhere()

public $this andFilterWhere ( array $condition )
$condition | array | The new WHERE condition. Please refer to where() on how to specify this parameter.
return | $this | The query object itself

Source code

                    public function andFilterWhere(array $condition)
    {
        $condition = $this->filterCondition($condition);
        if ($condition !== []) {
            $this->andWhere($condition);
        }
        return $this;
    }

andHaving() public method

Defined in: yii\db\Query::andHaving()

Adds an additional HAVING condition to the existing one.

The new condition and the existing one will be joined using the `AND` operator.

See also:

- having()
- orHaving()

public $this andHaving ( $condition, $params = [] )
$condition | string|array|yii\db\ExpressionInterface | The new HAVING condition. Please refer to where() on how to specify this parameter.
$params | array | The parameters (name => value) to be bound to the query.
return | $this | The query object itself

Source code

                    public function andHaving($condition, $params = [])
    {
        if ($this->having === null) {
            $this->having = $condition;
        } else {
            $this->having = ['and', $this->having, $condition];
        }
        $this->addParams($params);
        return $this;
    }

andOnCondition() public method

Adds an additional ON condition to the existing one.

The new condition and the existing one will be joined using the 'AND' operator.

See also:

- onCondition()
- orOnCondition()

public $this andOnCondition ( $condition, $params = [] )
$condition | string|array | The new ON condition. Please refer to where() on how to specify this parameter.
$params | array | The parameters (name => value) to be bound to the query.
return | $this | The query object itself

Source code

                    public function andOnCondition($condition, $params = [])
    {
        if ($this->on === null) {
            $this->on = $condition;
        } else {
            $this->on = ['and', $this->on, $condition];
        }
        $this->addParams($params);
        return $this;
    }

andWhere() public method

Defined in: yii\db\QueryTrait::andWhere()

Adds an additional WHERE condition to the existing one.

The new condition and the existing one will be joined using the 'AND' operator.

See also:

- where()
- orWhere()

public $this andWhere ( $condition )
$condition | string|array|yii\db\ExpressionInterface | The new WHERE condition. Please refer to where() on how to specify this parameter.
return | $this | The query object itself

Source code

                    public function andWhere($condition)
    {
        if ($this->where === null) {
            $this->where = $condition;
        } else {
            $this->where = ['and', $this->where, $condition];
        }
        return $this;
    }

asArray() public method

Defined in: yii\db\ActiveQueryTrait::asArray()

Sets the asArray() property.

public $this asArray ( $value = true )
$value | boolean | Whether to return the query results in terms of arrays instead of Active Records.
return | $this | The query object itself

Source code

                    public function asArray($value = true)
    {
        $this->asArray = $value;
        return $this;
    }

attachBehavior() public method

Defined in: yii\base\Component::attachBehavior()

Attaches a behavior to this component.

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the yii\base\Behavior::attach() method.

See also detachBehavior().

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name | string | The name of the behavior.

$behavior

string|array|yii\base\Behavior

The behavior configuration. This can be one of the following:

- a yii\base\Behavior object
- a string specifying the behavior class
- an object configuration array that will be passed to Yii::createObject() to create the behavior object.

return | yii\base\Behavior | The behavior object

Source code

                    public function attachBehavior($name, $behavior)
    {
        $this->ensureBehaviors();
        return $this->attachBehaviorInternal($name, $behavior);
    }

attachBehaviors() public method

Defined in: yii\base\Component::attachBehaviors()

Attaches a list of behaviors to the component.

Each behavior is indexed by its name and should be a yii\base\Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.

See also attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors | array | List of behaviors to be attached to the component

Source code

                    public function attachBehaviors($behaviors)
    {
        $this->ensureBehaviors();
        foreach ($behaviors as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }

average() public method

Defined in: yii\db\Query::average()

Returns the average of the specified column values.

public mixed average ( $q, $db = null )
$q | string | The column name or expression. Make sure you properly quote column names in the expression.
$db | yii\db\Connection|null | The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used.
return | mixed | The average of the specified column values.

Source code

                    public function average($q, $db = null)
    {
        if ($this->emulateExecution) {
            return 0;
        }
        return $this->queryScalar("AVG($q)", $db);
    }

batch() public method

Defined in: yii\db\Query::batch()

Starts a batch query.

A batch query supports fetching data in batches, which can keep the memory usage under a limit. This method will return a yii\db\BatchQueryResult object which implements the Iterator interface and can be traversed to retrieve the data in batches.

For example,

    $query = (new Query)->from('user');
    foreach ($query->batch() as $rows) {
        // $rows is an array of 100 or fewer rows from user table
    }

public yii\db\BatchQueryResult batch ( $batchSize = 100, $db = null )
$batchSize | integer | The number of records to be fetched in each batch.
$db | yii\db\Connection|null | The database connection. If not set, the "db" application component will be used.
return | yii\db\BatchQueryResult | The batch query result. It implements the Iterator interface and can be traversed to retrieve the data in batches.

Source code

                    public function batch($batchSize = 100, $db = null)
    {
        return Yii::createObject([
            'class' => BatchQueryResult::className(),
            'query' => $this,
            'batchSize' => $batchSize,
            'db' => $db,
            'each' => false,
        ]);
    }

behaviors() public method

Defined in: yii\base\Component::behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

    'behaviorName' => [
        'class' => 'BehaviorClass',
        'property1' => 'value1',
        'property2' => 'value2',
    ]

Note that a behavior class must extend from yii\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

public array behaviors ( )
return | array | The behavior configurations.

Source code

                    public function behaviors()
    {
        return [];
    }

cache() public method (available since version 2.0.14)

Defined in: yii\db\Query::cache()

Enables query cache for this Query.

public $this cache ( $duration = true, $dependency = null )
$duration | integer|true | The number of seconds that query results can remain valid in cache. Use 0 to indicate that the cached data will never expire. Use a negative number to indicate that query cache should not be used. Use boolean `true` to indicate that yii\db\Connection::$queryCacheDuration should be used. Defaults to `true`.
$dependency | yii\caching\Dependency|null | The cache dependency associated with the cached result.
return | $this | The Query object itself

Source code

                    public function cache($duration = true, $dependency = null)
    {
        $this->queryCacheDuration = $duration;
        $this->queryCacheDependency = $dependency;
        return $this;
    }

canGetProperty() public method

Defined in: yii\base\Component::canGetProperty()

Returns a value indicating whether a property can be read.

A property can be read if:

- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when `$checkVars` is true);
- an attached behavior has a readable property of the given name (when `$checkBehaviors` is true).

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
$checkBehaviors | boolean | Whether to treat behaviors' properties as properties of this component
return | boolean | Whether the property can be read

Source code

                    public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
    {
        if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
            return true;
        } elseif ($checkBehaviors) {
            $this->ensureBehaviors();
            foreach ($this->_behaviors as $behavior) {
                if ($behavior->canGetProperty($name, $checkVars)) {
                    return true;
                }
            }
        }
        return false;
    }

canSetProperty() public method

Defined in: yii\base\Component::canSetProperty()

Returns a value indicating whether a property can be set.

A property can be written if:

- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when `$checkVars` is true);
- an attached behavior has a writable property of the given name (when `$checkBehaviors` is true).

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
$checkBehaviors | boolean | Whether to treat behaviors' properties as properties of this component
return | boolean | Whether the property can be written

Source code

                    public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
    {
        if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
            return true;
        } elseif ($checkBehaviors) {
            $this->ensureBehaviors();
            foreach ($this->_behaviors as $behavior) {
                if ($behavior->canSetProperty($name, $checkVars)) {
                    return true;
                }
            }
        }
        return false;
    }

className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use `::class` instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return | string | The fully qualified name of this class.

Source code

                    public static function className()
    {
        return get_called_class();
    }

cleanUpTableNames() protected method (available since version 2.0.14)

Defined in: yii\db\Query::cleanUpTableNames()

Clean up table names and aliases Both aliases and names are enclosed into {{ and }}.

protected string[] cleanUpTableNames ( $tableNames )
$tableNames | array | Non-empty array
return | string[] | Table names indexed by aliases

Source code

                    protected function cleanUpTableNames($tableNames)
    {
        $cleanedUpTableNames = [];
        foreach ($tableNames as $alias => $tableName) {
            if (is_string($tableName) && !is_string($alias)) {
                $pattern = <<<PATTERN
    '"`\[]|{{)
    '"`\]]|}})
    ?\)
    \s+
    (?:as)?
    \s*
    ?:['"`\[]|{{)
    .*?
    (?:['"`\]]|}})
    |
    .*?

    ERN;
                if (preg_match($pattern, $tableName, $matches)) {
                    if (isset($matches[2])) {
                        list(, $tableName, $alias) = $matches;
                    } else {
                        $tableName = $alias = $matches[1];
                    }
                }
            }
            if ($tableName instanceof Expression) {
                if (!is_string($alias)) {
                    throw new InvalidArgumentException('To use Expression in from() method, pass it in array format with alias.');
                }
                $cleanedUpTableNames[$this->ensureNameQuoted($alias)] = $tableName;
            } elseif ($tableName instanceof self) {
                $cleanedUpTableNames[$this->ensureNameQuoted($alias)] = $tableName;
            } else {
                $cleanedUpTableNames[$this->ensureNameQuoted($alias)] = $this->ensureNameQuoted($tableName);
            }
        }
        return $cleanedUpTableNames;
    }

column() public method

Defined in: yii\db\Query::column()

Executes the query and returns the first column of the result.

public array column ( $db = null )
$db | yii\db\Connection|null | The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used.
return | array | The first column of the query result. An empty array is returned if the query results in nothing.

Source code

                    public function column($db = null)
    {
        if ($this->emulateExecution) {
            return [];
        }
        if ($this->indexBy === null) {
            return $this->createCommand($db)->queryColumn();
        }
        if (is_string($this->indexBy) && is_array($this->select) && count($this->select) === 1) {
            if (strpos($this->indexBy, '.') === false && count($tables = $this->getTablesUsedInFrom()) > 0) {
                $this->select[] = key($tables) . '.' . $this->indexBy;
            } else {
                $this->select[] = $this->indexBy;
            }
        }
        $rows = $this->createCommand($db)->queryAll();
        $results = [];
        $column = null;
        if (is_string($this->indexBy)) {
            if (($dotPos = strpos($this->indexBy, '.')) === false) {
                $column = $this->indexBy;
            } else {
                $column = substr($this->indexBy, $dotPos + 1);
            }
        }
        foreach ($rows as $row) {
            $value = reset($row);
            if ($this->indexBy instanceof \Closure) {
                $results[call_user_func($this->indexBy, $row)] = $value;
            } else {
                $results[$row[$column]] = $value;
            }
        }
        return $results;
    }

count() public method

Defined in: yii\db\Query::count()

Returns the number of records.

public integer|string|null count ( $q = '*', $db = null )
$q | string | The COUNT expression. Defaults to '*'. Make sure you properly quote column names in the expression.
$db | yii\db\Connection|null | The database connection used to generate the SQL statement. If this parameter is not given (or null), the `db` application component will be used.
return | integer|string|null | Number of records. The result may be a string depending on the underlying database engine and to support integer values higher than a 32bit PHP integer can handle.

Source code

                    public function count($q = '*', $db = null)
    {
        if ($this->emulateExecution) {
            return 0;
        }
        return $this->queryScalar("COUNT($q)", $db);
    }

create() public static method

Defined in: yii\db\Query::create()

Creates a new Query object and copies its property values from an existing one.

The properties being copies are the ones to be used by query builders.

public static yii\db\Query create ( $from )
$from | yii\db\Query | The source query object
return | yii\db\Query | The new Query object

Source code

                    public static function create($from)
    {
        return new self([
            'where' => $from->where,
            'limit' => $from->limit,
            'offset' => $from->offset,
            'orderBy' => $from->orderBy,
            'indexBy' => $from->indexBy,
            'select' => $from->select,
            'selectOption' => $from->selectOption,
            'distinct' => $from->distinct,
            'from' => $from->from,
            'groupBy' => $from->groupBy,
            'join' => $from->join,
            'having' => $from->having,
            'union' => $from->union,
            'params' => $from->params,
            'withQueries' => $from->withQueries,
        ]);
    }

createCommand() public method

Creates a DB command that can be used to execute this query.

public yii\db\Command createCommand ( $db = null )
$db | yii\db\Connection|null | The DB connection used to create the DB command. If `null`, the DB connection returned by $modelClass will be used.
return | yii\db\Command | The created DB command instance.

Source code

                    public function createCommand($db = null)
    {
        /* @var $modelClass ActiveRecord */
        $modelClass = $this->modelClass;
        if ($db === null) {
            $db = $modelClass::getDb();
        }
        if ($this->sql === null) {
            list($sql, $params) = $db->getQueryBuilder()->build($this);
        } else {
            $sql = $this->sql;
            $params = $this->params;
        }
        $command = $db->createCommand($sql, $params);
        $this->setCommandCache($command);
        return $command;
    }

createModels() protected method (available since version 2.0.11)

Defined in: yii\db\ActiveQueryTrait::createModels()

Converts found rows into model instances.

protected array|yii\db\ActiveRecord[] createModels ( $rows )
$rows | array |

Source code

                    protected function createModels($rows)
    {
        if ($this->asArray) {
            return $rows;
        } else {
            $models = [];
            /* @var $class ActiveRecord */
            $class = $this->modelClass;
            foreach ($rows as $row) {
                $model = $class::instantiate($row);
                $modelClass = get_class($model);
                $modelClass::populateRecord($model, $row);
                $models[] = $model;
            }
            return $models;
        }
    }

detachBehavior() public method

Defined in: yii\base\Component::detachBehavior()

Detaches a behavior from the component.

The behavior's yii\base\Behavior::detach() method will be invoked.

public yii\base\Behavior|null detachBehavior ( $name )
$name | string | The behavior's name.
return | yii\base\Behavior|null | The detached behavior. Null if the behavior does not exist.

Source code

                    public function detachBehavior($name)
    {
        $this->ensureBehaviors();
        if (isset($this->_behaviors[$name])) {
            $behavior = $this->_behaviors[$name];
            unset($this->_behaviors[$name]);
            $behavior->detach();
            return $behavior;
        }
        return null;
    }

detachBehaviors() public method

Defined in: yii\base\Component::detachBehaviors()

Detaches all behaviors from the component.

public void detachBehaviors ( )

Source code

                    public function detachBehaviors()
    {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $name => $behavior) {
            $this->detachBehavior($name);
        }
    }

distinct() public method

Defined in: yii\db\Query::distinct()

Sets the value indicating whether to SELECT DISTINCT or not.

public $this distinct ( $value = true )
$value | boolean | Whether to SELECT DISTINCT or not.
return | $this | The query object itself

Source code

                    public function distinct($value = true)
    {
        $this->distinct = $value;
        return $this;
    }

each() public method

Defined in: yii\db\Query::each()

Starts a batch query and retrieves data row by row.

This method is similar to batch() except that in each iteration of the result, only one row of data is returned. For example,

    $query = (new Query)->from('user');
    foreach ($query->each() as $row) {
    }

public yii\db\BatchQueryResult each ( $batchSize = 100, $db = null )
$batchSize | integer | The number of records to be fetched in each batch.
$db | yii\db\Connection|null | The database connection. If not set, the "db" application component will be used.
return | yii\db\BatchQueryResult | The batch query result. It implements the Iterator interface and can be traversed to retrieve the data in batches.

Source code

                    public function each($batchSize = 100, $db = null)
    {
        return Yii::createObject([
            'class' => BatchQueryResult::className(),
            'query' => $this,
            'batchSize' => $batchSize,
            'db' => $db,
            'each' => true,
        ]);
    }

emulateExecution() public method (available since version 2.0.11)

Defined in: yii\db\QueryTrait::emulateExecution()

Sets whether to emulate query execution, preventing any interaction with data storage.

After this mode is enabled, methods, returning query results like yii\db\QueryInterface::one(), yii\db\QueryInterface::all(), yii\db\QueryInterface::exists() and so on, will return empty or false values. You should use this method in case your program logic indicates query should not return any results, like in case you set false where condition like `0=1`.

public $this emulateExecution ( $value = true )
$value | boolean | Whether to prevent query execution.
return | $this | The query object itself.

Source code

                    public function emulateExecution($value = true)
    {
        $this->emulateExecution = $value;
        return $this;
    }

ensureBehaviors() public method

Defined in: yii\base\Component::ensureBehaviors()

Makes sure that the behaviors declared in behaviors() are attached to this component.

public void ensureBehaviors ( )

Source code

                    public function ensureBehaviors()
    {
        if ($this->_behaviors === null) {
            $this->_behaviors = [];
            foreach ($this->behaviors() as $name => $behavior) {
                $this->attachBehaviorInternal($name, $behavior);
            }
        }
    }

exists() public method

Defined in: yii\db\Query::exists()

Returns a value indicating whether the query result contains any row of data.

public boolean exists ( $db = null )
$db | yii\db\Connection|null | The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used.
return | boolean | Whether the query result contains any row of data.

Source code

                    public function exists($db = null)
    {
        if ($this->emulateExecution) {
            return false;
        }
        $command = $this->createCommand($db);
        $params = $command->params;
        $command->setSql($command->db->getQueryBuilder()->selectExists($command->getSql()));
        $command->bindValues($params);
        return (bool) $command->queryScalar();
    }

filterCondition() protected method

Defined in: yii\db\QueryTrait::filterCondition()

Removes empty operands from the given query condition.

protected array filterCondition ( $condition )
$condition | array | The original condition
return | array | The condition with empty operands removed.
throws | yii\base\NotSupportedException | if the condition operator is not supported

Source code

                    protected function filterCondition($condition)
    {
        if (!is_array($condition)) {
            return $condition;
        }
        if (!isset($condition[0])) {
            // hash format: 'column1' => 'value1', 'column2' => 'value2', ...
            foreach ($condition as $name => $value) {
                if ($this->isEmpty($value)) {
                    unset($condition[$name]);
                }
            }
            return $condition;
        }
        // operator format: operator, operand 1, operand 2, ...
        $operator = array_shift($condition);
        switch (strtoupper($operator)) {
            case 'NOT':
            case 'AND':
            case 'OR':
                foreach ($condition as $i => $operand) {
                    $subCondition = $this->filterCondition($operand);
                    if ($this->isEmpty($subCondition)) {
                        unset($condition[$i]);
                    } else {
                        $condition[$i] = $subCondition;
                    }
                }
                if (empty($condition)) {
                    return [];
                }
                break;
            case 'BETWEEN':
            case 'NOT BETWEEN':
                if (array_key_exists(1, $condition) && array_key_exists(2, $condition)) {
                    if ($this->isEmpty($condition[1]) || $this->isEmpty($condition[2])) {
                        return [];
                    }
                }
                break;
            default:
                if (array_key_exists(1, $condition) && $this->isEmpty($condition[1])) {
                    return [];
                }
        }
        array_unshift($condition, $operator);
        return $condition;
    }

filterHaving() public method (available since version 2.0.11)

Defined in: yii\db\Query::filterHaving()

Sets the HAVING part of the query but ignores empty operands.

This method is similar to having(). The main difference is that this method will remove empty query operands. As a result, this method is best suited for building query conditions based on filter values entered by users.

The following code shows the difference between this method and having():

    // HAVING `age`=:age
    $query->filterHaving(['name' => null, 'age' => 20]);
    // HAVING `age`=:age
    $query->having(['age' => 20]);
    // HAVING `name` IS NULL AND `age`=:age
    $query->having(['name' => null, 'age' => 20]);

Note that unlike having(), you cannot pass binding parameters to this method.

See also:

- having()
- andFilterHaving()
- orFilterHaving()

public $this filterHaving ( array $condition )
$condition | array | The conditions that should be put in the HAVING part. See having() on how to specify this parameter.
return | $this | The query object itself

Source code

                    public function filterHaving(array $condition)
    {
        $condition = $this->filterCondition($condition);
        if ($condition !== []) {
            $this->having($condition);
        }
        return $this;
    }

filterWhere() public method

Defined in: yii\db\QueryTrait::filterWhere()

Sets the WHERE part of the query but ignores empty operands.

This method is similar to where(). The main difference is that this method will remove empty query operands. As a result, this method is best suited for building query conditions based on filter values entered by users.

The following code shows the difference between this method and where():

    // WHERE `age`=:age
    $query->filterWhere(['name' => null, 'age' => 20]);
    // WHERE `age`=:age
    $query->where(['age' => 20]);
    // WHERE `name` IS NULL AND `age`=:age
    $query->where(['name' => null, 'age' => 20]);

Note that unlike where(), you cannot pass binding parameters to this method.

See also:

- where()
- andFilterWhere()
- orFilterWhere()

public $this filterWhere ( array $condition )
$condition | array | The conditions that should be put in the WHERE part. See where() on how to specify this parameter.
return | $this | The query object itself

Source code

                    public function filterWhere(array $condition)
    {
        $condition = $this->filterCondition($condition);
        if ($condition !== []) {
            $this->where($condition);
        }
        return $this;
    }

findFor() public method

Defined in: yii\db\ActiveRelationTrait::findFor()

Finds the related records for the specified primary record.

This method is invoked when a relation of an ActiveRecord is being accessed lazily.

public mixed findFor ( $name, $model )
$name | string | The relation name
$model | yii\db\ActiveRecordInterface|yii\db\BaseActiveRecord | The primary model
return | mixed | The related record(s)
throws | yii\base\InvalidArgumentException | if the relation is invalid

Source code

                    public function findFor($name, $model)
    {
        if (method_exists($model, 'get' . $name)) {
            $method = new \ReflectionMethod($model, 'get' . $name);
            $realName = lcfirst(substr($method->getName(), 3));
            if ($realName !== $name) {
                throw new InvalidArgumentException('Relation names are case sensitive. ' . get_class($model) . " has a relation named \"$realName\" instead of \"$name\".");
            }
        }
        return $this->multiple ? $this->all() : $this->one();
    }

findWith() public method

Defined in: yii\db\ActiveQueryTrait::findWith()

Finds records corresponding to one or multiple relations and populates them into the primary models.

public void findWith ( $with, &$models )
$with | array | A list of relations that this query should be performed with. Please refer to with() for details about specifying this parameter.
$models | array|yii\db\ActiveRecord[] | The primary models (can be either AR instances or arrays)

Source code

                    public function findWith($with, &$models)
    {
        if (empty($models)) {
            return;
        }
        $primaryModel = reset($models);
        if (!$primaryModel instanceof ActiveRecordInterface) {
            /* @var $modelClass ActiveRecordInterface */
            $modelClass = $this->modelClass;
            $primaryModel = $modelClass::instance();
        }
        $relations = $this->normalizeRelations($primaryModel, $with);
        /* @var $relation ActiveQuery */
        foreach ($relations as $name => $relation) {
            if ($relation->asArray === null) {
                // inherit asArray from primary query
                $relation->asArray($this->asArray);
            }
            $relation->populateRelation($name, $models);
        }
    }

from() public method

Defined in: yii\db\Query::from()

Sets the FROM part of the query.

public $this from ( $tables )

$tables

string|array|yii\db\ExpressionInterface

The table(s) to be selected from. This can be either a string (e.g. `'user'`) or an array (e.g. `['user', 'profile']`) specifying one or several table names. Table names can contain schema prefixes (e.g. `'public.user'`) and/or table aliases (e.g. `'user u'`). The method will automatically quote the table names unless it contains some parenthesis (which means the table is given as a sub-query or DB expression).

When the tables are specified as an array, you may also use the array keys as the table aliases (if a table does not need alias, do not use a string key).

Use a Query object to represent a sub-query. In this case, the corresponding array key will be used as the alias for the sub-query.

To specify the `FROM` part in plain SQL, you may pass an instance of yii\db\ExpressionInterface.

Here are some examples:

    // SELECT * FROM  `user` `u`, `profile`;
    $query = (new \yii\db\Query)->from(['u' => 'user', 'profile']);

    // SELECT * FROM (SELECT * FROM `user` WHERE `active` = 1) `activeusers`;
    $subquery = (new \yii\db\Query)->from('user')->where(['active' => true])
    $query = (new \yii\db\Query)->from(['activeusers' => $subquery]);

    // subquery can also be a string with plain SQL wrapped in parenthesis
    // SELECT * FROM (SELECT * FROM `user` WHERE `active` = 1) `activeusers`;
    $subquery = "(SELECT * FROM `user` WHERE `active` = 1)";
    $query = (new \yii\db\Query)->from(['activeusers' => $subquery]);

return | $this | The query object itself

Source code

                    public function from($tables)
    {
        if ($tables instanceof ExpressionInterface) {
            $tables = [$tables];
        }
        if (is_string($tables)) {
            $tables = preg_split('/\s*,\s*/', trim($tables), -1, PREG_SPLIT_NO_EMPTY);
        }
        $this->from = $tables;
        return $this;
    }

getBehavior() public method

Defined in: yii\base\Component::getBehavior()

Returns the named behavior object.

public yii\base\Behavior|null getBehavior ( $name )
$name | string | The behavior name
return | yii\base\Behavior|null | The behavior object, or null if the behavior does not exist

Source code

                    public function getBehavior($name)
    {
        $this->ensureBehaviors();
        return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
    }

getBehaviors() public method

Defined in: yii\base\Component::getBehaviors()

Returns all behaviors attached to this component.

public yii\base\Behavior[] getBehaviors ( )
return | yii\base\Behavior[] | List of behaviors attached to this component

Source code

                    public function getBehaviors()
    {
        $this->ensureBehaviors();
        return $this->_behaviors;
    }

getPrimaryTableName() protected method (available since version 2.0.12)

protected string getPrimaryTableName ( )
return | string | Primary table name

Source code

                    protected function getPrimaryTableName()
    {
        /* @var $modelClass ActiveRecord */
        $modelClass = $this->modelClass;
        return $modelClass::tableName();
    }

getTableNameAndAlias() protected method (available since version 2.0.16)

Returns the table name and the table alias for $modelClass.

protected array getTableNameAndAlias ( )
return | array | The table name and the table alias.

Source code

                    protected function getTableNameAndAlias()
    {
        if (empty($this->from)) {
            $tableName = $this->getPrimaryTableName();
        } else {
            $tableName = '';
            // if the first entry in "from" is an alias-tablename-pair return it directly
            foreach ($this->from as $alias => $tableName) {
                if (is_string($alias)) {
                    return [$tableName, $alias];
                }
                break;
            }
        }
        if (preg_match('/^(.*?)\s+({{\w+}}|\w+)$/', $tableName, $matches)) {
            $alias = $matches[2];
        } else {
            $alias = $tableName;
        }
        return [$tableName, $alias];
    }

getTablesUsedInFrom() public method (available since version 2.0.12)

Returns table names used in from() indexed by aliases.

Both aliases and names are enclosed into {{ and }}.

public string[] getTablesUsedInFrom ( )
return | string[] | Table names indexed by aliases
throws | yii\base\InvalidConfigException |

Source code

                    public function getTablesUsedInFrom()
    {
        if (empty($this->from)) {
            return $this->cleanUpTableNames([$this->getPrimaryTableName()]);
        }
        return parent::getTablesUsedInFrom();
    }

getUnaliasedColumnsFromSelect() protected method (available since version 2.0.14)
Deprecated in 2.0.21

Defined in: yii\db\Query::getUnaliasedColumnsFromSelect()

protected array getUnaliasedColumnsFromSelect ( )
return | array | List of columns without aliases from SELECT statement.

Source code

                    protected function getUnaliasedColumnsFromSelect()
    {
        $result = [];
        if (is_array($this->select)) {
            foreach ($this->select as $name => $value) {
                if (is_int($name)) {
                    $result[] = $value;
                }
            }
        }
        return array_unique($result);
    }

getUniqueColumns() protected method (available since version 2.0.14)
Deprecated in 2.0.21

Defined in: yii\db\Query::getUniqueColumns()

Returns unique column names excluding duplicates.

Columns to be removed:

- if column definition already present in SELECT part with same alias
- if column definition without alias already present in SELECT part without alias too

protected void getUniqueColumns ( $columns )
$columns | array | The columns to be merged to the select.

Source code

                    protected function getUniqueColumns($columns)
    {
        $unaliasedColumns = $this->getUnaliasedColumnsFromSelect();
        $result = [];
        foreach ($columns as $columnAlias => $columnDefinition) {
            if (!$columnDefinition instanceof Query) {
                if (is_string($columnAlias)) {
                    $existsInSelect = isset($this->select[$columnAlias]) && $this->select[$columnAlias] === $columnDefinition;
                    if ($existsInSelect) {
                        continue;
                    }
                } elseif (is_int($columnAlias)) {
                    $existsInSelect = in_array($columnDefinition, $unaliasedColumns, true);
                    $existsInResultSet = in_array($columnDefinition, $result, true);
                    if ($existsInSelect || $existsInResultSet) {
                        continue;
                    }
                }
            }
            $result[$columnAlias] = $columnDefinition;
        }
        return $result;
    }

groupBy() public method

Defined in: yii\db\Query::groupBy()

Sets the GROUP BY part of the query.

See also addGroupBy().

public $this groupBy ( $columns )

$columns

string|array|yii\db\ExpressionInterface|null

The columns to be grouped by. Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression).

Note that if your group-by is an expression containing commas, you should always use an array to represent the group-by information. Otherwise, the method will not be able to correctly determine the group-by columns.

Since version 2.0.7, an yii\db\ExpressionInterface object can be passed to specify the GROUP BY part explicitly in plain SQL. Since version 2.0.14, an yii\db\ExpressionInterface object can be passed as well.

return | $this | The query object itself

Source code

                    public function groupBy($columns)
    {
        if ($columns instanceof ExpressionInterface) {
            $columns = [$columns];
        } elseif (!is_array($columns) && !is_null($columns)) {
            $columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
        }
        $this->groupBy = $columns;
        return $this;
    }

hasEventHandlers() public method

Defined in: yii\base\Component::hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.

public boolean hasEventHandlers ( $name )
$name | string | The event name
return | boolean | Whether there is any handler attached to the event.

Source code

                    public function hasEventHandlers($name)
    {
        $this->ensureBehaviors();
        if (!empty($this->_events[$name])) {
            return true;
        }
        foreach ($this->_eventWildcards as $wildcard => $handlers) {
            if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
                return true;
            }
        }
        return Event::hasHandlers($this, $name);
    }

hasMethod() public method

Defined in: yii\base\Component::hasMethod()

Returns a value indicating whether a method is defined.

A method is defined if:

- the class has a method with the specified name
- an attached behavior has a method with the given name (when `$checkBehaviors` is true).

public boolean hasMethod ( $name, $checkBehaviors = true )
$name | string | The property name
$checkBehaviors | boolean | Whether to treat behaviors' methods as methods of this component
return | boolean | Whether the method is defined

Source code

                    public function hasMethod($name, $checkBehaviors = true)
    {
        if (method_exists($this, $name)) {
            return true;
        } elseif ($checkBehaviors) {
            $this->ensureBehaviors();
            foreach ($this->_behaviors as $behavior) {
                if ($behavior->hasMethod($name)) {
                    return true;
                }
            }
        }
        return false;
    }

hasProperty() public method

Defined in: yii\base\Component::hasProperty()

Returns a value indicating whether a property is defined for this component.

A property is defined if:

- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when `$checkVars` is true);
- an attached behavior has a property of the given name (when `$checkBehaviors` is true).

See also:

- canGetProperty()
- canSetProperty()

public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
$checkBehaviors | boolean | Whether to treat behaviors' properties as properties of this component
return | boolean | Whether the property is defined

Source code

                    public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
    {
        return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
    }

having() public method

Defined in: yii\db\Query::having()

Sets the HAVING part of the query.

See also:

- andHaving()
- orHaving()

public $this having ( $condition, $params = [] )
$condition | string|array|yii\db\ExpressionInterface | The conditions to be put after HAVING. Please refer to where() on how to specify this parameter.
$params | array | The parameters (name => value) to be bound to the query.
return | $this | The query object itself

Source code

                    public function having($condition, $params = [])
    {
        $this->having = $condition;
        $this->addParams($params);
        return $this;
    }

indexBy() public method

Defined in: yii\db\QueryTrait::indexBy()

Sets the indexBy() property.

public $this indexBy ( $column )

$column

string|callable

The name of the column by which the query results should be indexed by. This can also be a callable (e.g. anonymous function) that returns the index value based on the given row data. The signature of the callable should be:

    function ($row)
    {
        // return the index value corresponding to $row
    }

return | $this | The query object itself

Source code

                    public function indexBy($column)
    {
        $this->indexBy = $column;
        return $this;
    }

init() public method

Initializes the object.

This method is called at the end of the constructor. The default implementation will trigger an EVENT_INIT event. If you override this method, make sure you call the parent implementation at the end to ensure triggering of the event.

public void init ( )

Source code

                    public function init()
    {
        parent::init();
        $this->trigger(self::EVENT_INIT);
    }

innerJoin() public method

Defined in: yii\db\Query::innerJoin()

Appends an INNER JOIN part to the query.

public $this innerJoin ( $table, $on = '', $params = [] )

$table

string|array

The table or sub-query to be joined.

Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. 'user u'). The method will automatically quote the table name unless it contains some parenthesis (which means the table is given as a sub-query or DB expression).

You may also specify the table as an array with one element, using the array key as the table alias (e.g. ['u' => 'user']).

To join a sub-query, use an array with one element, with the value set to a yii\db\Query object representing the sub-query, and the corresponding key representing the alias.

$on | string|array | The join condition that should appear in the ON part. Please refer to join() on how to specify this parameter.
$params | array | The parameters (name => value) to be bound to the query.
return | $this | The query object itself

Source code

                    public function innerJoin($table, $on = '', $params = [])
    {
        $this->join[] = ['INNER JOIN', $table, $on];
        return $this->addParams($params);
    }

innerJoinWith() public method

Inner joins with the specified relations.

This is a shortcut method to joinWith() with the join type set as "INNER JOIN". Please refer to joinWith() for detailed usage of this method.

See also joinWith().

public $this innerJoinWith ( $with, $eagerLoading = true )
$with | string|array | The relations to be joined with.
$eagerLoading | boolean|array | Whether to eager load the relations. Note, that this does not mean, that the relations are populated from the query result. An extra query will still be performed to bring in the related data.
return | $this | The query object itself

Source code

                    public function innerJoinWith($with, $eagerLoading = true)
    {
        return $this->joinWith($with, $eagerLoading, 'INNER JOIN');
    }

inverseOf() public method

Defined in: yii\db\ActiveRelationTrait::inverseOf()

Sets the name of the relation that is the inverse of this relation.

For example, a customer has orders, which means the inverse of the "orders" relation is the "customer". If this property is set, the primary record(s) will be referenced through the specified relation. For example, `$customer->orders[0]->customer` and `$customer` will be the same object, and accessing the customer of an order will not trigger a new DB query.

Use this method when declaring a relation in the yii\db\ActiveRecord class, e.g. in Customer model:

    public function getOrders()
    {
        return $this->hasMany(Order::class, ['customer_id' => 'id'])->inverseOf('customer');
    }

This also may be used for Order model, but with caution:

    public function getCustomer()
    {
        return $this->hasOne(Customer::class, ['id' => 'customer_id'])->inverseOf('orders');
    }

in this case result will depend on how order(s) was loaded. Let's suppose customer has several orders. If only one order was loaded:

    $orders = Order::find()->where(['id' => 1])->all();
    $customerOrders = $orders[0]->customer->orders;

variable `$customerOrders` will contain only one order. If orders was loaded like this:

    $orders = Order::find()->with('customer')->where(['customer_id' => 1])->all();
    $customerOrders = $orders[0]->customer->orders;

variable `$customerOrders` will contain all orders of the customer.

public $this inverseOf ( $relationName )
$relationName | string | The name of the relation that is the inverse of this relation.
return | $this | The relation object itself.

Source code

                    public function inverseOf($relationName)
    {
        $this->inverseOf = $relationName;
        return $this;
    }

isEmpty() protected method

Defined in: yii\db\QueryTrait::isEmpty()

Returns a value indicating whether the give value is "empty".

The value is considered "empty", if one of the following conditions is satisfied:

- it is `null`,
- an empty string (`''`),
- a string containing only whitespace characters,
- or an empty array.

protected boolean isEmpty ( $value )
$value | mixed |
return | boolean | If the value is empty

Source code

                    protected function isEmpty($value)
    {
        return $value === '' || $value === [] || $value === null || is_string($value) && trim($value) === '';
    }

join() public method

Defined in: yii\db\Query::join()

Appends a JOIN part to the query.

The first parameter specifies what type of join it is.

public $this join ( $type, $table, $on = '', $params = [] )
$type | string | The type of join, such as INNER JOIN, LEFT JOIN.

$table

string|array

The table or sub-query to be joined.

Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. 'user u'). The method will automatically quote the table name unless it contains some parenthesis (which means the table is given as a sub-query or DB expression).

You may also specify the table as an array with one element, using the array key as the table alias (e.g. ['u' => 'user']).

To join a sub-query, use an array with one element, with the value set to a yii\db\Query object representing the sub-query, and the corresponding key representing the alias.

$on

string|array

The join condition that should appear in the ON part. Please refer to where() on how to specify this parameter.

Note that the array format of where() is designed to match columns to values instead of columns to columns, so the following would not work as expected: `['post.author_id' => 'user.id']`, it would match the `post.author_id` column value against the string `'user.id'`. It is recommended to use the string syntax here which is more suited for a join:

    'post.author_id = user.id'

$params | array | The parameters (name => value) to be bound to the query.
return | $this | The query object itself

Source code

                    public function join($type, $table, $on = '', $params = [])
    {
        $this->join[] = [$type, $table, $on];
        return $this->addParams($params);
    }

joinWith() public method

Joins with the specified relations.

This method allows you to reuse existing relation definitions to perform JOIN queries. Based on the definition of the specified relation(s), the method will append one or multiple JOIN statements to the current query.

If the `$eagerLoading` parameter is true, the method will also perform eager loading for the specified relations, which is equivalent to calling with() using the specified relations.

Note that because a JOIN query will be performed, you are responsible to disambiguate column names.

This method differs from with() in that it will build up and execute a JOIN SQL statement for the primary table. And when `$eagerLoading` is true, it will call with() in addition with the specified relations.

public $this joinWith ( $with, $eagerLoading = true, $joinType = 'LEFT JOIN' )

$with

string|array

The relations to be joined. This can either be a string, representing a relation name or an array with the following semantics:

- Each array element represents a single relation.
- You may specify the relation name as the array key and provide an anonymous functions that can be used to modify the relation queries on-the-fly as the array value.
- If a relation query does not need modification, you may use the relation name as the array value.

The relation name may optionally contain an alias for the relation table (e.g. `books b`).

Sub-relations can also be specified, see with() for the syntax.

In the following you find some examples:

    // find all orders that contain books, and eager loading "books"
    Order::find()->joinWith('books', true, 'INNER JOIN')->all();
    // find all orders, eager loading "books", and sort the orders and books by the book names.
    Order::find()->joinWith([
        'books' => function (\yii\db\ActiveQuery $query) {
            $query->orderBy('item.name');
        }
    ])->all();
    // find all orders that contain books of the category 'Science fiction', using the alias "b" for the books table
    Order::find()->joinWith(['books b'], true, 'INNER JOIN')->where(['b.category' => 'Science fiction'])->all();

The alias syntax is available since version 2.0.7.

$eagerLoading

boolean|array

Whether to eager load the relations specified in `$with`. When this is a boolean, it applies to all relations specified in `$with`. Use an array to explicitly list which relations in `$with` need to be eagerly loaded. Note, that this does not mean, that the relations are populated from the query result. An extra query will still be performed to bring in the related data. Defaults to `true`.

$joinType | string|array | The join type of the relations specified in `$with`. When this is a string, it applies to all relations specified in `$with`. Use an array in the format of `relationName => joinType` to specify different join types for different relations.
return | $this | The query object itself

Source code

                    public function joinWith($with, $eagerLoading = true, $joinType = 'LEFT JOIN')
    {
        $relations = [];
        foreach ((array) $with as $name => $callback) {
            if (is_int($name)) {
                $name = $callback;
                $callback = null;
            }
            if (preg_match('/^(.*?)(?:\s+AS\s+|\s+)(\w+)$/i', $name, $matches)) {
                // relation is defined with an alias, adjust callback to apply alias
                list(, $relation, $alias) = $matches;
                $name = $relation;
                $callback = function ($query) use ($callback, $alias) {
                    /* @var $query ActiveQuery */
                    $query->alias($alias);
                    if ($callback !== null) {
                        call_user_func($callback, $query);
                    }
                };
            }
            if ($callback === null) {
                $relations[] = $name;
            } else {
                $relations[$name] = $callback;
            }
        }
        $this->joinWith[] = [$relations, $eagerLoading, $joinType];
        return $this;
    }

leftJoin() public method

Defined in: yii\db\Query::leftJoin()

Appends a LEFT OUTER JOIN part to the query.

public $this leftJoin ( $table, $on = '', $params = [] )

$table

string|array

The table or sub-query to be joined.

Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. 'user u'). The method will automatically quote the table name unless it contains some parenthesis (which means the table is given as a sub-query or DB expression).

You may also specify the table as an array with one element, using the array key as the table alias (e.g. ['u' => 'user']).

To join a sub-query, use an array with one element, with the value set to a yii\db\Query object representing the sub-query, and the corresponding key representing the alias.

$on | string|array | The join condition that should appear in the ON part. Please refer to join() on how to specify this parameter.
$params | array | The parameters (name => value) to be bound to the query
return | $this | The query object itself

Source code

                    public function leftJoin($table, $on = '', $params = [])
    {
        $this->join[] = ['LEFT JOIN', $table, $on];
        return $this->addParams($params);
    }

limit() public method

Defined in: yii\db\QueryTrait::limit()

Sets the LIMIT part of the query.

public $this limit ( $limit )
$limit | integer|yii\db\ExpressionInterface|null | The limit. Use null or negative value to disable limit.
return | $this | The query object itself

Source code

                    public function limit($limit)
    {
        $this->limit = $limit;
        return $this;
    }

max() public method

Defined in: yii\db\Query::max()

Returns the maximum of the specified column values.

public mixed max ( $q, $db = null )
$q | string | The column name or expression. Make sure you properly quote column names in the expression.
$db | yii\db\Connection|null | The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used.
return | mixed | The maximum of the specified column values.

Source code

                    public function max($q, $db = null)
    {
        return $this->queryScalar("MAX($q)", $db);
    }

min() public method

Defined in: yii\db\Query::min()

Returns the minimum of the specified column values.

public mixed min ( $q, $db = null )
$q | string | The column name or expression. Make sure you properly quote column names in the expression.
$db | yii\db\Connection|null | The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used.
return | mixed | The minimum of the specified column values.

Source code

                    public function min($q, $db = null)
    {
        return $this->queryScalar("MIN($q)", $db);
    }

noCache() public method (available since version 2.0.14)

Defined in: yii\db\Query::noCache()

Disables query cache for this Query.

public $this noCache ( )
return | $this | The Query object itself

Source code

                    public function noCache()
    {
        $this->queryCacheDuration = -1;
        return $this;
    }

normalizeOrderBy() protected method

Defined in: yii\db\QueryTrait::normalizeOrderBy()

Normalizes format of ORDER BY data.

protected array normalizeOrderBy ( $columns )
$columns | array|string|yii\db\ExpressionInterface|null | The columns value to normalize. See orderBy() and addOrderBy().

Source code

                    protected function normalizeOrderBy($columns)
    {
        if (empty($columns)) {
            return [];
        } elseif ($columns instanceof ExpressionInterface) {
            return [$columns];
        } elseif (is_array($columns)) {
            return $columns;
        }
        $columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
        $result = [];
        foreach ($columns as $column) {
            if (preg_match('/^(.*?)\s+(asc|desc)$/i', $column, $matches)) {
                $result[$matches[1]] = strcasecmp($matches[2], 'desc') ? SORT_ASC : SORT_DESC;
            } else {
                $result[$column] = SORT_ASC;
            }
        }
        return $result;
    }

normalizeSelect() protected method (available since version 2.0.21)

Defined in: yii\db\Query::normalizeSelect()

Normalizes the SELECT columns passed to select() or addSelect().

protected array normalizeSelect ( $columns )
$columns | string|array|yii\db\ExpressionInterface |

Source code

                    protected function normalizeSelect($columns)
    {
        if ($columns instanceof ExpressionInterface) {
            $columns = [$columns];
        } elseif (!is_array($columns)) {
            $columns = preg_split('/\s*,\s*/', trim((string)$columns), -1, PREG_SPLIT_NO_EMPTY);
        }
        $select = [];
        foreach ($columns as $columnAlias => $columnDefinition) {
            if (is_string($columnAlias)) {
                // Already in the normalized format, good for them
                $select[$columnAlias] = $columnDefinition;
                continue;
            }
            if (is_string($columnDefinition)) {
                if (
                    preg_match('/^(.*?)(?i:\s+as\s+|\s+)([\w\-_\.]+)$/', $columnDefinition, $matches) &&
                    !preg_match('/^\d+$/', $matches[2]) &&
                    strpos($matches[2], '.') === false
                ) {
                    // Using "columnName as alias" or "columnName alias" syntax
                    $select[$matches[2]] = $matches[1];
                    continue;
                }
                if (strpos($columnDefinition, '(') === false) {
                    // Normal column name, just alias it to itself to ensure it's not selected twice
                    $select[$columnDefinition] = $columnDefinition;
                    continue;
                }
            }
            // Either a string calling a function, DB expression, or sub-query
            $select[] = $columnDefinition;
        }
        return $select;
    }

off() public method

Defined in: yii\base\Component::off()

Detaches an existing event handler from this component.

This method is the opposite of on().

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

See also on().

public boolean off ( $name, $handler = null )
$name | string | Event name
$handler | callable|null | The event handler to be removed. If it is null, all handlers attached to the named event will be removed.
return | boolean | If a handler is found and detached

Source code

                    public function off($name, $handler = null)
    {
        $this->ensureBehaviors();
        if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
            return false;
        }
        if ($handler === null) {
            unset($this->_events[$name], $this->_eventWildcards[$name]);
            return true;
        }
        $removed = false;
        // plain event names
        if (isset($this->_events[$name])) {
            foreach ($this->_events[$name] as $i => $event) {
                if ($event[0] === $handler) {
                    unset($this->_events[$name][$i]);
                    $removed = true;
                }
            }
            if ($removed) {
                $this->_events[$name] = array_values($this->_events[$name]);
                return true;
            }
        }
        // wildcard event names
        if (isset($this->_eventWildcards[$name])) {
            foreach ($this->_eventWildcards[$name] as $i => $event) {
                if ($event[0] === $handler) {
                    unset($this->_eventWildcards[$name][$i]);
                    $removed = true;
                }
            }
            if ($removed) {
                $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
                // remove empty wildcards to save future redundant regex checks:
                if (empty($this->_eventWildcards[$name])) {
                    unset($this->_eventWildcards[$name]);
                }
            }
        }
        return $removed;
    }

offset() public method

Defined in: yii\db\QueryTrait::offset()

Sets the OFFSET part of the query.

public $this offset ( $offset )
$offset | integer|yii\db\ExpressionInterface|null | The offset. Use null or negative value to disable offset.
return | $this | The query object itself

Source code

                    public function offset($offset)
    {
        $this->offset = $offset;
        return $this;
    }

on() public method

Defined in: yii\base\Component::on()

Attaches an event handler to an event.

The event handler must be a valid PHP callback. The following are some examples:

    function ($event) { ... }         // anonymous function
    [$object, 'handleClick']          // $object->handleClick()
    ['Page', 'handleClick']           // Page::handleClick()
    'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

    function ($event)

where `$event` is an yii\base\Event object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

    $component->on('event.group.*', function ($event) {
        Yii::trace($event->name . ' is triggered.');
    });

See also off().

public void on ( $name, $handler, $data = null, $append = true )
$name | string | The event name
$handler | callable | The event handler
$data | mixed | The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data.
$append | boolean | Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

Source code

                    public function on($name, $handler, $data = null, $append = true)
    {
        $this->ensureBehaviors();
        if (strpos($name, '*') !== false) {
            if ($append || empty($this->_eventWildcards[$name])) {
                $this->_eventWildcards[$name][] = [$handler, $data];
            } else {
                array_unshift($this->_eventWildcards[$name], [$handler, $data]);
            }
            return;
        }
        if ($append || empty($this->_events[$name])) {
            $this->_events[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_events[$name], [$handler, $data]);
        }
    }

onCondition() public method

Sets the ON condition for a relational query.

The condition will be used in the ON part when yii\db\ActiveQuery::joinWith() is called. Otherwise, the condition will be used in the WHERE part of a query.

Use this method to specify additional conditions when declaring a relation in the yii\db\ActiveRecord class:

    public function getActiveUsers()
    {
        return $this->hasMany(User::class, ['id' => 'user_id'])
                    ->onCondition(['active' => true]);
    }

Note that this condition is applied in case of a join as well as when fetching the related records. Thus only fields of the related table can be used in the condition. Trying to access fields of the primary record will cause an error in a non-join-query.

public $this onCondition ( $condition, $params = [] )
$condition | string|array | The ON condition. Please refer to yii\db\Query::where() on how to specify this parameter.
$params | array | The parameters (name => value) to be bound to the query.
return | $this | The query object itself

Source code

                    public function onCondition($condition, $params = [])
    {
        $this->on = $condition;
        $this->addParams($params);
        return $this;
    }

one() public method

Executes query and returns a single row of result.

public yii\db\ActiveRecord|array|null one ( $db = null )
$db | yii\db\Connection|null | The DB connection used to create the DB command. If `null`, the DB connection returned by $modelClass will be used.
return | yii\db\ActiveRecord|array|null | A single row of query result. Depending on the setting of asArray(), the query result may be either an array or an ActiveRecord object. `null` will be returned if the query results in nothing.

Source code

                    public function one($db = null)
    {
        $row = parent::one($db);
        if ($row !== false) {
            $models = $this->populate([$row]);
            return reset($models) ?: null;
        }
        return null;
    }

orFilterHaving() public method (available since version 2.0.11)

Defined in: yii\db\Query::orFilterHaving()

Adds an additional HAVING condition to the existing one but ignores empty operands.

The new condition and the existing one will be joined using the `OR` operator.

This method is similar to orHaving(). The main difference is that this method will remove empty query operands. As a result, this method is best suited for building query conditions based on filter values entered by users.

See also:

- filterHaving()
- andFilterHaving()

public $this orFilterHaving ( array $condition )
$condition | array | The new HAVING condition. Please refer to having() on how to specify this parameter.
return | $this | The query object itself

Source code

                    public function orFilterHaving(array $condition)
    {
        $condition = $this->filterCondition($condition);
        if ($condition !== []) {
            $this->orHaving($condition);
        }
        return $this;
    }

orFilterWhere() public method

Defined in: yii\db\QueryTrait::orFilterWhere()

Adds an additional WHERE condition to the existing one but ignores empty operands.

The new condition and the existing one will be joined using the 'OR' operator.

This method is similar to orWhere(). The main difference is that this method will remove empty query operands. As a result, this method is best suited for building query conditions based on filter values entered by users.

See also:

- filterWhere()
- andFilterWhere()

public $this orFilterWhere ( array $condition )
$condition | array | The new WHERE condition. Please refer to where() on how to specify this parameter.
return | $this | The query object itself

Source code

                    public function orFilterWhere(array $condition)
    {
        $condition = $this->filterCondition($condition);
        if ($condition !== []) {
            $this->orWhere($condition);
        }
        return $this;
    }

orHaving() public method

Defined in: yii\db\Query::orHaving()

Adds an additional HAVING condition to the existing one.

The new condition and the existing one will be joined using the `OR` operator.

See also:

- having()
- andHaving()

public $this orHaving ( $condition, $params = [] )
$condition | string|array|yii\db\ExpressionInterface | The new HAVING condition. Please refer to where() on how to specify this parameter.
$params | array | The parameters (name => value) to be bound to the query.
return | $this | The query object itself

Source code

                    public function orHaving($condition, $params = [])
    {
        if ($this->having === null) {
            $this->having = $condition;
        } else {
            $this->having = ['or', $this->having, $condition];
        }
        $this->addParams($params);
        return $this;
    }

orOnCondition() public method

Adds an additional ON condition to the existing one.

The new condition and the existing one will be joined using the 'OR' operator.

See also:

- onCondition()
- andOnCondition()

public $this orOnCondition ( $condition, $params = [] )
$condition | string|array | The new ON condition. Please refer to where() on how to specify this parameter.
$params | array | The parameters (name => value) to be bound to the query.
return | $this | The query object itself

Source code

                    public function orOnCondition($condition, $params = [])
    {
        if ($this->on === null) {
            $this->on = $condition;
        } else {
            $this->on = ['or', $this->on, $condition];
        }
        $this->addParams($params);
        return $this;
    }

orWhere() public method

Defined in: yii\db\QueryTrait::orWhere()

Adds an additional WHERE condition to the existing one.

The new condition and the existing one will be joined using the 'OR' operator.

See also:

- where()
- andWhere()

public $this orWhere ( $condition )
$condition | string|array|yii\db\ExpressionInterface | The new WHERE condition. Please refer to where() on how to specify this parameter.
return | $this | The query object itself

Source code

                    public function orWhere($condition)
    {
        if ($this->where === null) {
            $this->where = $condition;
        } else {
            $this->where = ['or', $this->where, $condition];
        }
        return $this;
    }

orderBy() public method

Defined in: yii\db\QueryTrait::orderBy()

Sets the ORDER BY part of the query.

See also addOrderBy().

public $this orderBy ( $columns )

$columns

string|array|yii\db\ExpressionInterface|null

The columns (and the directions) to be ordered by. Columns can be specified in either a string (e.g. `"id ASC, name DESC"`) or an array (e.g. `['id' => SORT_ASC, 'name' => SORT_DESC]`).

The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression).

Note that if your order-by is an expression containing commas, you should always use an array to represent the order-by information. Otherwise, the method will not be able to correctly determine the order-by columns.

Since version 2.0.7, an yii\db\ExpressionInterface object can be passed to specify the ORDER BY part explicitly in plain SQL.

return | $this | The query object itself

Source code

                    public function orderBy($columns)
    {
        $this->orderBy = $this->normalizeOrderBy($columns);
        return $this;
    }

params() public method

Defined in: yii\db\Query::params()

Sets the parameters to be bound to the query.

See also addParams().

public $this params ( $params )
$params | array | List of query parameter values indexed by parameter placeholders. For example, `[':name' => 'Dan', ':age' => 31]`.
return | $this | The query object itself

Source code

                    public function params($params)
    {
        $this->params = $params;
        return $this;
    }

populate() public method

Converts the raw query results into the format as specified by this query.

This method is internally used to convert the data fetched from database into the format as required by this query.

public array populate ( $rows )
$rows | array | The raw query result from database
return | array | The converted query result

Source code

                    public function populate($rows)
    {
        if (empty($rows)) {
            return [];
        }
        $models = $this->createModels($rows);
        if (!empty($this->join) && $this->indexBy === null) {
            $models = $this->removeDuplicatedModels($models);
        }
        if (!empty($this->with)) {
            $this->findWith($this->with, $models);
        }
        if ($this->inverseOf !== null) {
            $this->addInverseRelations($models);
        }
        if (!$this->asArray) {
            foreach ($models as $model) {
                $model->afterFind();
            }
        }
        return parent::populate($models);
    }

populateRelation() public method

Defined in: yii\db\ActiveRelationTrait::populateRelation()

Finds the related records and populates them into the primary models.

public array populateRelation ( $name, &$primaryModels )
$name | string | The relation name
$primaryModels | array | Primary models
return | array | The related models
throws | yii\base\InvalidConfigException | if $link is invalid

Source code

                    public function populateRelation($name, &$primaryModels)
    {
        if (!is_array($this->link)) {
            throw new InvalidConfigException('Invalid link: it must be an array of key-value pairs.');
        }
        if ($this->via instanceof self) {
            // via junction table
            /* @var $viaQuery ActiveRelationTrait */
            $viaQuery = $this->via;
            $viaModels = $viaQuery->findJunctionRows($primaryModels);
            $this->filterByModels($viaModels);
        } elseif (is_array($this->via)) {
            // via relation
            /* @var $viaQuery ActiveRelationTrait|ActiveQueryTrait */
            list($viaName, $viaQuery) = $this->via;
            if ($viaQuery->asArray === null) {
                // inherit asArray from primary query
                $viaQuery->asArray($this->asArray);
            }
            $viaQuery->primaryModel = null;
            $viaModels = array_filter($viaQuery->populateRelation($viaName, $primaryModels));
            $this->filterByModels($viaModels);
        } else {
            $this->filterByModels($primaryModels);
        }
        if (!$this->multiple && count($primaryModels) === 1) {
            $model = $this->one();
            $primaryModel = reset($primaryModels);
            if ($primaryModel instanceof ActiveRecordInterface) {
                $primaryModel->populateRelation($name, $model);
            } else {
                $primaryModels[key($primaryModels)][$name] = $model;
            }
            if ($this->inverseOf !== null) {
                $this->populateInverseRelation($primaryModels, [$model], $name, $this->inverseOf);
            }
            return [$model];
        }
        // https://github.com/yiisoft/yii2/issues/3197
        // delay indexing related models after buckets are built
        $indexBy = $this->indexBy;
        $this->indexBy = null;
        $models = $this->all();
        if (isset($viaModels, $viaQuery)) {
            $buckets = $this->buildBuckets($models, $this->link, $viaModels, $viaQuery);
        } else {
            $buckets = $this->buildBuckets($models, $this->link);
        }
        $this->indexBy = $indexBy;
        if ($this->indexBy !== null && $this->multiple) {
            $buckets = $this->indexBuckets($buckets, $this->indexBy);
        }
        $link = array_values($this->link);
        if (isset($viaQuery)) {
            $deepViaQuery = $viaQuery;
            while ($deepViaQuery->via) {
                $deepViaQuery = is_array($deepViaQuery->via) ? $deepViaQuery->via[1] : $deepViaQuery->via;
            };
            $link = array_values($deepViaQuery->link);
        }
        foreach ($primaryModels as $i => $primaryModel) {
            $keys = null;
            if ($this->multiple && count($link) === 1) {
                $primaryModelKey = reset($link);
                $keys = isset($primaryModel[$primaryModelKey]) ? $primaryModel[$primaryModelKey] : null;
            }
            if (is_array($keys)) {
                $value = [];
                foreach ($keys as $key) {
                    $key = $this->normalizeModelKey($key);
                    if (isset($buckets[$key])) {
                        if ($this->indexBy !== null) {
                            // if indexBy is set, array_merge will cause renumbering of numeric array
                            foreach ($buckets[$key] as $bucketKey => $bucketValue) {
                                $value[$bucketKey] = $bucketValue;
                            }
                        } else {
                            $value = array_merge($value, $buckets[$key]);
                        }
                    }
                }
            } else {
                $key = $this->getModelKey($primaryModel, $link);
                $value = isset($buckets[$key]) ? $buckets[$key] : ($this->multiple ? [] : null);
            }
            if ($primaryModel instanceof ActiveRecordInterface) {
                $primaryModel->populateRelation($name, $value);
            } else {
                $primaryModels[$i][$name] = $value;
            }
        }
        if ($this->inverseOf !== null) {
            $this->populateInverseRelation($primaryModels, $models, $name, $this->inverseOf);
        }
        return $models;
    }

prepare() public method

Prepares for building SQL.

This method is called by yii\db\QueryBuilder when it starts to build SQL from a query object. You may override this method to do some final preparation work when converting a query into a SQL statement.

public $this prepare ( $builder )
$builder | yii\db\QueryBuilder |
return | $this | A prepared query instance which will be used by yii\db\QueryBuilder to build the SQL

Source code

                    public function prepare($builder)
    {
        // NOTE: because the same ActiveQuery may be used to build different SQL statements
        // (e.g. by ActiveDataProvider, one for count query, the other for row data query,
        // it is important to make sure the same ActiveQuery can be used to build SQL statements
        // multiple times.
        if (!empty($this->joinWith)) {
            $this->buildJoinWith();
            $this->joinWith = null;    // clean it up to avoid issue https://github.com/yiisoft/yii2/issues/2687
        }
        if (empty($this->from)) {
            $this->from = [$this->getPrimaryTableName()];
        }
        if (empty($this->select) && !empty($this->join)) {
            list(, $alias) = $this->getTableNameAndAlias();
            $this->select = ["$alias.*"];
        }
        if ($this->primaryModel === null) {
            // eager loading
            $query = Query::create($this);
        } else {
            // lazy loading of a relation
            $where = $this->where;
            if ($this->via instanceof self) {
                // via junction table
                $viaModels = $this->via->findJunctionRows([$this->primaryModel]);
                $this->filterByModels($viaModels);
            } elseif (is_array($this->via)) {
                // via relation
                /* @var $viaQuery ActiveQuery */
                list($viaName, $viaQuery, $viaCallableUsed) = $this->via;
                if ($viaQuery->multiple) {
                    if ($viaCallableUsed) {
                        $viaModels = $viaQuery->all();
                    } elseif ($this->primaryModel->isRelationPopulated($viaName)) {
                        $viaModels = $this->primaryModel->$viaName;
                    } else {
                        $viaModels = $viaQuery->all();
                        $this->primaryModel->populateRelation($viaName, $viaModels);
                    }
                } else {
                    if ($viaCallableUsed) {
                        $model = $viaQuery->one();
                    } elseif ($this->primaryModel->isRelationPopulated($viaName)) {
                        $model = $this->primaryModel->$viaName;
                    } else {
                        $model = $viaQuery->one();
                        $this->primaryModel->populateRelation($viaName, $model);
                    }
                    $viaModels = $model === null ? [] : [$model];
                }
                $this->filterByModels($viaModels);
            } else {
                $this->filterByModels([$this->primaryModel]);
            }
            $query = Query::create($this);
            $this->where = $where;
        }
        if (!empty($this->on)) {
            $query->andWhere($this->on);
        }
        return $query;
    }

queryScalar() protected method

Queries a scalar value by setting select() first.

Restores the value of select to make this query reusable.

protected boolean|string|null queryScalar ( $selectExpression, $db )
$selectExpression | string|yii\db\ExpressionInterface |
$db | yii\db\Connection|null | The database connection used to execute the query.
throws | Throwable | if can't create command

Source code

                    protected function queryScalar($selectExpression, $db)
    {
        /* @var $modelClass ActiveRecord */
        $modelClass = $this->modelClass;
        if ($db === null) {
            $db = $modelClass::getDb();
        }
        if ($this->sql === null) {
            return parent::queryScalar($selectExpression, $db);
        }
        $command = (new Query())->select([$selectExpression])
            ->from(['c' => "({$this->sql})"])
            ->params($this->params)
            ->createCommand($db);
        $this->setCommandCache($command);
        return $command->queryScalar();
    }

rightJoin() public method

Defined in: yii\db\Query::rightJoin()

Appends a RIGHT OUTER JOIN part to the query.

public $this rightJoin ( $table, $on = '', $params = [] )

$table

string|array

The table or sub-query to be joined.

Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. 'user u'). The method will automatically quote the table name unless it contains some parenthesis (which means the table is given as a sub-query or DB expression).

You may also specify the table as an array with one element, using the array key as the table alias (e.g. ['u' => 'user']).

To join a sub-query, use an array with one element, with the value set to a yii\db\Query object representing the sub-query, and the corresponding key representing the alias.

$on | string|array | The join condition that should appear in the ON part. Please refer to join() on how to specify this parameter.
$params | array | The parameters (name => value) to be bound to the query
return | $this | The query object itself

Source code

                    public function rightJoin($table, $on = '', $params = [])
    {
        $this->join[] = ['RIGHT JOIN', $table, $on];
        return $this->addParams($params);
    }

scalar() public method

Defined in: yii\db\Query::scalar()

Returns the query result as a scalar value.

The value returned will be the first column in the first row of the query results.

public string|integer|null|false scalar ( $db = null )
$db | yii\db\Connection|null | The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used.
return | string|integer|null|false | The value of the first column in the first row of the query result. False is returned if the query result is empty.

Source code

                    public function scalar($db = null)
    {
        if ($this->emulateExecution) {
            return null;
        }
        return $this->createCommand($db)->queryScalar();
    }

select() public method

Defined in: yii\db\Query::select()

Sets the SELECT part of the query.

public $this select ( $columns, $option = null )

$columns

string|array|yii\db\ExpressionInterface

The columns to be selected. Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']). Columns can be prefixed with table names (e.g. "user.id") and/or contain column aliases (e.g. "user.id AS user_id"). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression). A DB expression may also be passed in form of an yii\db\ExpressionInterface object.

Note that if you are selecting an expression like `CONCAT(first_name, ' ', last_name)`, you should use an array to specify the columns. Otherwise, the expression may be incorrectly split into several parts.

When the columns are specified as an array, you may also use array keys as the column aliases (if a column does not need alias, do not use a string key).

Starting from version 2.0.1, you may also select sub-queries as columns by specifying each such column as a `Query` instance representing the sub-query.

$option | string|null | Additional option that should be appended to the 'SELECT' keyword. For example, in MySQL, the option 'SQL_CALC_FOUND_ROWS' can be used.
return | $this | The query object itself

Source code

                    public function select($columns, $option = null)
    {
        $this->select = $this->normalizeSelect($columns);
        $this->selectOption = $option;
        return $this;
    }

setCommandCache() protected method (available since version 2.0.14)

Defined in: yii\db\Query::setCommandCache()

Sets $command cache, if this query has enabled caching.

protected yii\db\Command setCommandCache ( $command )
$command | yii\db\Command |

Source code

                    protected function setCommandCache($command)
    {
        if ($this->queryCacheDuration !== null || $this->queryCacheDependency !== null) {
            $duration = $this->queryCacheDuration === true ? null : $this->queryCacheDuration;
            $command->cache($duration, $this->queryCacheDependency);
        }
        return $command;
    }

sum() public method

Defined in: yii\db\Query::sum()

Returns the sum of the specified column values.

public mixed sum ( $q, $db = null )
$q | string | The column name or expression. Make sure you properly quote column names in the expression.
$db | yii\db\Connection|null | The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used.
return | mixed | The sum of the specified column values.

Source code

                    public function sum($q, $db = null)
    {
        if ($this->emulateExecution) {
            return 0;
        }
        return $this->queryScalar("SUM($q)", $db);
    }

trigger() public method

Defined in: yii\base\Component::trigger()

Triggers an event.

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

public void trigger ( $name, yii\base\Event $event = null )
$name | string | The event name
$event | yii\base\Event|null | The event instance. If not set, a default yii\base\Event object will be created.

Source code

                    public function trigger($name, Event $event = null)
    {
        $this->ensureBehaviors();
        $eventHandlers = [];
        foreach ($this->_eventWildcards as $wildcard => $handlers) {
            if (StringHelper::matchWildcard($wildcard, $name)) {
                $eventHandlers[] = $handlers;
            }
        }
        if (!empty($this->_events[$name])) {
            $eventHandlers[] = $this->_events[$name];
        }
        if (!empty($eventHandlers)) {
            $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
            if ($event === null) {
                $event = new Event();
            }
            if ($event->sender === null) {
                $event->sender = $this;
            }
            $event->handled = false;
            $event->name = $name;
            foreach ($eventHandlers as $handler) {
                $event->data = $handler[1];
                call_user_func($handler[0], $event);
                // stop further handling if the event is handled
                if ($event->handled) {
                    return;
                }
            }
        }
        // invoke class-level attached handlers
        Event::trigger($this, $name, $event);
    }

union() public method

Defined in: yii\db\Query::union()

Appends a SQL statement using UNION operator.

public $this union ( $sql, $all = false )
$sql | string|yii\db\Query | The SQL statement to be appended using UNION
$all | boolean | TRUE if using UNION ALL and FALSE if using UNION
return | $this | The query object itself

Source code

                    public function union($sql, $all = false)
    {
        $this->union[] = ['query' => $sql, 'all' => $all];
        return $this;
    }

via() public method

Defined in: yii\db\ActiveRelationTrait::via()

Specifies the relation associated with the junction table.

Use this method to specify a pivot record/table when declaring a relation in the yii\db\ActiveRecord class:

    class Order extends ActiveRecord
    {
       public function getOrderItems() {
           return $this->hasMany(OrderItem::class, ['order_id' => 'id']);
       }

       public function getItems() {
           return $this->hasMany(Item::class, ['id' => 'item_id'])
                       ->via('orderItems');
       }
    }

public $this via ( $relationName, callable $callable = null )
$relationName | string | The relation name. This refers to a relation declared in $primaryModel.
$callable | callable|null | A PHP callback for customizing the relation associated with the junction table. Its signature should be `function($query)`, where `$query` is the query to be customized.
return | $this | The relation object itself.

Source code

                    public function via($relationName, callable $callable = null)
    {
        $relation = $this->primaryModel->getRelation($relationName);
        $callableUsed = $callable !== null;
        $this->via = [$relationName, $relation, $callableUsed];
        if ($callable !== null) {
            call_user_func($callable, $relation);
        }
        return $this;
    }

viaTable() public method

Specifies the junction table for a relational query.

Use this method to specify a junction table when declaring a relation in the yii\db\ActiveRecord class:

    public function getItems()
    {
        return $this->hasMany(Item::class, ['id' => 'item_id'])
                    ->viaTable('order_item', ['order_id' => 'id']);
    }

See also via().

public $this viaTable ( $tableName, $link, callable $callable = null )
$tableName | string | The name of the junction table.
$link | array | The link between the junction table and the table associated with $primaryModel. The keys of the array represent the columns in the junction table, and the values represent the columns in the $primaryModel table.
$callable | callable|null | A PHP callback for customizing the relation associated with the junction table. Its signature should be `function($query)`, where `$query` is the query to be customized.
return | $this | The query object itself
throws | yii\base\InvalidConfigException | when query is not initialized properly

Source code

                    public function viaTable($tableName, $link, callable $callable = null)
    {
        $modelClass = $this->primaryModel ? get_class($this->primaryModel) : $this->modelClass;
        $relation = new self($modelClass, [
            'from' => [$tableName],
            'link' => $link,
            'multiple' => true,
            'asArray' => true,
        ]);
        $this->via = $relation;
        if ($callable !== null) {
            call_user_func($callable, $relation);
        }
        return $this;
    }

where() public method

Defined in: yii\db\QueryTrait::where()

Sets the WHERE part of the query.

See yii\db\QueryInterface::where() for detailed documentation.

See also:

- andWhere()
- orWhere()

public $this where ( $condition )
$condition | string|array|yii\db\ExpressionInterface | The conditions that should be put in the WHERE part.
return | $this | The query object itself

Source code

                    public function where($condition)
    {
        $this->where = $condition;
        return $this;
    }

with() public method

Defined in: yii\db\ActiveQueryTrait::with()

Specifies the relations with which this query should be performed.

The parameters to this method can be either one or multiple strings, or a single array of relation names and the optional callbacks to customize the relations.

A relation name can refer to a relation defined in $modelClass or a sub-relation that stands for a relation of a related record. For example, `orders.address` means the `address` relation defined in the model class corresponding to the `orders` relation.

The following are some usage examples:

    // find customers together with their orders and country
    Customer::find()->with('orders', 'country')->all();
    // find customers together with their orders and the orders' shipping address
    Customer::find()->with('orders.address')->all();
    // find customers together with their country and orders of status 1
    Customer::find()->with([
        'orders' => function (\yii\db\ActiveQuery $query) {
            $query->andWhere('status = 1');
        },
        'country',
    ])->all();

You can call `with()` multiple times. Each call will add relations to the existing ones. For example, the following two statements are equivalent:

    Customer::find()->with('orders', 'country')->all();
    Customer::find()->with('orders')->with('country')->all();

public $this with ( )
return | $this | The query object itself

Source code

                    public function with()
    {
        $with = func_get_args();
        if (isset($with[0]) && is_array($with[0])) {
            // the parameter is given as an array
            $with = $with[0];
        }
        if (empty($this->with)) {
            $this->with = $with;
        } elseif (!empty($with)) {
            foreach ($with as $name => $value) {
                if (is_int($name)) {
                    // repeating relation is fine as normalizeRelations() handle it well
                    $this->with[] = $value;
                } else {
                    $this->with[$name] = $value;
                }
            }
        }
        return $this;
    }

withQuery() public method (available since version 2.0.35)

Defined in: yii\db\Query::withQuery()

Prepends a SQL statement using WITH syntax.

public $this withQuery ( $query, $alias, $recursive = false )
$query | string|yii\db\Query | The SQL statement to be prepended using WITH
$alias | string | Query alias in WITH construction
$recursive | boolean | TRUE if using WITH RECURSIVE and FALSE if using WITH
return | $this | The query object itself

Source code

                    public function withQuery($query, $alias, $recursive = false)
    {
        $this->withQueries[] = ['query' => $query, 'alias' => $alias, 'recursive' => $recursive];
        return $this;
    }

## Event Details

Hide inherited properties

EVENT_INIT event of type yii\db\Event

An event that is triggered when the query is initialized via init().