PHP Interface Smile\ElasticsuiteCore\Api\Index\IndexInterface

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

Public Methods

Method Description
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.

Method Details

getDefaultSearchType() public method

This method returns this default type.
public getDefaultSearchType ( ) : Smile\ElasticsuiteCore\Api\Index\TypeInterface
return Smile\ElasticsuiteCore\Api\Index\TypeInterface

getIdentifier() public method

Index identifier (eg: catalog_product).
public getIdentifier ( ) : string
return string

getName() public method

Can be : - a real index name (eg.: magento2_catalog_product_20160202_192935 - an alias (eg. : magento2_catalog_product).
public getName ( ) : string
return string

getType() public method

Retrieve an type by it's name.
public getType ( string $typeName ) : Smile\ElasticsuiteCore\Api\Index\TypeInterface
$typeName string Name of the retrieved type.
return Smile\ElasticsuiteCore\Api\Index\TypeInterface

getTypes() public method

List of the types handled by the index.
public getTypes ( ) : Smile\ElasticsuiteCore\Api\Index\TypeInterface[]
return Smile\ElasticsuiteCore\Api\Index\TypeInterface[]

needInstall() public method

Indicates if the index needs to be installed.
public needInstall ( ) : boolean
return boolean