0 关注者

Trait yii\db\ActiveQueryTrait

所有类 | 属性 | 方法
实现于yii\db\ActiveQuery
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/db/ActiveQueryTrait.php

ActiveQueryTrait 实现活动记录查询类的通用方法和属性。

公共属性

隐藏继承属性

属性 类型 描述 定义于
$asArray boolean 是否将每个记录作为数组返回。 yii\db\ActiveQueryTrait
$modelClass string ActiveRecord 类的名称。 yii\db\ActiveQueryTrait
$with array 此查询应与其一起执行的关系列表 yii\db\ActiveQueryTrait

公共方法

隐藏继承方法

方法 描述 定义于
asArray() 设置 asArray() 属性。 yii\db\ActiveQueryTrait
findWith() 查找与一个或多个关系对应的记录，并将它们填充到主模型中。 yii\db\ActiveQueryTrait
with() 指定此查询应与其一起执行的关系。 yii\db\ActiveQueryTrait

受保护方法

隐藏继承方法

方法 描述 定义于
createModels() 将找到的行转换为模型实例。 yii\db\ActiveQueryTrait

属性详情

隐藏继承属性

$asArray 公共属性

是否将每个记录作为数组返回。如果为 false（默认值），则将创建 $modelClass 的对象来表示每个记录。

public boolean $asArray = null
$modelClass 公共属性

ActiveRecord 类的名称。

public string $modelClass = null
$with 公共属性

此查询应与其一起执行的关系列表

public array $with = null

方法详情

隐藏继承方法

asArray() 公共方法

设置 asArray() 属性。

public $this asArray ( $value = true )
$value boolean

是否以数组而不是活动记录的形式返回查询结果。
返回值 $this

查询对象本身

 

                public function asArray($value = true)
{
    $this->asArray = $value;
    return $this;
}
createModels() 受保护方法 (自 2.0.11 版本起可用)

将找到的行转换为模型实例。

protected array|yii\db\ActiveRecord[] createModels ( $rows )
$rows array 

                protected function createModels($rows)
{
    if ($this->asArray) {
        return $rows;
    } else {
        $models = [];
        /* @var $class ActiveRecord */
        $class = $this->modelClass;
        foreach ($rows as $row) {
            $model = $class::instantiate($row);
            $modelClass = get_class($model);
            $modelClass::populateRecord($model, $row);
            $models[] = $model;
        }
        return $models;
    }
}
findWith() 公共方法

查找与一个或多个关系对应的记录，并将它们填充到主模型中。

public void findWith ( $with, &$models )
$with array

此查询应与其一起执行的关系列表。有关指定此参数的详细信息，请参阅 with()。
$models array|yii\db\ActiveRecord[]

主模型（可以是 AR 实例或数组）

 

                public function findWith($with, &$models)
{
    if (empty($models)) {
        return;
    }
    $primaryModel = reset($models);
    if (!$primaryModel instanceof ActiveRecordInterface) {
        /* @var $modelClass ActiveRecordInterface */
        $modelClass = $this->modelClass;
        $primaryModel = $modelClass::instance();
    }
    $relations = $this->normalizeRelations($primaryModel, $with);
    /* @var $relation ActiveQuery */
    foreach ($relations as $name => $relation) {
        if ($relation->asArray === null) {
            // inherit asArray from primary query
            $relation->asArray($this->asArray);
        }
        $relation->populateRelation($name, $models);
    }
}
with() 公共方法

指定此查询应与其一起执行的关系。

此方法的参数可以是一个或多个字符串，或者是一个包含关系名称和可选回调的数组以自定义关系。

关系名称可以指代在 $modelClass 中定义的关系，也可以指代表示关联记录的关系的子关系。例如，orders.address 表示在对应于 orders 关系的模型类中定义的 address 关系。

以下是一些使用示例

// find customers together with their orders and country
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
Customer::find()->with([
    'orders' => function (\yii\db\ActiveQuery $query) {
        $query->andWhere('status = 1');
    },
    'country',
])->all();

您可以多次调用 with() 方法。每次调用都会将关系添加到现有的关系中。例如，以下两个语句是等效的

Customer::find()->with('orders', 'country')->all();
Customer::find()->with('orders')->with('country')->all();
public $this with ( )
返回值 $this

查询对象本身

 

                public function with()
{
    $with = func_get_args();
    if (isset($with[0]) && is_array($with[0])) {
        // the parameter is given as an array
        $with = $with[0];
    }
    if (empty($this->with)) {
        $this->with = $with;
    } elseif (!empty($with)) {
        foreach ($with as $name => $value) {
            if (is_int($name)) {
                // repeating relation is fine as normalizeRelations() handle it well
                $this->with[] = $value;
            } else {
                $this->with[$name] = $value;
            }
        }
    }
    return $this;
}