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

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

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

Метод Описание
getDefaultSearchType ( ) : Smile\ElasticsuiteCore\Api\Index\TypeInterface Each index has a default type that can be used to search.
getIdentifier ( ) : string Index identifier (eg: catalog_product).
getName ( ) : string Index name.
getType ( string $typeName ) : Smile\ElasticsuiteCore\Api\Index\TypeInterface Retrieve an type by it's name.
getTypes ( ) : Smile\ElasticsuiteCore\Api\Index\TypeInterface[] List of the types handled by the index.
needInstall ( ) : boolean Indicates if the index needs to be installed.

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

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

This method returns this default type.
public getDefaultSearchType ( ) : Smile\ElasticsuiteCore\Api\Index\TypeInterface
Результат Smile\ElasticsuiteCore\Api\Index\TypeInterface

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

Index identifier (eg: catalog_product).
public getIdentifier ( ) : string
Результат string

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

Can be : - a real index name (eg.: magento2_catalog_product_20160202_192935 - an alias (eg. : magento2_catalog_product).
public getName ( ) : string
Результат string

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

Retrieve an type by it's name.
public getType ( string $typeName ) : Smile\ElasticsuiteCore\Api\Index\TypeInterface
$typeName string Name of the retrieved type.
Результат Smile\ElasticsuiteCore\Api\Index\TypeInterface

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

List of the types handled by the index.
public getTypes ( ) : Smile\ElasticsuiteCore\Api\Index\TypeInterface[]
Результат Smile\ElasticsuiteCore\Api\Index\TypeInterface[]

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

Indicates if the index needs to be installed.
public needInstall ( ) : boolean
Результат boolean