ProductFilter extends Filter
Table of Contents
Methods
- __construct() : mixed
- getDefaultFieldIDs() : array<string|int, mixed>
- Get Default Field IDs.
- getEntityDataProvider() : DataProvider|null
- getField() : Field|null
- Get Field by ID.
- getFieldArrays() : array<string|int, mixed>
- Get Fields converted to plain object (array).
- getFields() : array<string|int, Field>
- Get Field list.
- getID() : string
- Get Filter ID.
- getValue() : array<string|int, mixed>
- Get value suitable to use in getList
- prepareListFilterParams() : void
- Prepare list filter params.
Methods
__construct()
public
__construct(mixed $ID, DataProvider $entityDataProvider[, array<string|int, mixed> $extraDataProviders = null ][, array<string|int, mixed> $params = null ]) : mixed
Parameters
- $ID : mixed
- $entityDataProvider : DataProvider
- $extraDataProviders : array<string|int, mixed> = null
- $params : array<string|int, mixed> = null
getDefaultFieldIDs()
Get Default Field IDs.
public
getDefaultFieldIDs() : array<string|int, mixed>
Return values
array<string|int, mixed>getEntityDataProvider()
public
getEntityDataProvider() : DataProvider|null
Return values
DataProvider|nullgetField()
Get Field by ID.
public
getField(string $fieldID) : Field|null
Parameters
- $fieldID : string
-
Field ID.
Return values
Field|nullgetFieldArrays()
Get Fields converted to plain object (array).
public
getFieldArrays([array<string|int, mixed> $fieldMask = [] ]) : array<string|int, mixed>
Parameters
- $fieldMask : array<string|int, mixed> = []
Return values
array<string|int, mixed>getFields()
Get Field list.
public
getFields() : array<string|int, Field>
Return values
array<string|int, Field>getID()
Get Filter ID.
public
getID() : string
Return values
stringgetValue()
Get value suitable to use in getList
public
getValue([array<string|int, mixed>|null $rawValue = null ]) : array<string|int, mixed>
If $rawValue is not set, will be used current main.ui.filter value
Parameters
- $rawValue : array<string|int, mixed>|null = null
Return values
array<string|int, mixed>prepareListFilterParams()
Prepare list filter params.
public
prepareListFilterParams(array<string|int, mixed> &$filter) : void
Parameters
- $filter : array<string|int, mixed>
-
Source Filter.