SearchFacetResult
in package
Class representing facet results.
Only one method might return non-null value among terms(), numericRanges() and dateRanges().
Table of Contents
- $dateRanges : array<string|int, mixed>|null
- $field : string
- $missing : int
- $numericRanges : array<string|int, mixed>|null
- $other : int
- $terms : array<string|int, mixed>|null
- $total : int
- dateRanges() : array<string|int, mixed>
- field() : string
- The field the SearchFacet was targeting.
- missing() : int
- 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.
- numericRanges() : array<string|int, mixed>
- other() : int
- 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.
- terms() : array<string|int, mixed>
- total() : int
- The total number of *valued* facet results. Total = other() + terms (but doesn't include * missing()).
Properties
$dateRanges
private
array<string|int, mixed>|null
$dateRanges
= null
$field
private
string
$field
$missing
private
int
$missing
$numericRanges
private
array<string|int, mixed>|null
$numericRanges
= null
$other
private
int
$other
$terms
private
array<string|int, mixed>|null
$terms
= null
$total
private
int
$total
Methods
dateRanges()
public
dateRanges() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of pairs string name to DateRangeFacetResult
field()
The field the SearchFacet was targeting.
public
field() : string
Tags
Return values
string —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.
public
missing() : int
Tags
Return values
int —numericRanges()
public
numericRanges() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of pairs string name to NumericRangeFacetResult
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.
public
other() : int
Tags
Return values
int —terms()
public
terms() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of pairs string name to TermFacetResult
total()
The total number of *valued* facet results. Total = other() + terms (but doesn't include * missing()).
public
total() : int