Trait yii\db\ActiveRelationTrait

ActiveRelationTrait implements the common methods and properties for active record relational queries.

Public Properties

Public Methods

Property Details

$inverseOf public property

The name of the relation that is the inverse of this relation. For example, an order has a customer, which means the inverse of the "customer" relation is the "orders", and 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 new DB query. This property is only used in relational context.

See also inverseOf().

public string $inverseOf = null

$link public property

The columns of the primary and foreign tables that establish a relation. The array keys must be columns of the table for this relation, and the array values must be the corresponding columns from the primary table. Do not prefix or quote the column names as this will be done automatically by Yii. This property is only used in relational context.

public array $link = null

$multiple public property

Whether this query represents a relation to more than one record. This property is only used in relational context. If true, this relation will populate all query results into AR instances using all(). If false, only the first row of the results will be retrieved using one().

public boolean $multiple = null

$primaryModel public property

The primary model of a relational query. This is used only in lazy loading with dynamic query options.

public yii\db\ActiveRecord $primaryModel = null

$via public property

The query associated with the junction table. Please call via() to set this property instead of directly setting it. This property is only used in relational context.

See also via().

public array|object $via = null

Method Details

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

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

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