Получить настройки текущего представления Options::getCurrentOptions
Модуль: main — подключать отдельно не нужно
Метод Options::getCurrentOptions возвращает настройки текущего представления грида. Представление — набор настроек, между которыми пользователь переключается в гриде. Основное представление называется default.
Сигнатура метода в классе Bitrix\Main\Grid\Options:
public function getCurrentOptions()
Возвращаемое значение
Метод возвращает массив. Ключи зависят от того, что настроил пользователь.
|
Ключ |
Описание |
|
columns |
Видимые колонки через запятую. Пустая строка — колонки по умолчанию |
|
page_size |
Размер страницы |
|
last_sort_by |
Колонка последней сортировки |
|
last_sort_order |
Направление последней сортировки, например |
|
columns_sizes |
Ширина колонок, ключи |
|
name |
Название представления из |
|
sort_by |
Колонка сортировки представления из |
|
sort_order |
Направление сортировки представления из |
|
saved_filter |
Сохраненный фильтр представления |
|
custom_names |
Свои названия колонок |
|
sticked_columns |
Закрепленные колонки |
Метод читает настройки, которые объект содержит сейчас, включая несохраненные изменения.
Примеры
Пример. Код задает размер страницы и читает его из настроек текущего представления:
<?php
use Bitrix\Main\Grid\Options;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$options = new Options('units_grid');
$options->setPageSize(50);
echo $options->getCurrentOptions()['page_size'];
Код выведет 50.