Как в Yii2 выполнить сортировку для dataProvider из _search файла с ActiveForm?

Question

[EVOSandru6]

Добрый день.

У меня в файле _search Есть набор для фильтрации dataProvider в ListView:

<?php $form = ActiveForm::begin([
          'options' => ['data-pjax' => true ],
        'method' => 'post',
    ]); ?>
<?= $form->field($model, 'id')->textInput([
        'type'=>'number'
    ]) ?>

<!-- рабочий price filter -->

<?= $form->field($model, 'name')->textInput() ?>
<?php ActiveForm::end(); ?>

Помимо фильтрации я хочу выполнять сортировку.

Глянул на примере обычного грида в Network уходят запросы типа:

По возрастанию:

products?sort=id

По убыванию:

products?sort=-id

Хочу сделать dropDown для сртировки, варианты которого -

1. name от а до я
2. name от я до а
3. price по возрастанию
4. price по убыванию

Предполагаю, что нужно создать новое свойство в ProductsSearch и каким то образов вставлять его значение в defaultSort. Или же есть какое то более коробочное решение? Подскажите пожалуйста, кто сталкивался.

Answer 1

[Евгений Бухарев]

Сортировка настраивается посредством свойства sort дата провайдера

$dataProvider = new ActiveDataProvider([
     'query' => $query,
     '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',
            ],
        ],
 ]);

Заполните массив attributes параметрами по которым вам необходимо сортировать, и далее передавайте данные параметры через get строку запроса в виде ...?sort=-name

Comments

[EVOSandru6]

Благодарю.

А как должен выглядеть этот селект? С привязкой к $model поисковой формы или в виде Html:: независимого от формы поля.

[Евгений Бухарев]

EVOSandru6, Изучите класс yiisoft/yii2/data/Sort.php, он как правило доступен через $dataProvider->sort, там есть методы типа link(), createUrl(),createSortParam() которые помогут сформировать селект, но из коробки там сделано все чтобы формировать ссылки на сортировку, а не селект

[Евгений Бухарев]

<?php


namespace common\components;

use yii\base\InvalidConfigException;
use yii\base\Widget;
use yii\data\Sort;
use yii\helpers\Html;


class DropDownSorter extends Widget
{
    /**
     * @var Sort the sort definition
     */
    public $sort;
    /**
     * @var array list of the attributes that support sorting. If not set, it will be determined
     * using [[Sort::attributes]].
     */
    public $attributes;
    /**
     * @var array HTML attributes for the sorter container tag.
     * @see \yii\helpers\Html::ul() for special attributes.
     * @see \yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.
     */
    public $options = ['class' => 'sorter'];
    /**
     * @var array HTML attributes for the dropDown in a sorter container tag
     * @since 2.0.6
     */
    public $selectOptions = [];


    /**
     * Initializes the sorter.
     */
    public function init()
    {
        if ($this->sort === null) {
            throw new InvalidConfigException('The "sort" property must be set.');
        }
    }

    /**
     * Executes the widget.
     * This method renders the sort links.
     */
    public function run()
    {
        echo $this->renderSortDropDown();
    }

    /**
     * Renders the sort links.
     *
     * @return string the rendering result
     */
    protected function renderSortDropDown()
    {
        $attributes = empty($this->attributes) ? $this->sort->attributes : $this->attributes;
        $items = [];
        $selected = null;

        foreach ($attributes as $key => $name) {
            $items[$key] = $name['label']['asc'];
            $items['-' . $key] = $name['label']['desc'];
        }
        $orders = $this->sort->getAttributeOrders();
        if (count($orders) == 1) {
            $key = key($orders);
            $value = $orders[$key];
            $selected = ($value == SORT_DESC ? '-' : '') . $key;
        }


        return Html::dropDownList($this->sort->sortParam, $selected, $items, $this->selectOptions);
    }
}

[Евгений Бухарев]

<?= DropDownSorter::widget(['sort' => $dataProvider['sort'], 'selectOptions' => ['id' => list_form_sort', 'class' => 'js-dropdown-box']]); ?>

[Евгений Бухарев]

EVOSandru6, Выше привел рабочий класс и вариант использования

[EVOSandru6]

В общей форме фильтрации пишу:

<?= Html::dropDownList('sort', null, [
            'name' => 'name от а до я',
            '-name' =>  'от я до а',
            'id' => 'id по возрастанию',
            '-id' => 'id по убыванию'
        ], [
            'class'=>'form-control input-lg search-select',
            'title'=>'Please select a lunch ...',
        ]) ?>

Если убиваю PJAX, то могу отловить, что пришло:

Array
(
    [_csrf] => OXRia3ZFU1pfMiYhFwkYbhQ6LVkFEx1ic0UQHBgzYgp.JSwhByAUPQ==
    [sort] => name
    [ProductsSearch] => Array
        (
            [range_price] => 5,50000
            [range_sale] => 5,100
            [category_id] => 
            [brand_id] => 
        )
)

Т.е. sort все же пришел. Но работает он только если в адресной строке его добавить в виде get параметра.

Можно ли с постов его как то подуржить?

Ибо при сортировке нужно сохранить фильтрацию.

[EVOSandru6]

Сейчас попробую, спасибо.

[EVOSandru6]

Стандартно класс не подцепился. поищу на гиттхабе.

[EVOSandru6]

Так, понял. Вы его привели.

[Евгений Бухарев]

EVOSandru6, Параметры сортировки и фильтрации лучше пускать через GET, POST лучше использовать для тех или иных изменений данных,а GET для получения

[EVOSandru6]

Пра вопросов.

1. В кой параметр виджета вставлять массив с данными:

[
            'name' => 'name от а до я',
            '-name' =>  'от я до а',
            'id' => 'id по возрастанию',
            '-id' => 'id по убыванию'
        ]

2. В Вашем примере ловлю :

The "sort" property must be set.

Возможно это связано с 1.

[Евгений Бухарев]

<?= DropDownSorter::widget(['sort' => $dataProvider['sort'], 'selectOptions' => ['id' => list_form_sort', 'class' => 'js-dropdown-box']]); ?>

здесь при инициализации виджета нужно в параметр sort передать $dataProvider->sort

Либо как вариант передать массив с данными в параметр attributes

$attributes = empty($this->attributes) ? $this->sort->attributes : $this->attributes;

[EVOSandru6]

О как, передал провайдер, в селект наборе теперь все необходимые поля.

1. $attributes каким образом передать в виджет?

2. Что-то не так с кодировкой (код страницы), с чем может быть связано?:

<select id="list_form_sort" class="js-dropdown-box" name="sort">
<option value="id">�</option>
<option value="-id">�</option>
<option value="name">�</option>
<option value="-name">�</option>
</select>

3. sort работает теперь только если убить PJAX и полностью перейти на метод GET. Возможно ли подружить переданный параметр sort с постом?

В контроллере такая штука не прокатит:

if(Yii::$app->request->post('sort'))
            $dataProvider->sort = Yii::$app->request->post('sort');

Ибо слева ожидается объект, я ему передаю строку.
Кроме как через switch/case можно реализовать?

[EVOSandru6]

Под switch/case я подразумеваю отдельные случаи конфигурации объекта $dataProvider->sort в контроллере

[EVOSandru6]

Попробовал немного набыдлокодить в контроллере:

if(Yii::$app->request->post('sort')) {

            $sort = Yii::$app->request->post('sort');
            switch($sort) {
                case 'id': default:
                    $defaultOrder = [
                        'name' => SORT_ASC,
                    ];
                    break;
                case '-id':
                    $defaultOrder = [
                        'name' => SORT_DESC,
                    ];
                    break;
                case 'name':
                    $defaultOrder = [
                        'name' => SORT_ASC,
                    ];
                    break;
                case '-name':
                    $defaultOrder = [
                        'name' => SORT_DESC,
                    ];
                    break;
            }
            $dataProvider->sort = [
                'attributes' => [
                    'id',
                    'name'
                ],
                'defaultOrder' => $defaultOrder
            ];
            // My::printArr($_POST)
            // echo $sort;
            // $dataProvider->sort = Yii::$app->request->post('sort');
        }

Сортировка проходит, но почемуто сами записи в dataProvider стали дублироваться( НЕ все, а некоторые.

[Евгений Бухарев]

Что то вас вообще не в ту сторону понесло)

[Евгений Бухарев]

В атрибут sort виджета DropDownSorter нужно передать $dataProvider->sort, который вы должны настроить в контроллере при инициализации DataProvider, и все само собой должно подхватиться

[EVOSandru6]

2. пункт решил правкой в компоненте:

$items[$key] = $name['label']['asc'];
$items['-' . $key] = $name['label']['desc'];

на

$items[$key] = $name['label'] . ' По возрастанию';
$items['-' . $key] = $name['label'] . ' По Убыванию';

В общем сортировка проходит только в таком варианте:

<?php $form = ActiveForm::begin([
//        'options' => ['data-pjax' => true ],
//         'method' => 'post',
        'method' => 'get',
    ]); ?>

Получается, что без перезагрузки страницы нельзя ее провести?

Если я раскомменчиваю:

'options' => ['data-pjax' => true ],

Ничего не происходит.

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

$dataProvider = $searchModel->search(Yii::$app->request->queryParams);

На

$dataProvider = $searchModel->search(Yii::$app->request->post());

Мой быдловариант кстати работал как и Ваш, расчитанный на Get запрос. Но..

В обоих вариантах происходит дублирование нескольких записей. Не могу понять, с чем это связано. Причем без DropDownSorter , соответственно без сортировки, данные фильтруются нормально и не дублируются.

[Евгений Бухарев]

EVOSandru6, Дублирование нескольких записей возможно когда идет join в запросе, разбирайте запрос который формируется и летит в базу, возможно нужно добавить GROUP BY по какому либо параметру

[EVOSandru6]

Благодарю, Вы были правы насчет GROUP BY!

[EVOSandru6]

Последний только вопрос. Поле DropDownSorter не привязывается к модели, поэтому скидывает свое значение на первое после каждой фильтрации. Это можно исправить как-то?

[Евгений Бухарев]

EVOSandru6, DropDownSorter не привязан к модели, он не будет скидывать свое значение на первое после фильтрации, если будет указана сортировка по умолчанию, либо будет выбран какой либо пункт сортировки.
Найдите строку
$orders = $this->sort->getAttributeOrders();
в коде виджета, и посмотрите что происходит после неё, именно там устанавливается выбранное значение в селекте

Answer 2

[Максим Федоров]

Предполагаю, что нужно создать новое свойство в ProductsSearch и каким то образов вставлять его значение в defaultSort.

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

Просто сделайте select с значениями

[
    'name' => 'name от а до я',
    '-name' =>  'от я до а',
    'price' => 'price по возрастанию',
    -'price' => 'price по убыванию'
]

и на уровне JS ловите выбор из этого списка значения и перезагружайте страницу

Comments

[EVOSandru6]

Благодарю,

А как будет выглядеть этот селект? С привязкой к $model поисковой формы или в виде Html:: независимого от формы поля.

Как вариант.

Может я чего-то не понял, но в таком случае:

1. Потеря фильтра
2. Перезагрузка страницы

Или этого можно избежать в данном контексте?

[Максим Федоров]

EVOSandru6, ну смотрите осуществлять фильтрацию методом POST - плохая практика, потому что как правило пользователь может отфильтровать нужные данные а потом передать ссылку другому пользователю (я понятно объяснил или не очень?). Поэтому настоятельно рекомендую осуществлять фильтрацию методом GET. В этом случае у Вас потери фильтра не будет. А что касается перезагрузки страницы - Вы можете просто перезагружать Pjax-блок добавляя в URL параметр сортировки

[EVOSandru6]

Максим Федоров, Это через History API на js?

Если я правильно понимаю, нужно перехватить данные через afterPjax

Изначально не хотел методом гет фильтровать, ибо параметры в адресной строке наклыдывались друг на друга при каждй фильтрации. Что не очень красиво. Может есть вариант избежать дублирования без перебора. Буду искать.

[Евгений Бухарев]

EVOSandru6, параметры в адресной строке не должны дублироваться если правильно указать параметр action формы которая отправляет данные на сервер

[EVOSandru6]

В моем случае action вообще не указан и все запросы идут на текущую страницу.

Answer 3

[Boris Köln]

Уже стандарт де-факто для сортировки - клик на заголовок столбца. Чем вас это не устраивает из коробки? Зачем все эти костыли с лишним селект-боксом?

Comments

[EVOSandru6]

Добрый день,

У меня не GridView, а ListView . Которая также как и первый использует dataProvider