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

Author: Aurelien FOUCRET ([email protected])
Afficher le fichier Open project: smile-sa/elasticsuite Interface Usage Examples

Méthodes publiques

Méthode 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.

Method Details

getMappingProperty() public méthode

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.
Résultat string | null

getMappingPropertyConfig() public méthode

Return ES mapping properties associated with the field.
public getMappingPropertyConfig ( ) : array
Résultat array

getName() public méthode

Field name.
public getName ( ) : string
Résultat string

getNestedFieldName() public méthode

Returns null for non nested fields.
public getNestedFieldName ( ) : string | null
Résultat string | null

getNestedPath() public méthode

Returns nested path for the field (Example : "category" for "category.position").
public getNestedPath ( ) : string
Résultat string

getSearchWeight() public méthode

Weight of the fields in search.
public getSearchWeight ( ) : integer
Résultat integer

getType() public méthode

See const above for available types.
public getType ( ) : string
Résultat string

isFilterable() public méthode

Is the field filterable in navigation.
public isFilterable ( ) : boolean
Résultat boolean

isNested() public méthode

Return true if the field has a nested path.
public isNested ( ) : boolean
Résultat boolean

isSearchable() public méthode

Is the field searchable.
public isSearchable ( ) : boolean
Résultat boolean

isUsedForSortBy() public méthode

Is the attribute used in sorting.
public isUsedForSortBy ( )

isUsedInAutocomplete() public méthode

Is the field used for autocomplete.
public isUsedInAutocomplete ( ) : boolean
Résultat boolean

isUsedInSpellcheck() public méthode

Is the field used by the spellchecker.
public isUsedInSpellcheck ( ) : boolean
Résultat boolean