Grid\Options — пользовательские настройки грида
Пространство имен: Bitrix\Main\Grid
Модуль: main — подключать отдельно не нужно
Когда использовать
Класс Options хранит пользовательские настройки грида main.ui.grid по его идентификатору. Пользователь задает в интерфейсе грида видимые колонки, сортировку, размер страницы, ширину колонок и представления. Код страницы читает настройки, чтобы выбрать данные для грида.
Основные методы класса:
- getSorting — возвращает сортировку для запроса данных,
- родительский метод
GetNavParams— возвращает размер страницы, - getUsedColumns — возвращает видимые колонки.
Класс хранит настройки авторизованного пользователя в CUserOptions, настройки гостя — в сессии. Метод save сохраняет изменения. Раскрытые строки и свернутые группы методы записывают в сессию сразу.
Подробнее — в статье Грид main.ui.grid.
Методы класса
| Метод | Описание | С версии |
|---|---|---|
| __construct | Загружает настройки грида по идентификатору | |
| getId | Возвращает идентификатор грида | |
| getCurrentOptions | Возвращает настройки текущего представления | |
| getSorting | Возвращает сортировку грида | |
| getUsedColumns | Возвращает видимые колонки | |
| setPageSize | Задает размер страницы | |
| setColumnsSizes | Задает ширину колонок | |
| getResizedColumns | Возвращает колонки, ширину которых изменил пользователь | |
| setCustomNames | Задает свои названия колонок | |
| setStickedColumns | Задает закрепленные колонки | |
| getStickedColumns | Возвращает закрепленные колонки | |
| setExpandedRows | Запоминает раскрытые строки | |
| getExpandedRows | Возвращает раскрытые строки | |
| resetExpandedRows | Сбрасывает раскрытые строки | |
| setCollapsedGroups | Запоминает свернутые группы | |
| getCollapsedGroups | Возвращает свернутые группы | |
| resetView | Очищает настройки представления и сохраняет их | |
| deleteView | Удаляет представление и сохраняет настройки | |
| save | Сохраняет настройки |
Наследование
Класс наследует класс классического API CGridOptions.
Унаследованные методы
| Метод | Описание |
|---|---|
GetOptions() |
Возвращает все настройки грида: представления views, фильтры filters и текущее представление current_view |
GetNavParams($arParams = []) |
Возвращает массив с ключом nPageSize — размер страницы текущего представления или значение из аргумента, по умолчанию 20. Читает настройки, которые объект загрузил из CUserOptions, поэтому для гостя не учитывает настройки из сессии |
GetVisibleColumns() |
Возвращает видимые колонки текущего представления, которые объект загрузил из CUserOptions при создании |
SetColumns($columns) |
Задает видимые колонки текущего представления строкой через запятую |
SetSorting($by, $order) |
Задает последнюю сортировку текущего представления |
SetViewSettings($viewId, $settings) |
Заменяет настройки представления целиком |
SetView($viewId) |
Делает представление текущим. Для несуществующего представления делает текущим default. Удаляет сортировку грида из сессии |
В таблице перечислены методы, которые нужны для работы с колонками, сортировкой и представлениями. Остальные методы CGridOptions работают с фильтром и темой старого грида main.interface.grid.
Класс переопределяет родительские методы GetSorting, Save и DeleteView методами getSorting, save и deleteView.