Factory
Table of Contents
Methods
- convertSettingsParams() : array<string|int, mixed>
- Convert $parameters in suitable for EntitySettings format
- createEntityFilter() : Filter
- Create Filter by specified entity type ID.
- createEntitySettings() : mixed
- createFilter() : Filter
- getClientDataProviders() : array<string|int, mixed>
- getDataProvider() : DataProvider
- getFilter() : Filter|null
- getFilterValue() : array<string|int, mixed>
- Returns ORM-compatible filter value for specified user
- getRequisiteDataProvider() : RequisiteDataProvider
- getSettings() : EntitySettings
- getSettingsByGridId() : EntitySettings
- Get Settings object with correct parameters according to $gridId
- getUserFieldDataProvider() : DataProvider
Methods
convertSettingsParams()
Convert $parameters in suitable for EntitySettings format
public
static convertSettingsParams(int $entityTypeId, array<string|int, mixed> $parameters) : array<string|int, mixed>
Parameters
- $entityTypeId : int
- $parameters : array<string|int, mixed>
Return values
array<string|int, mixed>createEntityFilter()
Create Filter by specified entity type ID.
public
static createEntityFilter(EntitySettings $settings) : Filter
Parameters
- $settings : EntitySettings
-
Entity Filter settings.
Tags
Return values
FiltercreateEntitySettings()
public
static createEntitySettings(mixed $entityTypeID, mixed $filterID[, array<string|int, mixed> $parameters = [] ]) : mixed
Parameters
- $entityTypeID : mixed
- $filterID : mixed
- $parameters : array<string|int, mixed> = []
createFilter()
public
createFilter(mixed $ID, DataProvider $entityDataProvider[, array<string|int, mixed> $extraDataProviders = null ][, array<string|int, mixed> $params = null ]) : Filter
Parameters
- $ID : mixed
- $entityDataProvider : DataProvider
- $extraDataProviders : array<string|int, mixed> = null
- $params : array<string|int, mixed> = null
Return values
FiltergetClientDataProviders()
public
getClientDataProviders(EntitySettings $settings) : array<string|int, mixed>
Parameters
- $settings : EntitySettings
Return values
array<string|int, mixed>getDataProvider()
public
getDataProvider(EntitySettings $settings) : DataProvider
Parameters
- $settings : EntitySettings
Return values
DataProvidergetFilter()
public
getFilter(EntitySettings $settings[, array<string|int, mixed>|null $parameters = [] ]) : Filter|null
Parameters
- $settings : EntitySettings
- $parameters : array<string|int, mixed>|null = []
Return values
Filter|nullgetFilterValue()
Returns ORM-compatible filter value for specified user
public
getFilterValue(Filter $filter[, int|null $userId = null ]) : array<string|int, mixed>
Parameters
- $filter : Filter
- $userId : int|null = null
Return values
array<string|int, mixed>getRequisiteDataProvider()
public
getRequisiteDataProvider(EntitySettings $settings) : RequisiteDataProvider
Parameters
- $settings : EntitySettings
Return values
RequisiteDataProvidergetSettings()
public
getSettings(int $entityTypeId, string $filterId[, array<string|int, mixed>|null $parameters = [] ]) : EntitySettings
Parameters
- $entityTypeId : int
- $filterId : string
- $parameters : array<string|int, mixed>|null = []
Return values
EntitySettingsgetSettingsByGridId()
Get Settings object with correct parameters according to $gridId
public
static getSettingsByGridId(int $entityTypeId, string $gridId) : EntitySettings
Parameters
- $entityTypeId : int
- $gridId : string
Tags
Return values
EntitySettingsgetUserFieldDataProvider()
public
getUserFieldDataProvider(EntitySettings $settings) : DataProvider
Parameters
- $settings : EntitySettings