Класс Filter

Граф наследования:Filter:

Открытые члены
	__construct ($ID, DataProvider $entityDataProvider, array $extraDataProviders=null, array $params=null)
	getID ()
	getDefaultFieldIDs ()
	getFields ()
	getFieldArrays (array $fieldMask=[])
	getField ($fieldID)
	getEntityDataProvider ()
	prepareListFilterParams (array &$filter)
	getValue (?array $rawValue=null)

Защищенные члены
	removeServiceUiFilterFields (array &$filter)
	removeNotUiFilterFields (array &$filter)
	prepareFilterValue (array &$value)

Защищенные данные
	$ID = ''
	$entityDataProvider = null
	$extraProviders = null
	$params = null
	$fields = null
	$uiFilterPostfixes
	$uiFilterServiceFields

Подробное описание

См. определение в файле filter.php строка 4

Конструктор(ы)

__construct()

__construct	(		$ID,
		DataProvider	$entityDataProvider,
		array	$extraDataProviders = null,
		array	$params = null )

См. определение в файле filter.php строка 35

Методы

getDefaultFieldIDs()

getDefaultFieldIDs

(

)

Get Default Field IDs.

Возвращает

array

См. определение в файле filter.php строка 68

getEntityDataProvider()

getEntityDataProvider

(

)

Возвращает

DataProvider|null

См. определение в файле filter.php строка 142

getField()

getField

(

$fieldID

)

Get Field by ID.

Аргументы

string

$fieldID

Field ID.

Возвращает

Field|null

См. определение в файле filter.php строка 133

getFieldArrays()

getFieldArrays

(

array

$fieldMask = []

)

Get Fields converted to plain object (array).

Аргументы

array

$fieldMask

Возвращает

array

См. определение в файле filter.php строка 108

getFields()

getFields

(

)

Get Field list.

Возвращает

Field[]

См. определение в файле filter.php строка 85

getID()

getID

(

)

Get Filter ID.

Возвращает

string

См. определение в файле filter.php строка 59

getValue()

getValue

(

?array

$rawValue = null

)

Get value suitable to use in getList

If $rawValue is not set, will be used current main.ui.filter value

Аргументы

array | null

$rawValue

Возвращает

array

См. определение в файле filter.php строка 168

prepareFilterValue()

prepareFilterValue ( array & $value )

protected

См. определение в файле filter.php строка 260

prepareListFilterParams()

prepareListFilterParams

(

array &

$filter

)

Prepare list filter params.

Аргументы

array

$filter

Source Filter.

Возвращает

void

См. определение в файле filter.php строка 152

removeNotUiFilterFields()

removeNotUiFilterFields ( array & $filter )

protected

Remove fields from $filter which are not really defined as filter fields

Аргументы

array

$filter

См. определение в файле filter.php строка 217

removeServiceUiFilterFields()

removeServiceUiFilterFields ( array & $filter )

protected

Clear filter fields from main.ui.filter which are not actually needed for filter in getList

Аргументы

array

$filter

Переопределяется в ProductFilter.

См. определение в файле filter.php строка 194

Поля

$entityDataProvider

$entityDataProvider = null

protected

См. определение в файле filter.php строка 9

$extraProviders

$extraProviders = null

protected

См. определение в файле filter.php строка 11

$fields

$fields = null

protected

См. определение в файле filter.php строка 17

$ID

$ID = ''

protected

См. определение в файле filter.php строка 7

$params

$params = null

protected

См. определение в файле filter.php строка 14

$uiFilterPostfixes

$uiFilterPostfixes

protected

Инициализатор

= [
        '_datesel', '_month', '_quarter', '_year', '_days', 
        '_numsel', 
        '_from', '_to', 
        '_isEmpty', 
        '_hasAnyValue', 
        '_label', 
    ]

См. определение в файле filter.php строка 19

$uiFilterServiceFields

$uiFilterServiceFields

protected

Инициализатор

= [
        'FILTER_ID',
        'FILTER_APPLIED',
        'PRESET_ID',
        'FIND',
    ]

См. определение в файле filter.php строка 28

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/main/lib/filter/filter.php