Очистить настройки представления Options::resetView

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

Метод Options::resetView очищает настройки представления грида — заменяет их пустым массивом. Метод сразу сохраняет изменения, вызывать save не нужно.

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

public function resetView($viewId)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
viewId* string Задает идентификатор представления, например default

Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.

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

Метод ничего не возвращает.

Особенности

Метод выполняет шаги по порядку:

  1. Заменяет настройки представления пустым массивом.
  2. Удаляет из сессии данные грида — сортировку, фильтр, раскрытые строки и свернутые группы.
  3. Сохраняет настройки методом save.
  4. Заново загружает настройки конструктором родительского класса из CUserOptions. Предустановленные фильтры из конструктора метод при этом не передает.

Пустое представление default остается в настройках. Поэтому конструктор не подставляет вместо него общие настройки из main.interface.grid.common. Чтобы вернуть общие настройки, удалите представление методом deleteView.

На четвертом шаге конструктор не читает настройки из сессии. Для гостя, у которого настройки в сессии, объект после вызова содержит настройки из CUserOptions. Чтобы прочитать настройки гостя, создайте новый объект Options.

Примеры

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

<?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);
$options->save();

$options->resetView('default');

echo json_encode((new Options('units_grid'))->getCurrentOptions());

Код выведет []. Настройки представления default пусты, и грид покажет колонки и размер страницы по умолчанию.

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