Class yii\db\ActiveQuery

The model class associated with this query

Configurations to be applied to the newly created query object

The table alias.

The query object itself

The DB connection used to create the DB command. If null, the DB connection returned by $modelClass will be used.

The query results. If the query results in nothing, an empty array will be returned.

The new ON condition. Please refer to where() on how to specify this parameter.

The parameters (name => value) to be bound to the query.

The query object itself

The DB connection used to create the DB command. If null, the DB connection returned by $modelClass will be used.

The created DB command instance.

Primary table name

The table name and the table alias.

The relations to be joined with.

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.

The query object itself

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.

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.

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.

The query object itself

The ON condition. Please refer to yii\db\Query::where() on how to specify this parameter.

The parameters (name => value) to be bound to the query.

The query object itself

The DB connection used to create the DB command. If null, the DB connection returned by $modelClass will be used.

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.

The new ON condition. Please refer to where() on how to specify this parameter.

The parameters (name => value) to be bound to the query.

The query object itself

The name of the junction table.

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.

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.

The query object itself

when query is not initialized properly