PHP Interface Smile\ElasticsuiteCore\Api\Index\IndexSettingsInterface

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

Public Methods

Method Description
createIndexNameFromIdentifier ( string $indexIdentifier, integer | string | Magento\Store\Api\Data\StoreInterface $store ) : string Create a new index for an identifier (eg. catalog_product) by store including current date.
getAnalysisSettings ( integer | string | Magento\Store\Api\Data\StoreInterface $store ) : array Load analysis settings by store.
getBatchIndexingSize ( ) : integer Get indexing batch size configured.
getCreateIndexSettings ( ) : array Returns settings used during index creation.
getIndexAliasFromIdentifier ( string $indexIdentifier, integer | string | Magento\Store\Api\Data\StoreInterface $store ) : string Returns the index alias for an identifier (eg. catalog_product) by store.
getIndexConfig ( string $indexIdentifier ) : array Return config of an index.
getIndicesConfig ( ) : array Returns the list of the available indices declared in elasticsuite_indices.xml.
getInstallIndexSettings ( ) : array Returns settings used when installing an index.

Method Details

createIndexNameFromIdentifier() public method

Create a new index for an identifier (eg. catalog_product) by store including current date.
public createIndexNameFromIdentifier ( string $indexIdentifier, integer | string | Magento\Store\Api\Data\StoreInterface $store ) : string
$indexIdentifier string Index identifier.
$store integer | string | Magento\Store\Api\Data\StoreInterface Store.
return string

getAnalysisSettings() public method

Load analysis settings by store.
public getAnalysisSettings ( integer | string | Magento\Store\Api\Data\StoreInterface $store ) : array
$store integer | string | Magento\Store\Api\Data\StoreInterface Store.
return array

getBatchIndexingSize() public method

Get indexing batch size configured.
public getBatchIndexingSize ( ) : integer
return integer

getCreateIndexSettings() public method

Returns settings used during index creation.
public getCreateIndexSettings ( ) : array
return array

getIndexAliasFromIdentifier() public method

Returns the index alias for an identifier (eg. catalog_product) by store.
public getIndexAliasFromIdentifier ( string $indexIdentifier, integer | string | Magento\Store\Api\Data\StoreInterface $store ) : string
$indexIdentifier string Index identifier.
$store integer | string | Magento\Store\Api\Data\StoreInterface Store.
return string

getIndexConfig() public method

Return config of an index.
public getIndexConfig ( string $indexIdentifier ) : array
$indexIdentifier string Index indentifier.
return array

getIndicesConfig() public method

Returns the list of the available indices declared in elasticsuite_indices.xml.
public getIndicesConfig ( ) : array
return array

getInstallIndexSettings() public method

Returns settings used when installing an index.
public getInstallIndexSettings ( ) : array
return array