ItemDataProvider extends EntityDataProvider
Table of Contents
Constants
- DISPLAY_ANYWHERE = 'anywhere'
- DISPLAY_IN_FILTER = 'filter'
- DISPLAY_IN_GRID = 'grid'
- FIELD_STAGE_SEMANTIC = 'STAGE_SEMANTIC_ID'
- QUERY_APPROACH_BUILDER = 'builder'
- QUERY_APPROACH_ORM = 'orm'
- TYPE_BOOLEAN = 'checkbox'
- TYPE_CRM_ENTITY = 'crm_entity'
- TYPE_DATE = 'date'
- TYPE_ENTITY_SELECTOR = 'entity_selector'
- TYPE_LIST = 'list'
- TYPE_NUMBER = 'number'
- TYPE_PARENT = 'parent'
- TYPE_STRING = 'string'
- TYPE_TEXT = 'text'
- TYPE_USER = 'entity_selector'
Methods
- __construct() : mixed
- applyActivityFastSearchFilter() : void
- applyActivityResponsibleFilter() : void
- applyCounterFilter() : void
- getDataProviderQueryApproach() : string|null
- getFieldNamesByType() : array<string|int, mixed>
- getGridColumns() : array<string|int, mixed>
- getID() : string
- Get ID.
- getSettings() : Settings
- Get Settings
- prepareFieldData() : array<string|int, mixed>|null
- Prepare fields data for filter
- prepareFieldHtml() : string
- Prepare Field additional HTML.
- prepareFields() : array<string|int, Field>
- Prepare fields configs for filter
- prepareFilterValue() : array<string|int, mixed>
- Prepare ui filter value to be suitable for corresponding entity getList
- prepareListFilter() : void
- Prepare ORM filter from data, received from the frontend filter
- prepareListFilterParam() : void
- Prepare field parameter for specified field.
- processStageSemanticFilter() : void
Constants
DISPLAY_ANYWHERE
public
mixed
DISPLAY_ANYWHERE
= 'anywhere'
DISPLAY_IN_FILTER
public
mixed
DISPLAY_IN_FILTER
= 'filter'
DISPLAY_IN_GRID
public
mixed
DISPLAY_IN_GRID
= 'grid'
FIELD_STAGE_SEMANTIC
public
mixed
FIELD_STAGE_SEMANTIC
= 'STAGE_SEMANTIC_ID'
QUERY_APPROACH_BUILDER
public
mixed
QUERY_APPROACH_BUILDER
= 'builder'
QUERY_APPROACH_ORM
public
mixed
QUERY_APPROACH_ORM
= 'orm'
TYPE_BOOLEAN
public
mixed
TYPE_BOOLEAN
= 'checkbox'
TYPE_CRM_ENTITY
public
mixed
TYPE_CRM_ENTITY
= 'crm_entity'
TYPE_DATE
public
mixed
TYPE_DATE
= 'date'
TYPE_ENTITY_SELECTOR
public
mixed
TYPE_ENTITY_SELECTOR
= 'entity_selector'
TYPE_LIST
public
mixed
TYPE_LIST
= 'list'
TYPE_NUMBER
public
mixed
TYPE_NUMBER
= 'number'
TYPE_PARENT
public
mixed
TYPE_PARENT
= 'parent'
TYPE_STRING
public
mixed
TYPE_STRING
= 'string'
TYPE_TEXT
public
mixed
TYPE_TEXT
= 'text'
TYPE_USER
public
mixed
TYPE_USER
= 'entity_selector'
Methods
__construct()
public
__construct(ItemSettings $settings, Factory $factory) : mixed
Parameters
- $settings : ItemSettings
- $factory : Factory
applyActivityFastSearchFilter()
public
applyActivityFastSearchFilter(int $entityTypeId, array<string|int, mixed> &$filterFields) : void
Parameters
- $entityTypeId : int
- $filterFields : array<string|int, mixed>
applyActivityResponsibleFilter()
public
applyActivityResponsibleFilter(int $entityTypeId, array<string|int, mixed> &$filterFields) : void
Parameters
- $entityTypeId : int
- $filterFields : array<string|int, mixed>
applyCounterFilter()
public
applyCounterFilter(int $entityTypeId, array<string|int, mixed> &$filterFields[, array<string|int, mixed> $extras = [] ]) : void
Parameters
- $entityTypeId : int
- $filterFields : array<string|int, mixed>
- $extras : array<string|int, mixed> = []
getDataProviderQueryApproach()
public
getDataProviderQueryApproach() : string|null
Return values
string|nullgetFieldNamesByType()
public
getFieldNamesByType(string $type[, string $whereToDisplay = self::DISPLAY_ANYWHERE ]) : array<string|int, mixed>
Parameters
- $type : string
- $whereToDisplay : string = self::DISPLAY_ANYWHERE
Return values
array<string|int, mixed>getGridColumns()
public
getGridColumns() : array<string|int, mixed>
Return values
array<string|int, mixed>getID()
Get ID.
public
getID() : string
Return values
stringgetSettings()
Get Settings
public
getSettings() : Settings
Tags
Return values
SettingsprepareFieldData()
Prepare fields data for filter
public
prepareFieldData(mixed $fieldID) : array<string|int, mixed>|null
Parameters
- $fieldID : mixed
-
Field ID.
Tags
Return values
array<string|int, mixed>|nullprepareFieldHtml()
Prepare Field additional HTML.
public
prepareFieldHtml(Field $field) : string
Parameters
- $field : Field
-
Field.
Return values
stringprepareFields()
Prepare fields configs for filter
public
prepareFields() : array<string|int, Field>
Tags
Return values
array<string|int, Field>prepareFilterValue()
Prepare ui filter value to be suitable for corresponding entity getList
public
prepareFilterValue(array<string|int, mixed> $rawFilterValue) : array<string|int, mixed>
Parameters
- $rawFilterValue : array<string|int, mixed>
Return values
array<string|int, mixed>prepareListFilter()
Prepare ORM filter from data, received from the frontend filter
public
prepareListFilter(array<string|int, mixed> &$filter, array<string|int, mixed> $requestFilter) : void
Parameters
- $filter : array<string|int, mixed>
- $requestFilter : array<string|int, mixed>
prepareListFilterParam()
Prepare field parameter for specified field.
public
prepareListFilterParam(array<string|int, mixed> &$filter, mixed $fieldID) : void
Parameters
- $filter : array<string|int, mixed>
-
Filter params.
- $fieldID : mixed
-
Field ID.
processStageSemanticFilter()
public
static processStageSemanticFilter(array<string|int, mixed> $requestFilter, array<string|int, mixed> &$filter) : void
Parameters
- $requestFilter : array<string|int, mixed>
- $filter : array<string|int, mixed>