PHP Трейт yii\db\ActiveQueryTrait

С версии: 2.0
Автор: Qiang Xue ([email protected])
Автор: Carsten Brandt ([email protected])
Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$asArray whether to return each record as an array. If false (default), an object of [[modelClass]] will be created to represent each record.
$modelClass the name of the ActiveRecord class.
$with a list of relations that this query should be performed with

Открытые методы

Метод Описание
asArray ( boolean $value = true ) Sets the [[asArray]] property.
findWith ( array $with, array | ActiveRecord[] &$models ) Finds records corresponding to one or multiple relations and populates them into the primary models.
with ( ) Specifies the relations with which this query should be performed.

Защищенные методы

Метод Описание
createModels ( array $rows ) : array | ActiveRecord[] Converts found rows into model instances

Приватные методы

Метод Описание
normalizeRelations ( ActiveRecord $model, array $with ) : yii\db\ActiveQueryInterface[]

Описание методов

asArray() публичный Метод

Sets the [[asArray]] property.
public asArray ( boolean $value = true )
$value boolean whether to return the query results in terms of arrays instead of Active Records.

createModels() защищенный Метод

Converts found rows into model instances
С версии: 2.0.11
protected createModels ( array $rows ) : array | ActiveRecord[]
$rows array
Результат array | ActiveRecord[]

findWith() публичный Метод

Finds records corresponding to one or multiple relations and populates them into the primary models.
public findWith ( array $with, array | ActiveRecord[] &$models )
$with array a list of relations that this query should be performed with. Please refer to [[with()]] for details about specifying this parameter.
$models array | ActiveRecord[] the primary models (can be either AR instances or arrays)

with() публичный Метод

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. 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 following are some usage examples: php 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(); You can call with() multiple times. Each call will add relations to the existing ones. For example, the following two statements are equivalent: php Customer::find()->with('orders', 'country')->all(); Customer::find()->with('orders')->with('country')->all();
public with ( )

Описание свойств

$asArray публичное свойство

whether to return each record as an array. If false (default), an object of [[modelClass]] will be created to represent each record.
public $asArray

$modelClass публичное свойство

the name of the ActiveRecord class.
public $modelClass

$with публичное свойство

a list of relations that this query should be performed with
public $with