db\ActiveQuery joinWith()

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. 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