Copied!

SubtreeTermAggregation

SubtreeTermAggregation.php : 16
Extends AbstractTermAggregation
Implements LocationAggregation

Constants

publicDEFAULT_LIMIT

AbstractTermAggregation.php : 15 
public mixed DEFAULT_LIMIT = 10

publicDEFAULT_MIN_COUNT

AbstractTermAggregation.php : 16 
public mixed DEFAULT_MIN_COUNT = 1

Properties

protected $limit

AbstractTermAggregation.php : 30

Number of facets (terms) returned.

 
protected int $limit = self::DEFAULT_LIMIT

protected $minCount

AbstractTermAggregation.php : 37

Specifies the minimum count. Only facet groups with more or equal results are returned.

 
protected int $minCount = self::DEFAULT_MIN_COUNT

protected $name

AbstractTermAggregation.php : 23

The name of the aggregation.

 
protected string $name

Methods

public__construct()

SubtreeTermAggregation.php : 21 
public __construct(string $name, string $pathString)

Parameters

Name Type Default value Description
$name string - -
$pathString string - -

publicfromLocation()

SubtreeTermAggregation.php : 45 
public static fromLocation(string $name, Location $location) : self

Parameters

Name Type Default value Description
$name string - -
$location Location - -

Return values

self

publicgetLimit()

AbstractTermAggregation.php : 49 
public getLimit() : int

Return values

int

publicgetMinCount()

AbstractTermAggregation.php : 61 
public getMinCount() : int

Return values

int

publicgetName()

AbstractTermAggregation.php : 44 
public getName() : string

Return values

string

publicgetPathString()

SubtreeTermAggregation.php : 35 
public getPathString() : string

Return values

string

publicsetLimit()

AbstractTermAggregation.php : 54 
public setLimit(int $limit) : self

Parameters

Name Type Default value Description
$limit int - -

Return values

self

publicsetMinCount()

AbstractTermAggregation.php : 66 
public setMinCount(int $minCount) : self

Parameters

Name Type Default value Description
$minCount int - -

Return values

self