PHP Interface Smile\ElasticsuiteCore\Api\Index\MappingInterface

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

Public Methods

Method 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 method

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

getField() public method

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

getFields() public method

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

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

getProperties() public method

List of the properties of the mapping.
public getProperties ( ) : array
return array