Copied!

CheckboxTermAggregation

CheckboxTermAggregation.php : 11
Final
Extends AbstractFieldTermAggregation

Constants

publicDEFAULT_LIMIT

AbstractTermAggregation.php : 15 
public mixed DEFAULT_LIMIT = 10

publicDEFAULT_MIN_COUNT

AbstractTermAggregation.php : 16 
public mixed DEFAULT_MIN_COUNT = 1

Properties

public $contentTypeIdentifier

FieldAggregationTrait.php : 13 
public string $contentTypeIdentifier

public $fieldDefinitionIdentifier

FieldAggregationTrait.php : 15 
public string $fieldDefinitionIdentifier

protected $limit

AbstractTermAggregation.php : 26

Number of facets (terms) returned.

 
protected int $limit = self::DEFAULT_LIMIT

protected $minCount

AbstractTermAggregation.php : 31

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 : 21

The name of the aggregation.

 
protected string $name

Methods

public__construct()

AbstractFieldTermAggregation.php : 18 
public __construct(string $name, string $contentTypeIdentifier, string $fieldDefinitionIdentifier)

Parameters

Name Type Default value Description
$name string - -
$contentTypeIdentifier string - -
$fieldDefinitionIdentifier string - -

publicgetContentTypeIdentifier()

FieldAggregationTrait.php : 17 
public getContentTypeIdentifier() : string

Return values

string

publicgetFieldDefinitionIdentifier()

FieldAggregationTrait.php : 22 
public getFieldDefinitionIdentifier() : string

Return values

string

publicgetLimit()

AbstractTermAggregation.php : 43 
public getLimit() : int

Return values

int

publicgetMinCount()

AbstractTermAggregation.php : 55 
public getMinCount() : int

Return values

int

publicgetName()

AbstractTermAggregation.php : 38 
public getName() : string

Return values

string

publicsetLimit()

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

Parameters

Name Type Default value Description
$limit int - -

Return values

self

publicsetMinCount()

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

Parameters

Name Type Default value Description
$minCount int - -

Return values

self