Восстановить пресеты по умолчанию Options::restore
Модуль: main — подключать отдельно не нужно
Метод Options::restore возвращает пресеты по умолчанию. Компонент main.ui.filter вызывает метод, когда пользователь восстанавливает настройки фильтра.
Метод выполняет шаги по порядку.
- Записывает настройки каждого переданного пресета.
- Снимает с этих пресетов отметку удаления.
- Закрепляет пресет с ключом
defaultиз пресетов по умолчанию и включает применение закрепленного пресета. - Убирает текущий пресет из локального хранилища сессии.
Сигнатура метода в классе Bitrix\Main\UI\Filter\Options:
public function restore($settings = [])
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| settings | array |
Задает пресеты — массив код => настройки. По умолчанию — пустой массив, тогда метод ничего не делает |
Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.
Возвращаемое значение
Метод ничего не возвращает.
Особенности
Метод не меняет пресеты, которых нет в settings. Чтобы сохранить результат, вызовите save.
Примеры
Пример. Код удаляет пресет и восстанавливает его:
<?php
use Bitrix\Main\UI\Filter\Options;
require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';
$presets = [
'active' => ['name' => 'Active', 'default' => true, 'fields' => ['ACTIVE' => 'Y']],
'heavy' => ['name' => 'Heavy', 'fields' => ['WEIGHT_numsel' => 'more', 'WEIGHT_from' => '10']],
];
$options = new Options('units_filter', $presets);
$options->deleteFilter('active', true);
$options->restore($options->getDefaultPresets());
echo implode(',', array_keys($options->getPresets())) . ' ' . var_export($options->isDeletedPreset('active'), true) . ' ' . $options->getDefaultFilterId();
Код выведет heavy,active false active.
Смотрите также
Была ли статья полезна?
Предыдущая
Следующая