Yii2 data provider default sorting

Question

In Yii 1.1 this code works for default sorting:

$dataProvider = new CActiveDataProvider('article',array(
    'sort'=>array(
        'defaultOrder'=>'id DESC',
    ),
));

How default sorting can be set in Yii2?

Tried below code, but no result:

$dataProvider = new ActiveDataProvider([
    'query' => $query,
    'sort' => ['defaultOrder'=>'topic_order asc']
]);

score 183 · Accepted Answer · edited Jun 16 '20 at 11:32

183

I think there's proper solution. Configure the yii\data\Sort object:

 $dataProvider = new ActiveDataProvider([
     'query' => $query,
     'sort'=> ['defaultOrder' => ['topic_order' => SORT_ASC]],
 ]);

Official doc link

edited Jun 16 '20 at 11:32

rob006

18,710
5
41
58

answered Apr 10 '14 at 16:43

Alex

7,679
7
37
59

This solution works but the search in index doesn't work now. – Roby Sottini Nov 16 '17 at 12:14

score 42 · Answer 2 · answered Feb 27 '15 at 13:47

42

Or

       $dataProvider->setSort([
        'defaultOrder' => ['topic_order'=>SORT_DESC],
        'attributes' => [...

answered Feb 27 '15 at 13:47

Kristīne Glode

1,329
2
15
22

1

It's more compatible with default GII output – userlond May 11 '15 at 05:39

score 15 · Answer 3 · edited May 17 '16 at 13:23

defaultOrder contain a array where key is a column name and value is a SORT_DESC or SORT_ASC that's why below code not working.

$dataProvider = new ActiveDataProvider([
        'query' => $query,
        'sort' => ['defaultOrder'=>'topic_order asc']
    ]);

Correct Way

$dataProvider = new ActiveDataProvider([
    'query' => $query,
    'sort' => [
        'defaultOrder' => [
            'topic_order' => SORT_ASC,
        ]
    ],
]);

Note: If a query already specifies the orderBy clause, the new ordering instructions given by end users (through the sort configuration) will be appended to the existing orderBy clause. Any existing limit and offset clauses will be overwritten by the pagination request from end users (through the pagination configuration).

You can detail learn from Yii2 Guide of Data Provider

Sorting By passing Sort object in query

 $sort = new Sort([
        'attributes' => [
            'age',
            'name' => [
                'asc' => ['first_name' => SORT_ASC, 'last_name' => SORT_ASC],
                'desc' => ['first_name' => SORT_DESC, 'last_name' => SORT_DESC],
                'default' => SORT_DESC,
                'label' => 'Name',
            ],
        ],
    ]);

    $models = Article::find()
        ->where(['status' => 1])
        ->orderBy($sort->orders)
        ->all();

score 10 · Answer 4 · answered Nov 08 '18 at 15:46

if you have CRUD (index) and you need set default sorting your controller for GridView, or ListView, or more... Example

public function actionIndex()
{
    $searchModel = new NewsSearch();
    $dataProvider = $searchModel->search(Yii::$app->request->queryParams);
    // set default sorting
    $dataProvider->sort->defaultOrder = ['id' => SORT_DESC];

    return $this->render('index', [
        'searchModel' => $searchModel,
        'dataProvider' => $dataProvider,
    ]);
}

you need add

$dataProvider->sort->defaultOrder = ['id' => SORT_DESC];

if you want to do it in the controller without changing the SearchModel, this is the way to go. Thanks! — nunorbatista, Aug 30 '20 at 21:44

score 3 · Answer 5 · answered Jun 07 '18 at 11:04

3

Try to this one

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

$sort = $dataProvider->getSort();

$sort->defaultOrder = ['id' => SORT_ASC];

$dataProvider->setSort($sort);

answered Jun 07 '18 at 11:04

user210195

51
1

score 1 · Answer 6 · edited Feb 29 '20 at 18:49

1

$dataProvider = new ActiveDataProvider([ 
    'query' => $query, 
    'sort'=> ['defaultOrder' => ['iUserId'=>SORT_ASC]] 
]);

edited Feb 29 '20 at 18:49

johannchopin

7,327
6
22
62

answered Feb 29 '20 at 12:02

Suraj Vaghela

15
2

score -1 · Answer 7 · edited Apr 10 '19 at 06:06

-1

you can modify search model like this

$dataProvider = new ActiveDataProvider([
        'query' => $query,
        'sort' => [
            'defaultOrder' => ['user_id ASC, document_id ASC']
        ]
    ]);

edited Apr 10 '19 at 06:06

Rohit Suthar

3,303
1
34
46

answered Nov 25 '17 at 10:50

brahmeswara rao Kamineni

9
1

score -2 · Answer 8 · edited Dec 17 '18 at 12:42

    $modelProduct       =   new Product();
    $shop_id            =   (int)Yii::$app->user->identity->shop_id;

    $queryProduct       =   $modelProduct->find()
                            ->where(['product.shop_id'  => $shop_id]);


    $dataProviderProduct    =   new ActiveDataProvider([
                                    'query'         =>  $queryProduct,
                                     'pagination' => [ 'pageSize' => 10 ],
                                    'sort'=> ['defaultOrder' => ['id'=>SORT_DESC]]
                                ]);

Yii2 data provider default sorting

8 Answers8