DocumentDataProvider extends EntityDataProvider
Table of Contents
Methods
- __construct() : mixed
- getGridColumns() : mixed
- getID() : string
- Get ID.
- getSettings() : Settings
- Get Settings
- 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.
Methods
__construct()
public
__construct(mixed $mode) : mixed
Parameters
- $mode : mixed
getGridColumns()
public
getGridColumns() : mixed
getID()
Get ID.
public
getID() : string
Return values
stringgetSettings()
Get Settings
public
getSettings() : Settings
Return values
SettingsprepareFieldData()
Prepare complete field data for specified field.
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 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, string $fieldID) : void
Parameters
- $filter : array<string|int, mixed>
-
Filter params.
- $fieldID : string
-
Field ID.