Filter
Class Filter
Table of Contents
Constants
- AssignedById = 'ASSIGNED_BY_ID'
- ChannelCode = 'TRACKING_CHANNEL_CODE'
- DateCreate = 'DATE_CREATE'
- SourceId = 'TRACKING_SOURCE_ID'
Methods
- appendEffectiveFields() : void
- Append effective filter fields for applying filter from URL.
- appendFields() : void
- Append filter fields.
- buildFilterAfterPrepareSql() : void
- Append sql to filter builder.
- buildOrmFilter() : mixed
- getFieldData() : array<string|int, mixed>
- Return true if has filter field.
- getFields() : array<string|int, string>
- Returns all available filter fields' codes
- hasField() : bool
- Return true if filter has field.
Constants
AssignedById
public
mixed
AssignedById
= 'ASSIGNED_BY_ID'
ChannelCode
public
mixed
ChannelCode
= 'TRACKING_CHANNEL_CODE'
DateCreate
public
mixed
DateCreate
= 'DATE_CREATE'
SourceId
public
mixed
SourceId
= 'TRACKING_SOURCE_ID'
Methods
appendEffectiveFields()
Append effective filter fields for applying filter from URL.
public
static appendEffectiveFields(array<string|int, mixed> &$fields) : void
Parameters
- $fields : array<string|int, mixed>
-
Fields.
appendFields()
Append filter fields.
public
static appendFields(array<string|int, mixed> &$fields, EntityDataProvider $entityDataProvider) : void
Parameters
- $fields : array<string|int, mixed>
-
Fields.
- $entityDataProvider : EntityDataProvider
-
Entity filter data provider.
buildFilterAfterPrepareSql()
Append sql to filter builder.
public
static buildFilterAfterPrepareSql(array<string|int, mixed> &$sqlData, array<string|int, mixed> $filter, int $entityTypeId[, string $entitySqlTableAlias = 'L' ]) : void
Parameters
- $sqlData : array<string|int, mixed>
-
Sql data.
- $filter : array<string|int, mixed>
-
Filter.
- $entityTypeId : int
-
Entity type ID.
- $entitySqlTableAlias : string = 'L'
-
Entity sql table alias.
buildOrmFilter()
public
static buildOrmFilter(mixed &$result, array<string|int, mixed> $filter, mixed $entityTypeId, mixed &$runtime) : mixed
Parameters
- $result : mixed
- $filter : array<string|int, mixed>
- $entityTypeId : mixed
- $runtime : mixed
getFieldData()
Return true if has filter field.
public
static getFieldData(string $fieldId) : array<string|int, mixed>
Parameters
- $fieldId : string
-
Field ID.
Return values
array<string|int, mixed>getFields()
Returns all available filter fields' codes
public
static getFields() : array<string|int, string>
Return values
array<string|int, string>hasField()
Return true if filter has field.
public
static hasField(string $fieldId) : bool
Parameters
- $fieldId : string
-
Field ID.