PHP Интерфейс Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface

Автор: Aurelien FOUCRET ([email protected])
Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
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.

Описание методов

getMappingProperty() публичный Метод

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.
Результат string | null

getMappingPropertyConfig() публичный Метод

Return ES mapping properties associated with the field.
public getMappingPropertyConfig ( ) : array
Результат array

getName() публичный Метод

Field name.
public getName ( ) : string
Результат string

getNestedFieldName() публичный Метод

Returns null for non nested fields.
public getNestedFieldName ( ) : string | null
Результат string | null

getNestedPath() публичный Метод

Returns nested path for the field (Example : "category" for "category.position").
public getNestedPath ( ) : string
Результат string

getSearchWeight() публичный Метод

Weight of the fields in search.
public getSearchWeight ( ) : integer
Результат integer

getType() публичный Метод

See const above for available types.
public getType ( ) : string
Результат string

isFilterable() публичный Метод

Is the field filterable in navigation.
public isFilterable ( ) : boolean
Результат boolean

isNested() публичный Метод

Return true if the field has a nested path.
public isNested ( ) : boolean
Результат boolean

isSearchable() публичный Метод

Is the field searchable.
public isSearchable ( ) : boolean
Результат boolean

isUsedForSortBy() публичный Метод

Is the attribute used in sorting.
public isUsedForSortBy ( )

isUsedInAutocomplete() публичный Метод

Is the field used for autocomplete.
public isUsedInAutocomplete ( ) : boolean
Результат boolean

isUsedInSpellcheck() публичный Метод

Is the field used by the spellchecker.
public isUsedInSpellcheck ( ) : boolean
Результат boolean