Trait yii\db\ActiveQueryTrait

Implemented byyii\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 public 属性

是否将每条记录作为数组返回. 如果为false(默认), 则会创建 $modelClass 的对象来表示每条记录.

public boolean $asArray null
$modelClass public 属性

ActiveRecord 类的名称.

public string $modelClass null
$with public 属性

应当执行此查询的关系列表.

public array $with null

方法详情

asArray() public 方法

设置 asArray() 属性.

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

是否以数组(而不是以活动记录)的形式返回查询结果.

return $this

查询对象本身.

createModels() protected 方法 (可用自版本: 2.0.11)

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

protected array|yii\db\ActiveRecord[] createModels ( $rows )
$rows array
findWith() public 方法

查找与一个或多个关系相对应的记录, 并将其填充到主要模型中.

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

应当执行此查询的关系的列表. 有关指定此参数的详细信息, 请参阅 with().

$models array|yii\db\ActiveRecord[]

主要模型(可以是 AR 实例或数组).

with() public 方法

指定应该执行此查询的关系.

此方法的参数可以是一个或多个字符串, 也可以是单个关系名称数组以及用于自定义关系的可选回调函数.

关系名称可以引用 $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 ( )
return $this

查询对象本身.