W3cubDocs

/Yii 2.0

Trait yii\db\ActiveRelationTrait

Implemented by yii\db\ActiveQuery, yii\elasticsearch\ActiveQuery, yii\mongodb\ActiveQuery, yii\mongodb\file\ActiveQuery, yii\redis\ActiveQuery, yii\sphinx\ActiveQuery
Available since version 2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveRelationTrait.php

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

Public Properties

Property Type Description Defined By
$inverseOf string The name of the relation that is the inverse of this relation. yii\db\ActiveRelationTrait
$multiple boolean Whether this query represents a relation to more than one record. yii\db\ActiveRelationTrait
$primaryModel yii\db\ActiveRecord The primary model of a relational query. yii\db\ActiveRelationTrait
$via array|object The query associated with the junction table. yii\db\ActiveRelationTrait

Public Methods

Method Description Defined By
__clone() Clones internal objects. yii\db\ActiveRelationTrait
findFor() Finds the related records for the specified primary record. yii\db\ActiveRelationTrait
inverseOf() Sets the name of the relation that is the inverse of this relation. yii\db\ActiveRelationTrait
populateRelation() Finds the related records and populates them into the primary models. yii\db\ActiveRelationTrait
via() Specifies the relation associated with the junction table. yii\db\ActiveRelationTrait

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

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

__clone() public method

Clones internal objects.

public void __clone ( )

findFor() public method

Finds the related records for the specified primary record.

This method is invoked when a relation of an ActiveRecord is being accessed in a lazy fashion.

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\InvalidParamException

if the relation is invalid

inverseOf() public method

Sets 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 a new DB query.

Use this method when declaring a relation in the yii\db\ActiveRecord class:

public function getOrders()
{
    return $this->hasMany(Order::className(), ['customer_id' => 'id'])->inverseOf('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.

populateRelation() public method

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

via() public method

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::className(), ['order_id' => 'id']);
   }

   public function getItems() {
       return $this->hasMany(Item::className(), ['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

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.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-db-activerelationtrait.html