PHP Interface Smile\ElasticsuiteCore\Api\Index\TypeInterface

Author: Aurelien FOUCRET ([email protected])

Show file Open project: smile-sa/elasticsuite Interface Usage Examples

Public Methods

Method	Description
getDatasource ( string $name ) : Smile\ElasticsuiteCore\Api\Index\DatasourceInterface	Retrieve a datasource by name for the current type.
getDatasources ( ) : Smile\ElasticsuiteCore\Api\Index\DatasourceInterface[]	List of datasources used by this type.
getIdField ( ) : Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface	Field use as unique id for the doc.
getMapping ( ) : Smile\ElasticsuiteCore\Api\Index\MappingInterface	Mapping describing all the field of the current type.
getName ( ) : string	Type name.

Method Details

getDatasource() public method

Retrieve a datasource by name for the current type.

public getDatasource ( string $name ) : Smile\ElasticsuiteCore\Api\Index\DatasourceInterface
$name	string	Datasource name.
return	Smile\ElasticsuiteCore\Api\Index\DatasourceInterface

getDatasources() public method

List of datasources used by this type.

public getDatasources ( ) : Smile\ElasticsuiteCore\Api\Index\DatasourceInterface[]
return	Smile\ElasticsuiteCore\Api\Index\DatasourceInterface[]

getIdField() public method

Field use as unique id for the doc.

public getIdField ( ) : Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface
return	Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface

getMapping() public method

Mapping describing all the field of the current type.

public getMapping ( ) : Smile\ElasticsuiteCore\Api\Index\MappingInterface
return	Smile\ElasticsuiteCore\Api\Index\MappingInterface

getName() public method

Type name.

public getName ( ) : string
return	string