Options — настройки и значения фильтра main.ui.filter

Пространство имен: Bitrix\Main\UI\Filter

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

Доступно с версии: 16.5.10

Когда использовать

Класс Options работает с настройками фильтра компонента main.ui.filter. Серверный код страницы создает объект с тем же идентификатором фильтра, что и компонент, и получает значения, которые пользователь выбрал в интерфейсе.

use Bitrix\Main\UI\Filter\Options;

$filterOptions = new Options('units_filter', $presets);
$filter = $filterOptions->getFilter($fields);

Фильтр хранит пресеты — наборы полей со значениями. Один пресет текущий, его значения возвращает getFilter. Встроенный пресет default_filter означает пустой фильтр, tmp_filter — значения, которые пользователь ввел без сохранения пресета.

Класс хранит настройки по-разному.

Что Где
Пресеты, закрепленный пресет, порядок полей Настройки пользователя категории main.ui.filter. Для гостя — локальное хранилище сессии main.ui.filter
Текущий пресет, строка поиска, дополнительные поля Локальное хранилище сессии main.ui.filter
Настройки для всех пользователей Общие настройки категории main.ui.filter.common
Общие пресеты нескольких фильтров Настройки пользователя категории main.ui.filter.presets

Подробнее — в статье Фильтр main.ui.filter.

Методы класса

Объект и сохранение

Метод Описание С версии
__construct Создает объект и читает настройки фильтра
hasOptions Проверяет, есть ли у пользователя сохраненные настройки фильтра
getId Возвращает идентификатор фильтра
getOptions Возвращает все настройки фильтра
fetchOptions Читает сохраненные настройки фильтра
save Сохраняет настройки
reset Сбрасывает текущий пресет и строку поиска
destroy Удаляет сохраненные настройки фильтра

Пресеты

Метод Описание С версии
getPresets Возвращает пресеты
setPresets Заменяет пресеты
getDefaultPresets Возвращает пресеты из параметров компонента
setDefaultPresets Заменяет пресеты из параметров компонента
findDefaultPresetId Находит пресет с ключом default
getFilterSettings Возвращает настройки пресета
setFilterSettings Задает настройки пресета
setFilterSettingsArray Задает настройки нескольких пресетов
deleteFilter Удаляет пресет
isDeletedPreset Проверяет, удален ли пресет
setDeletedPresets Заменяет список удаленных пресетов
restore Восстанавливает пресеты по умолчанию
setFilterRows Задает поля пресета
removeRowFromPreset Убирает поле из пресета
getAdditionalPresetFields Возвращает дополнительные поля пресета
setAdditionalPresetFields Задает дополнительные поля пресета
getUsedFields Возвращает поля всех пресетов
fetchPresetFields Возвращает поля одного пресета
getRowsFromFields Получает коды полей из ключей значений

Текущий и закрепленный пресет

Метод Описание С версии
getCurrentFilterId Возвращает текущий пресет
getDefaultFilterId Возвращает закрепленный пресет
getSessionFilterId Возвращает пресет, который пользователь применил
setCurrentPreset Задает ключ filter в настройках
setDefaultPreset Задает закрепленный пресет
pinPreset Закрепляет пресет
isPinned Проверяет, закреплен ли пресет
isUsePinPreset Проверяет, применяется ли закрепленный пресет
setUsePinPreset Включает применение закрепленного пресета
getCurrentFilterPresetId Возвращает пресет, который задал код
setCurrentFilterPresetId Задает текущий пресет из кода
isDefaultFilter Проверяет, равен ли код пресета default_filter
isSetOutside Проверяет, применили ли фильтр снаружи компонента
setupDefaultFilter Применяет значения как временный фильтр

Значения фильтра

Метод Описание С версии
getFilter Возвращает значения текущего пресета
getFilterLogic Возвращает условия для выборки
getSearchString Возвращает строку поиска
fetchFieldValuesFromFilterSettings Получает значения полей из настроек пресета
isDateField Проверяет ключ поля даты
fetchDateFieldValue Вычисляет границы поля даты
calcDates Вычисляет границы периода
isNumberField Проверяет ключ числового поля
fetchNumberFieldValue Получает значения числового поля
isSetFromRequest Проверяет, передан ли фильтр в адресе
fetchSettingsFromQuery Получает значения полей из адреса

Общие пресеты и настройки для всех

Метод Описание С версии
isUseCommonPresets Проверяет, использует ли фильтр общие пресеты
getCommonPresetsId Возвращает идентификатор общих пресетов
fetchCommonPresets Читает общие пресеты
saveForAll Сохраняет настройки для всех пользователей, если хватает прав
saveCommon Сохраняет настройки для всех пользователей
saveOptionsForUser Сохраняет настройки для другого пользователя
getAllUserOptions Возвращает настройки фильтра всех пользователей
isCommon Проверяет, общие ли настройки
isCurrentUserEditOtherSettings Проверяет право менять чужие настройки

Константы

Константа Значение Описание
DEFAULT_FILTER 'default_filter' Пустой пресет. С ним getFilter возвращает пустой массив
TMP_FILTER 'tmp_filter' Пресет со значениями, которые пользователь ввел без сохранения

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