Bitrix API

UiFilterOptions extends Options

Class Options of main.ui.filter

Table of Contents

Constants

DEFAULT_FILTER  = "default_filter"
TMP_FILTER  = "tmp_filter"

Methods

__construct()  : mixed
Options constructor.
calcDates()  : mixed
Calculate date value
deleteFilter()  : mixed
Deletes preset by preset id
destroy()  : mixed
Destroys this filter options
fetchCommonPresets()  : array<string|int, mixed>|bool
Gets common presets from database
fetchDateFieldValue()  : array<string|int, mixed>
Fetches date field values
fetchFieldValuesFromFilterSettings()  : mixed
fetchNumberFieldValue()  : array<string|int, mixed>
Fetches number field values
fetchOptions()  : array<string|int, mixed>|bool
Gets filter options from database
fetchPresetFields()  : array<string|int, mixed>
Fetches preset fields list
fetchSettingsFromQuery()  : array<string|int, mixed>|null
Fetches field values from request
findDefaultPresetId()  : string
Finds default preset in presets array
getAdditionalPresetFields()  : array<string|int, mixed>
Gets additional preset fields
getAllUserOptions()  : bool|CDBResult
Gets filter options for all users
getCommonPresetsId()  : string
getCurrentFilterId()  : mixed
Gets current applied filter id
getCurrentFilterPresetId()  : string|null
getDefaultFilterId()  : mixed
Gets default filter
getDefaultPresets()  : array<string|int, mixed>|null
Gets default presets from filter options
getFilter()  : array<string|int, mixed>
Gets current filter values
getFilterLogic()  : array<string|int, mixed>
Gets current filter values that available for DB seach
getFilterSettings()  : array<string|int, mixed>|null
Gets filter settings by preset id
getId()  : string
Gets filter id
getOptions()  : array<string|int, mixed>
Gets filter options
getPresets()  : array<string|int, mixed>|null
Gets presets
getRowsFromFields()  : mixed
getSearchString()  : string
Gets filter search string
getSessionFilterId()  : mixed
Gets session filter
getUsedFields()  : array<string|int, mixed>
Gets used fields
isCommon()  : bool
Checks whether the parameters are common
isCurrentUserEditOtherSettings()  : bool
isDateField()  : bool
isDefaultFilter()  : bool
isDeletedPreset()  : bool
Checks preset is deleted
isNumberField()  : mixed
isSetFromRequest()  : bool
Checks is need whether to set fields from query
isSetOutside()  : bool
isUseCommonPresets()  : bool
isUsePinPreset()  : bool
Checks is need use pinned preset
pinPreset()  : mixed
Makes preset as default
removeRowFromPreset()  : bool
reset()  : mixed
Resets current applied filter
restore()  : mixed
Restores filter options to default
save()  : mixed
Saves filter optionsGet
saveCommon()  : mixed
Saves current options as common
saveForAll()  : mixed
Saves filter options for all users
saveOptionsForUser()  : mixed
Saves options for user with $userId
setAdditionalPresetFields()  : mixed
Sets additional fields
setCurrentFilterPresetId()  : Options
setCurrentPreset()  : mixed
Sets current preset id
setDefaultPreset()  : mixed
Sets default preset id
setDefaultPresets()  : mixed
Sets default presets
setDeletedPresets()  : mixed
Sets deleted presets array
setFilterRows()  : mixed
Sets filter preset rows
setFilterSettings()  : mixed
setFilterSettingsArray()  : mixed
setPresets()  : mixed
Sets filter presets
setupDefaultFilter()  : mixed
Setup Default Filter Settings
setUsePinPreset()  : mixed
Sets use_pin_preset values

Constants

DEFAULT_FILTER

public mixed DEFAULT_FILTER = "default_filter"

TMP_FILTER

public mixed TMP_FILTER = "tmp_filter"

Methods

__construct()

Options constructor.

public __construct(string $filterId[, array<string|int, mixed> $filterPresets = [] ][, string $commonPresetsId = null ]) : mixed
Parameters
$filterId : string

$arParams["FILTER_ID"]

$filterPresets : array<string|int, mixed> = []

$arParams["FILTER_PRESETS"]

$commonPresetsId : string = null

$arParams["COMMON_PRESETS_ID"] Set if you want to use common presets

calcDates()

Calculate date value

public static calcDates(string $fieldId, array<string|int, mixed> $source, array<string|int, mixed> &$result) : mixed
Parameters
$fieldId : string
$source : array<string|int, mixed>

Source values

$result : array<string|int, mixed>

Result values

Tags
throws
ObjectException

deleteFilter()

Deletes preset by preset id

public deleteFilter(string $presetId[, bool $isDefault = false ]) : mixed
Parameters
$presetId : string
$isDefault : bool = false

destroy()

Destroys this filter options

public destroy() : mixed

fetchCommonPresets()

Gets common presets from database

public static fetchCommonPresets(string $id) : array<string|int, mixed>|bool
Parameters
$id : string

Common presets id $arParams["COMMON_PRESETS_ID"]

Return values
array<string|int, mixed>|bool

fetchDateFieldValue()

Fetches date field values

public static fetchDateFieldValue([string $key = "" ][, array<string|int, mixed> $filterFields = [] ]) : array<string|int, mixed>
Parameters
$key : string = ""
$filterFields : array<string|int, mixed> = []
Tags
throws
ObjectException
Return values
array<string|int, mixed>

fetchFieldValuesFromFilterSettings()

public static fetchFieldValuesFromFilterSettings([mixed $filterSettings = [] ][, mixed $additionalFields = [] ][, mixed $sourceFields = [] ]) : mixed
Parameters
$filterSettings : mixed = []
$additionalFields : mixed = []
$sourceFields : mixed = []

fetchNumberFieldValue()

Fetches number field values

public static fetchNumberFieldValue([string $key = "" ][, array<string|int, mixed> $filterFields = [] ]) : array<string|int, mixed>
Parameters
$key : string = ""
$filterFields : array<string|int, mixed> = []
Return values
array<string|int, mixed>

fetchOptions()

Gets filter options from database

public fetchOptions(string $id) : array<string|int, mixed>|bool
Parameters
$id : string

Filter id $arParams["FILTER_ID"]

Return values
array<string|int, mixed>|bool

fetchPresetFields()

Fetches preset fields list

public static fetchPresetFields(array<string|int, mixed> $preset) : array<string|int, mixed>
Parameters
$preset : array<string|int, mixed>
Return values
array<string|int, mixed>

fetchSettingsFromQuery()

Fetches field values from request

public static fetchSettingsFromQuery(array<string|int, mixed> $fields, HttpRequest $request) : array<string|int, mixed>|null
Parameters
$fields : array<string|int, mixed>
$request : HttpRequest
Return values
array<string|int, mixed>|null

findDefaultPresetId()

Finds default preset in presets array

public static findDefaultPresetId([array<string|int, mixed> $presets = [] ]) : string
Parameters
$presets : array<string|int, mixed> = []
Return values
string —

Default preset id

getAdditionalPresetFields()

Gets additional preset fields

public getAdditionalPresetFields(string $presetId) : array<string|int, mixed>
Parameters
$presetId : string
Return values
array<string|int, mixed>

getAllUserOptions()

Gets filter options for all users

public getAllUserOptions() : bool|CDBResult
Return values
bool|CDBResult

getCommonPresetsId()

public getCommonPresetsId() : string
Return values
string

getCurrentFilterId()

Gets current applied filter id

public getCurrentFilterId() : mixed

getCurrentFilterPresetId()

public getCurrentFilterPresetId() : string|null
Return values
string|null

getDefaultFilterId()

Gets default filter

public getDefaultFilterId() : mixed

getDefaultPresets()

Gets default presets from filter options

public getDefaultPresets() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getFilter()

Gets current filter values

public getFilter([mixed $sourceFields = [] ]) : array<string|int, mixed>
Parameters
$sourceFields : mixed = []

Filter fields $arParams["FILTER"]

Return values
array<string|int, mixed>

getFilterLogic()

Gets current filter values that available for DB seach

public getFilterLogic([array<string|int, mixed> $sourceFields = [] ]) : array<string|int, mixed>
Parameters
$sourceFields : array<string|int, mixed> = []

Filter fields $arParams["FILTER"]

Return values
array<string|int, mixed>

getFilterSettings()

Gets filter settings by preset id

public getFilterSettings(mixed $presetId) : array<string|int, mixed>|null
Parameters
$presetId : mixed
Return values
array<string|int, mixed>|null

getId()

Gets filter id

public getId() : string
Return values
string

getOptions()

Gets filter options

public getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPresets()

Gets presets

public getPresets() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getRowsFromFields()

public static getRowsFromFields([mixed $fields = [] ]) : mixed
Parameters
$fields : mixed = []

getSearchString()

Gets filter search string

public getSearchString() : string
Return values
string

getSessionFilterId()

Gets session filter

public getSessionFilterId() : mixed

getUsedFields()

Gets used fields

public getUsedFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

isCommon()

Checks whether the parameters are common

public static isCommon(mixed $options) : bool
Parameters
$options : mixed
Return values
bool

isCurrentUserEditOtherSettings()

public static isCurrentUserEditOtherSettings() : bool
Return values
bool

isDateField()

public static isDateField([string $key = "" ]) : bool
Parameters
$key : string = ""
Return values
bool

isDefaultFilter()

public static isDefaultFilter([string $presetId = "" ]) : bool
Parameters
$presetId : string = ""
Return values
bool

isDeletedPreset()

Checks preset is deleted

public isDeletedPreset(string $presetId) : bool
Parameters
$presetId : string
Return values
bool

isNumberField()

public static isNumberField([mixed $key = "" ]) : mixed
Parameters
$key : mixed = ""

isSetFromRequest()

Checks is need whether to set fields from query

public static isSetFromRequest(HttpRequest $request) : bool
Parameters
$request : HttpRequest
Return values
bool

isSetOutside()

public isSetOutside() : bool
Return values
bool

isUseCommonPresets()

public isUseCommonPresets() : bool
Return values
bool

isUsePinPreset()

Checks is need use pinned preset

public isUsePinPreset() : bool
Return values
bool

pinPreset()

Makes preset as default

public pinPreset([string $presetId = "default_filter" ]) : mixed
Parameters
$presetId : string = "default_filter"

Preset id

removeRowFromPreset()

public removeRowFromPreset(string $presetId, string $rowName) : bool
Parameters
$presetId : string
$rowName : string
Return values
bool

reset()

Resets current applied filter

public reset() : mixed

restore()

Restores filter options to default

public restore([array<string|int, mixed> $settings = [] ]) : mixed
Parameters
$settings : array<string|int, mixed> = []

save()

Saves filter optionsGet

public save() : mixed

saveCommon()

Saves current options as common

public saveCommon() : mixed

saveForAll()

Saves filter options for all users

public saveForAll() : mixed

saveOptionsForUser()

Saves options for user with $userId

public saveOptionsForUser(array<string|int, mixed> $options, mixed $userId) : mixed
Parameters
$options : array<string|int, mixed>
$userId : mixed

setAdditionalPresetFields()

Sets additional fields

public setAdditionalPresetFields(string $presetId[, array<string|int, mixed> $additional = [] ]) : mixed
Parameters
$presetId : string
$additional : array<string|int, mixed> = []

setCurrentFilterPresetId()

public setCurrentFilterPresetId(string|null $presetId) : Options
Parameters
$presetId : string|null
Return values
Options

setCurrentPreset()

Sets current preset id

public setCurrentPreset([string $presetId = "default_filter" ]) : mixed
Parameters
$presetId : string = "default_filter"

setDefaultPreset()

Sets default preset id

public setDefaultPreset([string $presetId = "default_filter" ]) : mixed
Parameters
$presetId : string = "default_filter"

setDefaultPresets()

Sets default presets

public setDefaultPresets([array<string|int, mixed> $presets = [] ]) : mixed
Parameters
$presets : array<string|int, mixed> = []

setDeletedPresets()

Sets deleted presets array

public setDeletedPresets([array<string|int, mixed> $deletedPresets = [] ]) : mixed
Parameters
$deletedPresets : array<string|int, mixed> = []

setFilterRows()

Sets filter preset rows

public setFilterRows(string $presetId, mixed $rows) : mixed
Parameters
$presetId : string
$rows : mixed

setFilterSettings()

public setFilterSettings(string $presetId, mixed $settings[, bool $currentPreset = true ][, bool $useRequest = true ]) : mixed
Parameters
$presetId : string
$settings : mixed
$currentPreset : bool = true
$useRequest : bool = true

setFilterSettingsArray()

public setFilterSettingsArray([array<string|int, mixed> $settings = [] ]) : mixed
Parameters
$settings : array<string|int, mixed> = []

setPresets()

Sets filter presets

public setPresets([array<string|int, mixed> $presets = [] ]) : mixed
Parameters
$presets : array<string|int, mixed> = []

setupDefaultFilter()

Setup Default Filter Settings

public setupDefaultFilter(array<string|int, mixed> $fields, array<string|int, mixed> $rows) : mixed
Parameters
$fields : array<string|int, mixed>

Default Filter Fields.

$rows : array<string|int, mixed>

Default Filter Rows.

setUsePinPreset()

Sets use_pin_preset values

public setUsePinPreset([bool $value = true ]) : mixed
Parameters
$value : bool = true 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results