PHP Interface Smile\ElasticsuiteCore\Api\Index\IndexInterface

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

Méthodes publiques

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

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

getIdentifier() public méthode

Index identifier (eg: catalog_product).
public getIdentifier ( ) : string
Résultat string

getName() public méthode

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

getType() public méthode

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

getTypes() public méthode

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

needInstall() public méthode

Indicates if the index needs to be installed.
public needInstall ( ) : boolean
Résultat boolean