Commit bc393ff5 by Qiang Xue

added doc about sub-relation.

parent 3701cbd5
...@@ -182,11 +182,18 @@ class ActiveQuery extends Query ...@@ -182,11 +182,18 @@ class ActiveQuery extends Query
* The parameters to this method can be either one or multiple strings, or a single array * 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. * 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 followings are some usage examples: * The followings are some usage examples:
* *
* ~~~ * ~~~
* // find customers together with their orders and country * // find customers together with their orders and country
* Customer::find()->with('orders', 'country')->all(); * 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 * // find customers together with their country and orders of status 1
* Customer::find()->with([ * Customer::find()->with([
* 'orders' => function($query) { * 'orders' => function($query) {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment