Documentation

Options

Options class of filter settings methods.

Method Description
Constructor Constructor method
getFilterReturns current filter values.
getSearchStringReturns filter search string value.
saveSaves filter value.
getAllUserOptionsReturns filter options for all users as object of CDBResult class.
saveForAllSaves filter options for all users.
isCommonReturns true, when parameters are common.
saveOptionsForUserSaves parameters for user with $userId.
saveCommonSaves current parameters as common.
setFilterRowsSets filter row order.
restoreResets filter settings to default settings.
deleteFilterDeletes filter preset by its ID.
isDeletedPresetChecks if preset is deleted.
calcDatesCalculates the date value.
resetResets current applied filter.
fetchCommonPresetsGets list of common presets from database.
fetchOptionsGets filter settings from database.
findDefaultPresetIdReturns filter default preset ID from presets array.
getOptionsReturns array with filter settings.
pinPreset Applies preset as common.
isSetFromRequestReturns true when fields were preset by AJAX request.
fetchSettingsFromQueryGets setting field values from query.
getSessionFilterIdReturns session filter ID.
getDefaultFilterIdReturns filter ID by default.
getCurrentFilterIdReturns current filter ID.
getFilterSettingsReturns array with filter settings by preset ID.
fetchDateFieldValueGets date field values.
fetchNumberFieldValue>Gets numeric field values.
getIdReturns filter ID.
setPresetsSets filter presets.
setCurrentPresetSets preset as current.
getDefaultPresetsReturns array with default presets from filter options.
getPresetsReturns array with presets.
setDefaultPresetSets preset as the default preset.
isUsePinPresetReturns list of actions.
setDefaultPresetsSets preset as the default presets.
setDeletedPresetsSets deleted presets.
setUsePinPresetSets use_pin_preset field value.
[link=11517674]getFilterId[/link]Returns filter ID.
[link=11517694]setupDefaultFilter[/link]Sets default filter settings.


© «Bitrix24», 2001-2024
Up