Get rest data with some conditions in Yii2

Question

It gives me the list of all users when I run this url "api/web/v1/users" using get method in Yii2 in its default rest setup.

I have a column is_active in the users table, so I only want the list of all active users "where is_active=1", my question is that how I can pass my custom conditions to get rest data?

score 2 · Answer 1 · edited May 23 '17 at 12:01

2

This questions contains all the code you need for a general REST query/search implementation in Yii2: Yii2 REST query

Your search can be done calling api/web/v1/users/search?is_active=1

edited May 23 '17 at 12:01

Community

1
1

answered Nov 12 '14 at 09:50

Fory

405
4
12

score 1 · Answer 2 · answered Jan 31 '17 at 04:19

add this to your REST controller

public function actions()
{
    // Overriding action
    $actions['index']['prepareDataProvider'] = function($action) 
    {
        return new \yii\data\ActiveDataProvider([
           'query' => \app\models\User::find()->where(['is_active' => 1]),

        ]);
    };

    return $actions;
}

score 0 · Answer 3 · answered Nov 12 '14 at 09:42

0

You can achieve this by overriding users action or creating new action in your REST controller:

public function actionActiveUsers(){
    return User::find()->where(['active' => 1])->all();
}

Now, you can get active users via user/activeUsers URL.

answered Nov 12 '14 at 09:42

Ali MasudianPour

14,329
3
60
62

Yes, this solution is creating a new action that I don't want, I just want to use same url "api/web/v1/users" to get the desired result. – Mohd Shahid Nov 12 '14 at 09:47
So just override it and rename `actionActiveUsers()` to `actionUsers()` – Ali MasudianPour Nov 12 '14 at 09:54
I tried actionUsers but it is not overriding the default action, I tried actionIndex also since it is inside "UserController" but it is also not working. – Mohd Shahid Nov 12 '14 at 10:08

score 0 · Answer 4 · answered May 26 '16 at 08:12

i have done it same task for REST APIs using ActiveDataProvider.

Comment/Disable the line of the UserController public $modelClass = 'app\model\user';

create new action i.e., actionIndex() //--- Controller action

public function actionIndex(){

$query = (new yii\db\Query())
->from('user')
->where('ia_active=:rec',[
  ':rec'=>1
]);

$dataProvider = new yii\data\ActiveDataProvider([
            'query' => $query,
        ]);

return $dataProvider;
}

Note: add url-rule in web.php (urlManager) //---web.php

'urlManager' => [
  enablePrettyUrl' => true,
  'rules' = [
    //--- other rules
    'GET,HEAD users' => 'v1/users/index',
  ]
]

try it.

Get rest data with some conditions in Yii2

4 Answers4