Получить сортировку грида Options::getSorting
Модуль: main — подключать отдельно не нужно
Метод Options::getSorting возвращает сортировку грида. Код страницы передает ключ sort результата в параметр order метода getList.
Метод переопределяет CGridOptions::GetSorting. В отличие от родителя, метод не читает сортировку из параметров запроса и сессии. Метод берет из настроек текущего представления последнюю сортировку, которую пользователь выбрал в гриде, — ключи last_sort_by и last_sort_order, только если оба непустые. Сортировку представления из SetViewSettings, ключи sort_by и sort_order, метод не учитывает.
Сигнатура метода в классе Bitrix\Main\Grid\Options:
public function getSorting($default = array())
Параметры
|
Параметр |
Тип |
Описание |
|
default |
|
Задает значения по умолчанию. Ключи:
По умолчанию — пустой массив |
Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.
Возвращаемое значение
|
Ключ |
Описание |
|
sort |
Содержит сортировку. Если в настройках есть колонка и направление последней сортировки, массив содержит один элемент с ними. Иначе — значение |
|
vars |
Значение |
Примеры
Пример. Код задает сортировку по умолчанию и получает сортировку для выборки:
<?php
use Bitrix\Main\Grid\Options;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$options = new Options('units_grid');
$sorting = $options->getSorting(['sort' => ['ID' => 'desc']]);
echo json_encode($sorting['sort']);
Если пользователь не менял сортировку, код выведет {"ID":"desc"}.