Indexable
The field type interface which all field types have to implement to be indexable by search backends.
Methods¶
getDefaultMatchField()
¶
Get name of the default field to be used for matching.
|
|
|
As field types can index multiple fields (see MapLocation field type's implementation of this interface), this method is used to define default field for matching. Default field is typically used by Field criterion.
Return values
string|null
getDefaultSortField()
¶
Get name of the default field to be used for sorting.
|
|
|
As field types can index multiple fields (see MapLocation field type's implementation of this interface), this method is used to define default field for sorting. Default field is typically used by Field sort clause.
Return values
string|null
getIndexData()
¶
Get index data for field for search backend.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $field | Field | - | - |
| $fieldDefinition | FieldDefinition | - | - |
Return values
array<string|int, Field>
getIndexDefinition()
¶
Get index field types for search backend.
|
|
|
Return values
array<string, FieldType>