Как в выборке yii2 работать с дополнительными полями и связанными моделями?

Question

[v3shin]

Есть модель MyClass и его дочерняя модель SubClass.

/**
 * @var int $id
 * @var string $a
 * @var string $b
*/
class MyClass extends ActiveRecord
{
    public function getParam()
    {
        return $this->a . $this->b;
    }
    public function getSubClass()
    {
        return $this->hasOne(SubClass::class, ['parent_id' => 'id']);
    }
}

/**
 * @var int $id
 * @var int $parent_id
 * @var string $c
 * @var string $d
*/
class SubClass extends ActiveRecord {}

Выборка выполняется кодом в контроллере:

Yii::$app->response->format = Response::FORMAT_JSON;
$models = MyClass::find()->where(...)->all();
return [
    'models' => $models,
];

Мне нужно, чтобы выборка была в виде:

[
    'a' => MyClass::a,
    'param' => MyClass::param,
    'child' => [
        'c' => SubClass::c,
    ],
]

Особенности:
- модель MyClass ограничивается полем a
- в дополнении к полям MyClass с помощью геттера получается поле param
- модель SubClass ограничивается полем c (хотя связь идет через parent_id)

Как мне красиво переписать код, чтобы получить такую выборку?

Answer 1

[Александр]

$models = MyClass::find()->where(...)->with('sub_class')->asArray()->all();

Comments

[v3shin]

Вернет все поля. А мне нужна отсечка по определенным. Технически, могу использовать fields(), но как быть с дочерним классом и геттерами?

[Александр]

v3shin, В селекте укажи какие нужны))
MyClass::find()->alias('m')->select('m.1, m.2, s.1')->where(...)->with('sub_class s')->asArray()->all();

[v3shin]

Это уже ближе. Только, скорее,

MyClass::find()
    ->alias('m')
    ->select('m.1, m.2, m.id')
    ->where(...)
    ->joinWith(['subClass' => static function ($query) {
        $query->select('s.1, s.parent_id');
    }])
    ->asArray()
    ->all();

Так и вложенность сохраняется, и код получается рабочим. А как быть с геттерами?

[Александр]

v3shin, Гетерры не будут работать если использовать asArray. Я бы на вашем месте наверное написал отдельную функцию которая бы выполняла getParam() принимала нужные переменные для обработки.
Или в селекте сделать CONCAT(s.1, s.parent_id) AS column_name;
Как то так:

MyClass::find()
    ->alias('m')
    ->select('m.1, m.2, m.id, s1. column_name')
    ->where(...)
    ->joinWith(['subClass' => static function ($query) {
        $query->alias('s1');
        $query->select(' CONCAT(s.1, s.parent_id) AS s1. column_name');
    }])
    ->asArray()
    ->all();

Answer 2

[Arkham]

Используйте `with` и `asArray`

https://www.yiiframework.com/doc/guide/2.0/ru/db-a...

Comments

[v3shin]

И как должна будет выглядеть выборка?

MyClass::find()->where(...)->with(['param'])->asArray()->all();

не сработает потому что param - не relation.

[Arkham]

В with идёт имя подсущности, в данном случае `->with(['sub_class'])`
Ниже уже дали аналогичный ответ

[Arkham]

Если нужно чтобы `getParam` всегда вызывался как условие `where`, то добавьте его в `hasOne`

[v3shin]

Arkham, как будет выглядеть код, в котором "getParam", добавленный в "hasOne" будет вызываться "как условие where"?

[Arkham]

v3shin, `hasOne(SubClass::class, ['parent_id' => 'id', ['field' => $this->getParam()]]);`

[v3shin]

Arkham, гениальный код. Жаль только, что не рабочий.

[Arkham]

v3shin, неуважаемый "гений", вам как минимум нужен правильный `field` для работы. А всё остальное есть в доках по ссылке выше.

[v3shin]

Arkham, да читал я доки, и в исходниках копался, и разные варианты пробовал. Вот думаю, что я пропустил. Пока что у меня получилось реализовать задачу через манипуляцию fields(), но решение выглядит корявым. Вот я и спрашиваю, как сделать красиво. Вы же кидаете ссылку на официальные доки и пишете решение, не вдаваясь в особенности фреймворка.

[Arkham]

v3shin, опишите зачем и как вы используете `getParam`.

Судя по итоговой выборке:
```
[
'a' => MyClass::a,
'param' => MyClass::param,
'child' => [
'c' => SubClass::c,
],
]
``

У вас должен получиться ORM запрос вида (нет IDE под рукой чтобы проверить):
```
$query = MyClass::find()
->select([
'a',
'param', // Тут непонятно, что именно вы хотите получать. Если это вычисляемое поле, то оберните в Expression и вычисляйте на языке SQL. Прокинуть внутрь SQL вычисления PHP метода не выйдет.
]);

$query->joinWith(''sub_class child')->addSelect('child.c');

$result = $query
->asArray()
->all()
```

[v3shin]

Param - это геттер, рассчитывающий значение на основе полей модели без запроса в БД.
select() работает только с полями БД.
with() добавляет к выборке только настоящие relation.
Переписывать функцию fields() можно, но тогда во всех выборках модели будут возвращаться описанные там поля, без возможности управления ими.
Есть вариант после выборки пройтись foreach по всем записям и вручную указать, какие поля нужны, но это некрасиво. Вдобавок, экшен у меня не простой, а MyAction extends Action, что позволяет настраивать его с помощью дополнительных параметров, но не позволяет хардкодить.

[Arkham]

Тогда варианта три:
1. Не использовать asArray - возвращать объект, и у него уже вызывать getParam
2. foreach с установкой значений
3. Вместо php метода использовать SQL Expression с аналогичной логикой

Answer 3

[v3shin]

Так как задача была срочной, сделал свою кривую кастомку, позволяющую управлять выборками полей. Я воспользовался тем фактом, что при отдаче ответа в формате Response::FORMAT_JSON для каждой модели вызывается toArray() без параметров, что, в свою очередь, опирается на fields().

class MyActiveRecord extends \yii\db\ActiveRecord
{
    public static $usedExtraFields = [];
    public static function getExtraFields(): array
    {
        return [];
    }
    public static function useExtraFields(?array $keys = null): void
    {
        if (($keys[0] ?? null) === '*') $keys = null;
        static::$usedExtraFields[static::class] = $keys;
    }
    public function fields(): array
    {
        $extraFields = static::getExtraFields();
        if ((static::$usedExtraFields[static::class] ?? null) !== null) {
            $extraFields = ArrayHelper::filter($extraFields, static::$usedExtraFields[static::class]);
        }
        return array_merge(parent::fields(), $extraFields);
    }
}

// классы наследуются от MyActiveRecord и перегружают getExtraFields()
class MyClass extends MyActiveRecord
{
    public static function getExtraFields(): array
    {
        return [
            'param' => 'param',
            'child' => static function ($model) {
                return $model->getSubClass()->select('c')->one();
            },
        ];
    }
}

// используется это так:
Yii::$app->response->format = Response::FORMAT_JSON;
MyClass::useExtraFields([]); // запретить дополнительные поля
MyClass::useExtraFields(['param']); // ограничить дополнительные поля
MyClass::useExtraFields(['child']); // ограничить дополнительные поля
MyClass::useExtraFields(); // разрешить все дополнительные поля
$models = MyClass::find()->where(...)->all();
return [
    'models' => $models,
];

Но все еще в поиске элегантного решения.