AliasFieldConfiguration
extends DcaFieldConfiguration
in package
Table of Contents
Properties
- $eval : array<string|int, mixed>
- $exclude : bool
- $filter : bool
- $search : bool
- $sorting : bool
- $flag : int|null
- $table : string
Methods
- __construct() : mixed
- getEval() : array<string|int, mixed>
- getEvalValue() : mixed
- getFlag() : int|null
- getTable() : string
- isExclude() : bool
- isFilter() : bool
- isSearch() : bool
- isSorting() : bool
- setAliasExistCallback() : AliasFieldConfiguration
- setEvalValue() : DcaFieldConfiguration
- setExclude() : DcaFieldConfiguration
- setFieldName() : AliasFieldConfiguration
- setFilter() : DcaFieldConfiguration
- setFlag() : DcaFieldConfiguration
- setGenerateAliasCallback() : AliasFieldConfiguration
- Override the default alias generation function. Provide as [Class, 'method'].
- setSearch() : DcaFieldConfiguration
- setSorting() : DcaFieldConfiguration
- setTitleField() : AliasFieldConfiguration
- Set the field name from which the alias should be generated.
Properties
$eval
protected
array<string|int, mixed>
$eval
= []
$exclude
protected
bool
$exclude
= false
$filter
protected
bool
$filter
= false
$search
protected
bool
$search
= false
$sorting
protected
bool
$sorting
= false
$flag
private
int|null
$flag
= null
$table read-only
private
string
$table
Methods
__construct()
public
__construct(string $table) : mixed
Parameters
- $table : string
getEval()
public
getEval() : array<string|int, mixed>
Return values
array<string|int, mixed>getEvalValue()
public
getEvalValue(string $key) : mixed
Parameters
- $key : string
getFlag()
public
getFlag() : int|null
Return values
int|nullgetTable()
public
getTable() : string
Return values
stringisExclude()
public
isExclude() : bool
Return values
boolisFilter()
public
isFilter() : bool
Return values
boolisSearch()
public
isSearch() : bool
Return values
boolisSorting()
public
isSorting() : bool
Return values
boolsetAliasExistCallback()
public
setAliasExistCallback(array<string, string> $aliasExistCallback) : AliasFieldConfiguration
Deprecated since version 3.10. Use setGenerateAliasCallback instead.
Parameters
- $aliasExistCallback : array<string, string>
Tags
Return values
AliasFieldConfigurationsetEvalValue()
public
setEvalValue(string $key, mixed $value) : DcaFieldConfiguration
Parameters
- $key : string
- $value : mixed
Return values
DcaFieldConfigurationsetExclude()
public
setExclude(bool $exclude) : DcaFieldConfiguration
Parameters
- $exclude : bool
Return values
DcaFieldConfigurationsetFieldName()
public
setFieldName(string $fieldName) : AliasFieldConfiguration
Parameters
- $fieldName : string
Return values
AliasFieldConfigurationsetFilter()
public
setFilter(bool $filter) : DcaFieldConfiguration
Parameters
- $filter : bool
Return values
DcaFieldConfigurationsetFlag()
public
setFlag(int|null $flag) : DcaFieldConfiguration
Parameters
- $flag : int|null
Return values
DcaFieldConfigurationsetGenerateAliasCallback()
Override the default alias generation function. Provide as [Class, 'method'].
public
setGenerateAliasCallback(array<string, string> $callback) : AliasFieldConfiguration
Parameters
- $callback : array<string, string>
Return values
AliasFieldConfigurationsetSearch()
public
setSearch(bool $search) : DcaFieldConfiguration
Parameters
- $search : bool
Return values
DcaFieldConfigurationsetSorting()
public
setSorting(bool $sorting) : DcaFieldConfiguration
Parameters
- $sorting : bool
Return values
DcaFieldConfigurationsetTitleField()
Set the field name from which the alias should be generated.
public
setTitleField(string $titleField) : AliasFieldConfiguration
Parameters
- $titleField : string