Получить настройки текущего представления Options::getCurrentOptions

Модуль: main — подключать отдельно не нужно

Метод Options::getCurrentOptions возвращает настройки текущего представления грида. Представление — набор настроек, между которыми пользователь переключается в гриде. Основное представление называется default.

Сигнатура метода в классе Bitrix\Main\Grid\Options:

public function getCurrentOptions()

Возвращаемое значение

Метод возвращает массив. Ключи зависят от того, что настроил пользователь.

Ключ

Описание

columns
string

Видимые колонки через запятую. Пустая строка — колонки по умолчанию

page_size
int

Размер страницы

last_sort_by
string

Колонка последней сортировки

last_sort_order
string

Направление последней сортировки, например asc

columns_sizes
array

Ширина колонок, ключи expand и columns. В версиях новее main 26.150.0 есть еще ключ resized

name
string

Название представления из SetViewSettings

sort_by
string

Колонка сортировки представления из SetViewSettings

sort_order
string

Направление сортировки представления из SetViewSettings

saved_filter
string

Сохраненный фильтр представления

custom_names
array

Свои названия колонок

sticked_columns
array

Закрепленные колонки

Метод читает настройки, которые объект содержит сейчас, включая несохраненные изменения.

Примеры

Пример. Код задает размер страницы и читает его из настроек текущего представления:

<?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.

Смотрите также