LeadDataProvider extends EntityDataProvider implements FactoryOptionable uses ForceUseFactoryTrait
Table of Contents
Interfaces
Constants
- QUERY_APPROACH_BUILDER = 'builder'
- QUERY_APPROACH_ORM = 'orm'
Methods
- __construct() : mixed
- applyActivityFastSearchFilter() : void
- applyActivityResponsibleFilter() : void
- applyCounterFilter() : void
- getDataProviderQueryApproach() : string|null
- getID() : string
- Get ID.
- getSettings() : LeadSettings
- Get Settings
- isForceUseFactory() : bool
- prepareFieldData() : array<string|int, mixed>|null
- Prepare complete field data for specified field.
- prepareFieldHtml() : string
- Prepare Field additional HTML.
- prepareFields() : array<string|int, Field>
- Prepare field list.
- prepareFilterValue() : array<string|int, mixed>
- Prepare ui filter value to be suitable for corresponding entity getList
- prepareListFilterParam() : void
- Prepare field parameter for specified field.
- setForceUseFactory() : void
Constants
QUERY_APPROACH_BUILDER
public
mixed
QUERY_APPROACH_BUILDER
= 'builder'
QUERY_APPROACH_ORM
public
mixed
QUERY_APPROACH_ORM
= 'orm'
Methods
__construct()
public
__construct(LeadSettings $settings) : mixed
Parameters
- $settings : LeadSettings
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|nullgetID()
Get ID.
public
getID() : string
Return values
stringgetSettings()
Get Settings
public
getSettings() : LeadSettings
Return values
LeadSettingsisForceUseFactory()
public
isForceUseFactory() : bool
Return values
boolprepareFieldData()
Prepare complete field data for specified field.
public
prepareFieldData(string $fieldID) : array<string|int, mixed>|null
Parameters
- $fieldID : string
-
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 field list.
public
prepareFields() : array<string|int, Field>
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>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.
setForceUseFactory()
public
setForceUseFactory(bool $value) : void
Parameters
- $value : bool