PHP Class Smile\ElasticsuiteCore\Search\Request\SortOrder\Nested

Author: Aurelien FOUCRET ([email protected])
Inheritance: extends Standard
Show file Open project: smile-sa/elasticsuite

Public Methods

Method Description
__construct ( string $field, string $direction, string $nestedPath, Smile\ElasticsuiteCore\Search\Request\QueryInterface $nestedFilter = null, string $scoreMode = self::SCORE_MODE_MIN, string $name = null ) Constructor.
getNestedFilter ( ) : Smile\ElasticsuiteCore\Search\Request\QueryInterface The filter applied to the nested sort.
getNestedPath ( ) : string Nested sort path.
getScoreMode ( ) : string Method used to aggregate the sort if there is many match for the filter.
getType ( ) {@inheritDoc}

Method Details

__construct() public method

Constructor.
public __construct ( string $field, string $direction, string $nestedPath, Smile\ElasticsuiteCore\Search\Request\QueryInterface $nestedFilter = null, string $scoreMode = self::SCORE_MODE_MIN, string $name = null )
$field string Sort order field.
$direction string Sort order direction.
$nestedPath string Nested sort path.
$nestedFilter Smile\ElasticsuiteCore\Search\Request\QueryInterface The filter applied to the nested sort.
$scoreMode string Method used to aggregate the sort if there is many match for the filter.
$name string Sort order name.

getNestedFilter() public method

The filter applied to the nested sort.
public getNestedFilter ( ) : Smile\ElasticsuiteCore\Search\Request\QueryInterface
return Smile\ElasticsuiteCore\Search\Request\QueryInterface

getNestedPath() public method

Nested sort path.
public getNestedPath ( ) : string
return string

getScoreMode() public method

Method used to aggregate the sort if there is many match for the filter.
public getScoreMode ( ) : string
return string

getType() public method

{@inheritDoc}
public getType ( )