YII2 rest api url call model method

Question

Im kinda new to rest api, especially with YII2.

I have three tables: students(id, name), courses(id, subject) and students_courses(student_id, course_id). Many to many relation.

I need to get students id, name and courses via relation table.

myexample.com/api/v1/students

gives me json with id and name only

myexample.com/api/v1/students/get-students-courses

gives me 404 not found

Here's my model:

<?php

namespace app\models;

use Yii;

class Students extends \yii\db\ActiveRecord
{

    public static function tableName()
    {
        return 'students';
    }


    public function rules()
    {
        return [
            [['name'], 'required'],
            [['name'], 'string', 'max' => 255]
        ];
    }

    public function attributeLabels()
    {
        return [
            'id' => 'ID',
            'name' => 'Name',
        ];
    }

    public function getStudentsCourses()
    {
        return $this->hasMany(StudentsCourses::className(), ['student_id' => 'id']);
    }
}

and urlManager configuration:

'urlManager' => [
        'enablePrettyUrl' => true,
        'enableStrictParsing' => true,
        'showScriptName' => false,
        'rules' => [
            ['class' => 'yii\rest\UrlRule', 'controller' => ['v1/students']],
        ],
    ],

EDIT: Thanks, Salem Ouerdani, this worked.

public function getCourses()
{
    return $this->hasMany(Courses::className(), ['id' => 'course_id'])
    ->viaTable(StudentsCourses::tableName(), ['student_id' => 'id'])
    ->all();
}

public function extraFields()
{
    return ['studentsCourses' => function(){
        return $this->getCourses();
    }];
}

Not at all, I'm glad it helped, but one thing to note: with public function getCourses(){...} you can simply have extraFields() {return ['courses'];} and your link will then look like : myexample.com/api/v1/students&expand=courses unless you need it to be named that way. — Salem Ouerdani
– Salem Ouerdani, Commented Feb 1, 2016 at 8:37
Yii2 (as Yii1) uses getters & setters. so a method like getAbc(){..} can be called like $model->getAbc() or simply like $model->abc. extraFields in this case should return an array with method's getter abbreviation (['abc'] in this case or simply the way how you did it). I'm adding this note as it can help others. — Salem Ouerdani
– Salem Ouerdani, Commented Feb 1, 2016 at 8:57

Salem Ouerdani · Accepted Answer · 2016-02-01 08:45:37Z

2

You need to override your model's extraField() method :

class Students extends \yii\db\ActiveRecord
{

    public function getStudentsCourses() {...}

    ...

    public function extraFields()
    {
        return ['studentsCourses'];
    }
}

Then you should be able to retrieve all students collection with their related courses within :

myexample.com/api/v1/students&expand=studentsCourses

or maybe a single resource like myexample.com/api/v1/students/99&expand=studentsCourses

see docs for more details.

edited Feb 1, 2016 at 8:45

answered Feb 1, 2016 at 0:18

Salem Ouerdani

8,0563 gold badges46 silver badges58 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

SmartCoder · Accepted Answer · 2016-01-31 23:58:57Z

1

well, from what i gather you need to add a public function actionGetStudentsCourses() to your StudentsController

answered Jan 31, 2016 at 23:58

SmartCoder

4112 silver badges13 bronze badges

Collectives™ on Stack Overflow

YII2 rest api url call model method

2 Answers 2

myexample.com/api/v1/students&expand=studentsCourses

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

myexample.com/api/v1/students&expand=studentsCourses

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related