PHP Interface Smile\ElasticsuiteCore\Api\Index\TypeInterface

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

Méthodes publiques

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

Retrieve a datasource by name for the current type.
public getDatasource ( string $name ) : Smile\ElasticsuiteCore\Api\Index\DatasourceInterface
$name string Datasource name.
Résultat Smile\ElasticsuiteCore\Api\Index\DatasourceInterface

getDatasources() public méthode

List of datasources used by this type.
public getDatasources ( ) : Smile\ElasticsuiteCore\Api\Index\DatasourceInterface[]
Résultat Smile\ElasticsuiteCore\Api\Index\DatasourceInterface[]

getIdField() public méthode

Field use as unique id for the doc.
public getIdField ( ) : Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface
Résultat Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface

getMapping() public méthode

Mapping describing all the field of the current type.
public getMapping ( ) : Smile\ElasticsuiteCore\Api\Index\MappingInterface
Résultat Smile\ElasticsuiteCore\Api\Index\MappingInterface

getName() public méthode

Type name.
public getName ( ) : string
Résultat string