Загрузить настройки грида Options::__construct
Модуль: main — подключать отдельно не нужно
Конструктор Options::__construct загружает настройки грида по его идентификатору. Идентификатор совпадает с параметром GRID_ID компонента main.ui.grid.
Сигнатура метода в классе Bitrix\Main\Grid\Options:
public function __construct($gridId, array $filterPresets = array())
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| gridId* | string |
Задает идентификатор грида |
| filterPresets | array |
Задает предустановленные фильтры для родительского метода InitFilter. По умолчанию — пустой массив |
Тип gridId в таблице описывает назначение аргумента. Сигнатура PHP объявляет только тип filterPresets.
Особенности
- Конструктор родительского класса читает настройки из
CUserOptionsв категорииmain.interface.grid, у гостя — общие записи без пользователя. Если представленияdefaultнет, конструктор берет общие настройки из категорииmain.interface.grid.common, а без них создаетdefaultс пустым списком колонок. - Для гостя конструктор затем заменяет все настройки сохраненными в сессии, если метод save сохранил их туда раньше. Текущее представление и настройки, которые читают родительские методы
GetNavParamsиGetVisibleColumns, остаются изCUserOptions. - Если текущее представление из
CUserOptionsне существует, конструктор делает текущимdefault. Для настроек из сессии эту проверку конструктор не выполняет.
Примеры
Пример. Код загружает настройки грида и выводит идентификатор и текущее представление:
<?php
use Bitrix\Main\Grid\Options;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$options = new Options('units_grid');
echo $options->getId() . ' ' . $options->GetOptions()['current_view'];
Для грида без сохраненных настроек код выведет units_grid default.
Смотрите также
Была ли статья полезна?
Предыдущая
Следующая