Добавление массивов в ответ сервера. REST на Yii2?

Question

[Isherath]

Есть страница с вакансиями, где отображены вакансии по работодателю. Нужно с сервера вернуть пачку вакансий и информацию о работодателе, чтобы отобразить название компании, чтобы люди могли видеть, кому принадлежат эти вакансии. Как это сделать?

Есть ActiveDataProvider:

$vacancies = new ArrayDataProvider([
            'allModels' => Vacancy::find()->where(['creator' => $creator]),
            'pagination' => [
                'pageSize' => 30
            ]
       ]);
return $vacancies;

Все это работает хорошо. Присутствует пагинация и все такое.

Но это только пачка вакансий. Есть так же запрос на информацию о работодателе, который возвращает название компании:

$employer = Profile::find()->select('company')->where(['user' => $creator])->one();

Как все это объединить и отослать на клиент так, чтобы у меня были и вакансий пачка с пагинацией и инфа о работодателе??

Answer 1

[Дмитрий]

Добрый вечер.
Необходимо настроить связи между моделями.
Выглядит это примерно так:
Модель Profile
В таблице профиля берётся id записи, в данном случае "id" и ищется в таблице вакансий, в которой должен быть "id_company" соответствующий id профиля компании.

public function getVacancy()
{
    return $this->hasMany(Vacancy::class, ['id_company' => 'id']); // у одного профиля может быть много вакансий
}

Модель Vacancy

public function getProfile()
{
    return $this->hasOne(Profile::class, ['id' => 'id_company']); // у одной вакансии может быть только один профиль.
}

Тогда Ваш запрос превращается в такой:

$vacancies = new ArrayDataProvider([
            'allModels' => Vacancy::find()->with('profile')->where(['creator' => $creator]),
            'pagination' => [
                'pageSize' => 30
            ]
       ]);
return $vacancies;

Получить имя профиля можно так
echo $vacancies->profile->company;
Подробней здесь.

Comments

[Isherath]

Добрый. Сделал так, но это не совсем то. При таком раскладе ActiveDataProvider возвращает все ту же пачку вакансий, но в них просто добавляется название компании, для каждой вакансии из этой пачки. А мне нужно сделать так, чтобы название компании не добавлялось а существовало отдельно от пачки в ответе сервера. Чтобы на клиенте просто было видно в верху списка вакансий название компании.

[Дмитрий]

Isherath, тогда начните не с выбора вакансий, а с выбора компании. И по связи получите все вакансии компании.

[Isherath]

slo_nik, сделал и так, но пагинация теперь работает только для компании (где она не нужна), а для вакансий пагинации нету, что логично. Вот в этом и вся проблема: либо я не получаю инфу о компании, либо я не могу переключать страницы, и если одна компания постит 1000 вакансий, то оставить все как есть - не вариант.

[Дмитрий]

Isherath, используйте для пагинации по вакансиям LinkPager

[Дмитрий]

Isherath, так же можно попробовать изменить саму связь.
Связь возвращает ActiveQuery, а значит можно добавить разные условия для выборки.

[Isherath]

slo_nik, все перепробовал, Либо нет пагинации, но есть инфо о компании, либо пагинаяция есть, но инфо о компании прицепить нельзя. не очень гибкий фреймворк.

[Дмитрий]

не очень гибкий фреймворк.

Isherath, скорей уж всего не очень гибкие Ваши знания, это уж точно.)))

все перепробовал

Что именно?

[Isherath]

slo_nik, перепробовал все, что вы написали. Насчет знаний, не спорю, я не так давно на нем пытаюсь что-то писать.

Мне до этого момента нравилось как работает ActiveDataProvider, достает все что нужно, разбивает на страницы как надо, переключается тоже все очень хорошо. Но как организовать вложенность типа: Компания -> Вакансии компании, при этом, чтобы я мог перемещаться по страницам вакансий и мог видеть, какой компании все эти вакансии принадлежат? Ума не приложу.

Связывание таблиц никак не помогает, оно просто цепляет доп.поле в котором инфа о вакансии, но мне не нужно это.

Ответ сервера на запрос клиента должен возвращать такое:

data: {
company: 'Рога и копыта',
vacancies: {пачка вакансий с инфой о пагинации.....то что возвращает ActiveDataProvider}
}

Вот и все. Но как это делать в этом фреймворке - непонятно.

[Дмитрий]

я не так давно на нем пытаюсь что-то писать.

Isherath, и после этого Вы утверждаете, что это не очень гибкий framework? Ну-ну)))

Связывание таблиц никак не помогает

Помогает, просто Вы неверно используете связи.

Но как это делать в этом фреймворке - непонятно

Читать документацию, по ссылке, которую я дал - в первую очередь.
Так же могу порекомендовать видео к обязательному просмотру.
Ну и по Rest в yii2.

[Isherath]

slo_nik, ту документацию, что вы скинули, я прочитал, это все у меня работает прекрасно. Но мне нужно совсем не то.
Я должен получить массив, где будут два массива, первый с инфой о компании, второй - с вакансиями этой компании и данными о пагинации (солво страниц и т.д).

Обычное связываение делает совсем не то. Мне просто инфу о компании включает в массив с вакансиями, это не то, что мне нужно.

Представьте просто что вы зашли на страницу категории магазина, где написано как она называется и представлены товары этой категории и вы можете перемещаться по страницам товаров этой категории, вот и все. Я не понимаю, как это сделать в этом фреймворке. ActiveDataProvider с этим явно не может справится.

[Дмитрий]

Isherath, вот небольшой пример с моего проекта.
Выводится название категории и все товары принадлежащие этой категории. Почти что Ваш случай. Надо только будет переделать под Ваши нужды запрос.

$query = Catalog::find()
    ->from(['catalog' => Catalog::tableName()])
    ->where(['catalog.status' => Catalog::STATUS_ACTIVE, 'catalog.parent_id' => null])
    ->with(['categories'])
    ->innerJoinWith([
        'categories categories',
        'categories.products prod' => function(ActiveQuery $query){
            $query->andOnCondition(['prod.status' => Products::STATUS_ACTIVE]);
        }
    ]);

$dataProvider = new ActiveDataProvider([
    'query' => $query
]);
// $dataProvider передаёте в представление.

В представлении выводите данные при помощи ListView(пагинация в комплекте)

echo ListView::widget([
   'dataProvider' => $dataProvider,
   'layout' => '{items}',
   'itemView' => '_includes/_list_view'
])

[Дмитрий]

Но мне нужно совсем не то.

Isherath, в документации всё то, просто Вы не разобрались.

ActiveDataProvider с этим явно не может справится.

Это Вы не можете справиться с задачей.
Смотрите видео, так всё подробно рассказано.
Пример я дал, переделывайте под себя.

[Decadal]

Isherath на вашем месте я бы сосредоточился на том, чтобы сделать модель ответа. Так вы, конечно, не сможете использовать классные фичи которые предлагает фреймворк, но зато будете держать под контролем весь процесс выполнения, чего вам явно не хватает, судя по тому, как вы требовательны к формату ответа : )

GET companies/<id_company>/vacancies

POST, PUT, DELETE - restricted (они должны использоваться в другой части апи с другими требованиями к авторизации).

class CompanyVacanciesModel extends Model {
   public $company; 
   public $vacancies; 
}


class CompanyController {
//обратите внимание на роутинг, он должен быть настроен в модуле соответственно
   public function actionsGetVacancies($company_id) {

         $dataProvider = new ArrayDataProvider([
            'allModels' => Vacancy::find()->with('profile')->where(['creator' => $creator]), //эту переменную не забудьте
            'pagination' => [
                'pageSize' => 30
            ]
       ]);
        $companyModel = new CompanyVacanciesModel();
        $companyModel->company = CompanyRecord::findOne($company_id); //тут бы еще привести к массиву
        $companyModel->vacancies = $dataProvider->getModels(); // и тут
         return $companyModel->toArray(); 
   }

}

вы это имели в виду?

[Дмитрий]

Decadal, я думаю, что создание отдельной модели лишнее.

[Isherath]

Decadal, да, похоже на то, но есть один нюанс, у меня кроме компаний с их вакансиями, есть еще категории и страны с их вакансиями, боюсь, я потеряюсь окончательно в куче моделей.

[Decadal]

Isherath, тогда вам пришло время создать сервис, который будет обслуживать вашу потребность собирать все данные в одном ответе.
например, так
dl4.joxi.net/drive/2018/09/02/0018/3722/1203850/50...

slo_nik, если нет никаких требований к ответу, то да. А если результат ответа собирается разными сервисами, тяжелым тернистым путем, то контроллеру всё проверять не стоило бы.

[Дмитрий]

, у меня кроме компаний с их вакансиями, есть еще категории и страны с их вакансиями

Isherath, и где об этом в Вашем вопросе хоть одно слово?

[Дмитрий]

Decadal, ну как посмотреть. О категория, странах у автора вопрос ни слова. Нет так же информации о структуре базы. Только компания и вакансии.
Это всё решается связями.
Хотя можно и остальное решить связями, join и тому подобное. Было бы желание и знания.

[Decadal]

slo_nik, полагаю, он интересовался правильным решением для фрагмента, чтобы применить его же для всей программы в целом. Сокрытие сложности это классная привычка, на самом деле.

[Isherath]

slo_nik, мне нужно возвращать многомерный массив клиенту типа:

return [
'company' => инфа о компании,
'vacancies' => ActiveDataProvider (ну либо что-то другое, без разницы вообще, лишь бы пагинация была нормальная)
];

А связи мне вернут совсем не то. это будет просто пачка вакансий с забитыми в каждую вакансию инфой о компании...я конечно могу просто на клиенте брать оттуда информацию, но это до тех пор, пока не попадется компания, у которой еще нет ни одной вакансии)

[Isherath]

Decadal, да, у меня есть аналогичная ситуация с другой информацией, если я найду решения для одной ситуации, то оно же будет решением и для всего остального.

[Дмитрий]

А связи мне вернут совсем не то. это будет просто пачка вакансий с забитыми в каждую вакансию инфой о компании

Isherath, запрос грамотно составьте и всё будет так, как Вам надо.

[Дмитрий]

Decadal, так для фрагмента я ему пример и показал. Автор ожидает готового решения видимо...

[Дмитрий]

Isherath, вот фрагмент выдачи по запросу, пример которого я привёл

Результат

app\modules\catalog\models\Catalog Object
(
    [_locateArray:app\modules\catalog\models\Catalog:private] => 
    [_attributes:yii\db\BaseActiveRecord:private] => Array
        (
            [id] => 2
            [name] => Игровые комплексы

    [_oldAttributes:yii\db\BaseActiveRecord:private] => Array
        (
            [id] => 2
            [name] => Игровые комплексы
        )

    [_related:yii\db\BaseActiveRecord:private] => Array
        (
            [categories] => Array
                (
                    [0] => app\modules\catalog\models\Catalog Object
                        (
                            [_locateArray:app\modules\catalog\models\Catalog:private] => 
                            [_attributes:yii\db\BaseActiveRecord:private] => Array
                                (
                                    [id] => 4
                                    [name] => Детские домики
                                )

                            [_oldAttributes:yii\db\BaseActiveRecord:private] => Array
                                (
                                    [id] => 4
                                    [name] => Детские домики
                                )

                            [_related:yii\db\BaseActiveRecord:private] => Array
                                (
                                    [products] => Array
                                        (
                                            [0] => app\modules\production\models\Products Object
                                                (
                                                    [_attributes:yii\db\BaseActiveRecord:private] => Array
                                                        (
                                                            [id] => 15
                                                            [title] => Домик Mochtoys игровой
                                                        )

                                            [1] => app\modules\production\models\Products Object
                                                (
                                                    [_attributes:yii\db\BaseActiveRecord:private] => Array
                                                        (
                                                            [id] => 16
                                                            [title] => Домик Mochtoys с зеленой крышей
                                                        )

                                            [2] => app\modules\production\models\Products Object
                                                (
                                                    [_attributes:yii\db\BaseActiveRecord:private] => Array
                                                        (
                                                            [id] => 17
                                                            [title] => Игровой дом Keter Фунтик  с горкой
                                                        )

Один раз выводится название категории, к ней все её товары. Всё это при помощи ActiveDataProvider.
Но если Вы говорите, что provider не справится с этой задачей, то значит Вам видней)))

[Isherath]

slo_nik, как работаю ваши связи я понял давно. Но мне не это нужно.

Есть у меня все эти связи у компании один ко многим к вакансиям, у вакансий один к одному к компаниям. Все, что мне дают связи, так это то, что у меня в каждой вакансии просто появляется поле с данными о компании, мне это вообще не надо. Потому что, если я буду брать тупо из первой вакансии назание компании и вешать его в определенном месте, то придет момент, когда у компании не будет вакансий, следовательно, и название компании неоткуда взять. И на странице это выглядит нелепо. Можно закончить со связями, наконец-то.

У менять есть ActiveDataProvider который возвращает мне все, что нужно по вакансиям вместе с пагинацией, но он не возвращает мне данные о компании отдельно! И в доках не написано об этом ни слова.

[Дмитрий]

Isherath, я Вам уже писал, повторю ещё раз.
Начинайте получать компании, потом, через связь тяните вакансии.
При выводе проверяйте, есть вакансии, выводите компанию, нет - не выводите.

И в доках не написано об этом ни слова.

В документации приведены примеры, все случаи предусмотреть невозможно.
Начинайте делать и смотрите что выводит.
Пример я показал, в документации попроще есть. В видео ещё примеры. Смотрите и пробуйте.

[Дмитрий]

как работаю ваши связи я понял давно. Но мне не это нужно

Isherath, посмотрите в debug панели, какие запросы получаются при использовании связей. Так будет легче понять, что к чему.