Удалить представление Options::deleteView
Модуль: main — подключать отдельно не нужно
Метод Options::deleteView удаляет представление грида. Метод сразу сохраняет изменения, вызывать save не нужно.
Метод переопределяет CGridOptions::DeleteView, который только удаляет представление из объекта.
Сигнатура метода в классе Bitrix\Main\Grid\Options:
public function deleteView($viewId)
Параметры
Обязательные параметры обозначены *
| Параметр | Тип | Описание |
|---|---|---|
| viewId* | string |
Задает идентификатор представления |
Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.
Возвращаемое значение
Метод ничего не возвращает.
Особенности
- Метод удаляет представление, удаляет из сессии сортировку, фильтр, раскрытые строки и свернутые группы грида, сохраняет настройки и заново загружает их конструктором родительского класса из
CUserOptions. - Для гостя, у которого настройки в сессии, объект после вызова содержит настройки из
CUserOptions. Чтобы прочитать настройки гостя, создайте новый объектOptions. - Если метод удалил текущее представление, при следующей загрузке из
CUserOptionsконструктор сделает текущимdefault. Для гостя настройки из сессии сохранят удаленное текущее представление, и getCurrentOptions вернетnull. Перед удалением сделайте текущим другое представление методомSetView. - Если метод удалил
default, конструктор при следующей загрузке создаст его из общих настроекmain.interface.grid.commonили с пустым списком колонок.
Примеры
Пример. Код создает представление, сохраняет его и удаляет:
<?php
use Bitrix\Main\Grid\Options;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$options = new Options('units_grid');
$options->SetViewSettings('compact', [
'name' => 'Compact',
'columns' => 'ID',
'sort_by' => 'ID',
'sort_order' => 'asc',
'page_size' => 5,
'saved_filter' => '',
]);
$options->save();
$options = new Options('units_grid');
$options->deleteView('compact');
echo implode(',', array_keys((new Options('units_grid'))->GetOptions()['views']));
Код выведет default.
Смотрите также
Была ли статья полезна?
Предыдущая
Следующая