PHP Interface Smile\ElasticsuiteCore\Api\Index\MappingInterface

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

Méthodes publiques

Méthode Description
asArray ( ) : array Return the mapping as an array you can put into ES through the mapping API.
getField ( string $name ) : Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface Return a field of the mapping by name.
getFields ( ) : Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface[] List of the fields used to build the mapping.
getIdField ( ) : Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface Field use as unique id for the doc.
getProperties ( ) : array List of the properties of the mapping.

Method Details

asArray() public méthode

Return the mapping as an array you can put into ES through the mapping API.
public asArray ( ) : array
Résultat array

getField() public méthode

Return a field of the mapping by name.
public getField ( string $name ) : Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface
$name string Field name
Résultat Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface

getFields() public méthode

List of the fields used to build the mapping.
public getFields ( ) : Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface[]
Résultat Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface[]

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

getProperties() public méthode

List of the properties of the mapping.
public getProperties ( ) : array
Résultat array