Документация для разработчиков

Options

Options - Класс методов настройки фильтра.

Метод Описание
Конструктор Метод-конструктор
getFilterМетод возвращает текущие значения фильтра.
getSearchStringМетод возвращает значение строки поиска фильтра.
saveМетод сохраняет значения фильтра.
getAllUserOptionsМетод возвращает опции фильтра для всех пользователей в виде объекта класса CDBResult.
saveForAllМетод сохраняет опции фильтра для всех пользователей.
isCommonМетод возвращает true, если параметры общие.
saveOptionsForUserМетод сохраняет параметры для пользователя с ID $userId.
saveCommonМетод сохраняет текущие параметры как общие.
setFilterRowsМетод устанавливает порядок рядов фильтра.
restoreМетод сбрасывает настройки фильтра к настройкам по умолчанию.
deleteFilterМетод удаляет предустановку фильтра по его ID.
isDeletedPresetМетод проверяет удалена ли предустановка.
calcDatesМетод рассчитывает значение даты.
resetМетод сбрасывает текущий примененный фильтр.
fetchCommonPresetsМетод получает список общих предустановок из базы данных.
fetchOptionsМетод получает настройки фильтра из базы данных.
findDefaultPresetIdМетод возвращает ID общей предустановки фильтра из массива предустановок.
getOptionsМетод возвращает массив настроек фильтра.
pinPresetМетод делает предустановку общей.
isSetFromRequestМетод возвращает true если поля были установлены AJAX-запросом.
fetchSettingsFromQueryМетод получает значения полей из запроса.
getSessionFilterIdМетод возвращает ID фильтра сессии.
getDefaultFilterIdМетод возвращает ID фильтра по умолчанию.
getCurrentFilterIdМетод возвращает ID текущего фильтра.
getFilterSettingsМетод возвращает массив настроек фильтра по ID предустановки.
fetchDateFieldValueМетод получает значения поля даты.
fetchNumberFieldValue>Метод получает значения числового поля.
getIdМетод возвращает ID фильтра.
setPresetsМетод устанавливает предустановки фильтра.
setCurrentPresetМетод устанавливает предустановку в качестве текущей.
getDefaultPresetsМетод возвращает массив предустановок по умолчанию из опций фильтра.
getPresetsМетод возвращает массив предустановок.
setDefaultPresetМетод устанавливает предустановку в качестве предустановки по умолчанию.
isUsePinPresetМетод возвращает список действий.
setDefaultPresetsМетод устанавливает предустановки в качестве предустановок по умолчанию.
setDeletedPresetsМетод задаёт удаленные предустановки.
setUsePinPresetМетод устанавливает значение поля use_pin_preset.
getFilterIdМетод возвращает ID фильтра.
setupDefaultFilterМетод устанавливает настройки фильтра по умолчанию.


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2019, «1С-Битрикс», 2019
Наверх