Ibexa >
Contracts >
Core >
Repository >
Values >
Content >
Query >
Aggregation >
Field >
CheckboxTermAggregation

CheckboxTermAggregation

CheckboxTermAggregation.php : 11 Copy path

Extends AbstractFieldTermAggregation

Constants¶

DEFAULT_LIMIT ¶

AbstractTermAggregation.php : 15 Copy path

public mixed DEFAULT_LIMIT = 10

DEFAULT_MIN_COUNT ¶

AbstractTermAggregation.php : 16 Copy path

public mixed DEFAULT_MIN_COUNT = 1

Properties¶

$contentTypeIdentifier ¶

FieldAggregationTrait.php : 14 Copy path

public string $contentTypeIdentifier

$fieldDefinitionIdentifier ¶

FieldAggregationTrait.php : 17 Copy path

public string $fieldDefinitionIdentifier

$limit ¶

AbstractTermAggregation.php : 30 Copy path

Number of facets (terms) returned.

protected int $limit = self::DEFAULT_LIMIT

$minCount ¶

AbstractTermAggregation.php : 37 Copy path

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

protected int $minCount = self::DEFAULT_MIN_COUNT

$name ¶

AbstractTermAggregation.php : 23 Copy path

The name of the aggregation.

protected string $name

Methods¶

__construct() ¶

AbstractFieldTermAggregation.php : 18 Copy path

    
                        public __construct(string $name, string $contentTypeIdentifier, string $fieldDefinitionIdentifier)

Parameters

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

getContentTypeIdentifier() ¶

FieldAggregationTrait.php : 19 Copy path

public getContentTypeIdentifier() : string

Return values

string

getFieldDefinitionIdentifier() ¶

FieldAggregationTrait.php : 24 Copy path

public getFieldDefinitionIdentifier() : string

Return values

string

getLimit() ¶

AbstractTermAggregation.php : 49 Copy path

public getLimit() : int

Return values

int

getMinCount() ¶

AbstractTermAggregation.php : 61 Copy path

public getMinCount() : int

Return values

int

getName() ¶

AbstractTermAggregation.php : 44 Copy path

public getName() : string

Return values

string

setLimit() ¶

AbstractTermAggregation.php : 54 Copy path

public setLimit(int $limit) : self

Parameters

Name	Type	Default value	Description
$limit	int	-	-

Return values

self

setMinCount() ¶

AbstractTermAggregation.php : 66 Copy path

public setMinCount(int $minCount) : self

Parameters

Name	Type	Default value	Description
$minCount	int	-	-

Return values

self