PHP Class Smile\ElasticsuiteCore\Index\Mapping

Author: Aurelien FOUCRET ([email protected])
Inheritance: implements Smile\ElasticsuiteCore\Api\Index\MappingInterface
Show file Open project: smile-sa/elasticsuite

Public Methods

Method Description
__construct ( string $idFieldName, array $staticFields = [], array $dynamicFieldProviders = [] ) Instanciate a new mapping.
asArray ( ) {@inheritDoc}
getField ( $name ) {@inheritDoc}
getFields ( ) {@inheritDoc}
getIdField ( ) {@inheritDoc}
getProperties ( ) {@inheritDoc}

Private Methods

Method Description
addField ( array $properties, Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface $field ) : array Append a field to a mapping properties list.
addProperty ( array $properties, string $propertyName, string $propertyType, array $analyzers = [] ) : array Append a new properties into a properties list and returned the updated map.
getDynamicFields ( array $dynamicFieldProviders ) : array Retrieve the fields provided by differents providers.
getFieldCopyToProperties ( Smile\ElasticsuiteCore\Api\Index\Mapping\FieldInterface $field ) : array Get the list of default fields where the current field must be copied.

Method Details

__construct() public method

Instanciate a new mapping.
public __construct ( string $idFieldName, array $staticFields = [], array $dynamicFieldProviders = [] )
$idFieldName string Field use as unique id for the documents.
$staticFields array List of static fields.
$dynamicFieldProviders array Dynamic fields providers.

asArray() public method

{@inheritDoc}
public asArray ( )

getField() public method

{@inheritDoc}
public getField ( $name )

getFields() public method

{@inheritDoc}
public getFields ( )

getIdField() public method

{@inheritDoc}
public getIdField ( )

getProperties() public method

{@inheritDoc}
public getProperties ( )