PHP Interface Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface

Author: Aurelien FOUCRET ([email protected])

Public Methods

Method	Description
getMappingProperty ( string $analyzer = self::ANALYZER_UNTOUCHED ) : string \| null	Return ES property name eventually using a specified analyzer.
getMappingPropertyConfig ( ) : array	Return ES mapping properties associated with the field.
getName ( ) : string	Field name.
getNestedFieldName ( ) : string \| null	Get nested field name (Example: "position" for "category.position").
getNestedPath ( ) : string	Returns nested path for the field (Example : "category" for "category.position").
getSearchWeight ( ) : integer	Weight of the fields in search.
getType ( ) : string	Field type (eg: string, integer, date).
isFilterable ( ) : boolean	Is the field filterable in navigation.
isNested ( ) : boolean	Return true if the field has a nested path.
isSearchable ( ) : boolean	Is the field searchable.
isUsedForSortBy ( )	Is the attribute used in sorting.
isUsedInAutocomplete ( ) : boolean	Is the field used for autocomplete.
isUsedInSpellcheck ( ) : boolean	Is the field used by the spellchecker.

Return ES property name eventually using a specified analyzer.

public getMappingProperty ( string $analyzer = self::ANALYZER_UNTOUCHED ) : string \| null
$analyzer	string	Analyzer for multi_type / string fields.
return	string \| null

Return ES mapping properties associated with the field.

public getMappingPropertyConfig ( ) : array
return	array

Field name.

public getName ( ) : string
return	string

Returns null for non nested fields.

public getNestedFieldName ( ) : string \| null
return	string \| null

Returns nested path for the field (Example : "category" for "category.position").

public getNestedPath ( ) : string
return	string

Weight of the fields in search.

public getSearchWeight ( ) : integer
return	integer

See const above for available types.

public getType ( ) : string
return	string

Is the field filterable in navigation.

public isFilterable ( ) : boolean
return	boolean

Return true if the field has a nested path.

public isNested ( ) : boolean
return	boolean

Is the field searchable.

public isSearchable ( ) : boolean
return	boolean

Is the attribute used in sorting.

public isUsedForSortBy ( )

Is the field used for autocomplete.

public isUsedInAutocomplete ( ) : boolean
return	boolean

Is the field used by the spellchecker.

public isUsedInSpellcheck ( ) : boolean
return	boolean