interface SearchFacetResult (View source)

Interface representing facet results.

Only one method might return non-null value among terms(), numericRanges() and dateRanges().

Methods

string
field()

The field the SearchFacet was targeting.

int
total()

The total number of valued facet results. Total = other() + terms (but doesn't include * missing()).

int
missing()

The number of results that couldn't be faceted, missing the adequate value. Not matter how many more buckets are added to the original facet, these result won't ever be included in one.

int
other()

The number of results that could have been faceted (because they have a value for the facet's field) but weren't, due to not having a bucket in which they belong. Adding a bucket can result in these results being faceted.

array|null
terms()

No description

array|null
numericRanges()

No description

array|null
dateRanges()

No description

Details

string field()

The field the SearchFacet was targeting.

Return Value

string

int total()

The total number of valued facet results. Total = other() + terms (but doesn't include * missing()).

Return Value

int

int missing()

The number of results that couldn't be faceted, missing the adequate value. Not matter how many more buckets are added to the original facet, these result won't ever be included in one.

Return Value

int

int other()

The number of results that could have been faceted (because they have a value for the facet's field) but weren't, due to not having a bucket in which they belong. Adding a bucket can result in these results being faceted.

Return Value

int

array|null terms()

No description

Return Value

array|null

of pairs string name to TermFacetResult

array|null numericRanges()

No description

Return Value

array|null

of pairs string name to NumericRangeFacetResult

array|null dateRanges()

No description

Return Value

array|null

of pairs string name to DateRangeFacetResult