ObjectDatabaseSearchAggregation
in package
Tags
Table of Contents
- TYPE_MULTI_TERMS = 'multi_terms'
- TYPE_TERMS = 'terms'
- __construct() : mixed
- addMultiTermsAggregation() : void
- Adds a multi terms aggregation.
- addTermsAggregation() : void
- Adds a terms aggregation.
- getAggregations() : array<string|int, _ObjectDatabaseGenericAggregation>
- Returns the stored filter values from the current ObjectDatabase filter object.
- getDefinition() : array<string|int, mixed>|array<string|int, array<string|int, mixed>>
- Returns the definition of the defined search aggregations.
Constants
TYPE_MULTI_TERMS
public
mixed
TYPE_MULTI_TERMS
= 'multi_terms'
Tags
TYPE_TERMS
public
mixed
TYPE_TERMS
= 'terms'
Tags
Methods
__construct()
public
__construct() : mixed
Tags
Return values
mixed —addMultiTermsAggregation()
Adds a multi terms aggregation.
public
final addMultiTermsAggregation(ObjectDatabaseMultiTermsAggregation $oAggregation) : void
Parameters
- $oAggregation : ObjectDatabaseMultiTermsAggregation
Tags
Return values
void —addTermsAggregation()
Adds a terms aggregation.
public
final addTermsAggregation(ObjectDatabaseTermsAggregation $oAggregation) : void
Parameters
- $oAggregation : ObjectDatabaseTermsAggregation
Tags
Return values
void —getAggregations()
Returns the stored filter values from the current ObjectDatabase filter object.
public
getAggregations() : array<string|int, _ObjectDatabaseGenericAggregation>
Format: Key => Column name / Values => Mixed Values
Tags
Return values
array<string|int, _ObjectDatabaseGenericAggregation> —with the stored filter values from the current ObjectDatabase filter object.
getDefinition()
Returns the definition of the defined search aggregations.
public
final getDefinition() : array<string|int, mixed>|array<string|int, array<string|int, mixed>>