Build a field term facet.
since eZ Platform 3.2.0, to be removed in Ibexa 4.0.0.
If provided the search service returns a FieldFacet for the provided field path. A field path starts with a field identifier and may contain a subpath in the case of complex field types (e.g. author/name)
Tags
Constants¶
COUNT_ASC ¶
|
|
|
COUNT_DESC ¶
|
|
|
TERM_ASC ¶
|
|
|
TERM_DESC ¶
|
|
|
Properties¶
$fieldPaths
¶
The field paths starts with a field identifier and a sub path (for complex types).
|
|
|
$filter
¶
An additional facet filter that will further filter the documents the facet will be executed on.
|
|
|
$global
¶
If true the facet runs in a global mode not restricted by the query.
|
|
|
$limit
¶
Number of facets (terms) returned.
|
|
|
$minCount
¶
Specifies the minimum count. Only facet groups with more or equal results are returned.
|
|
|
$name
¶
The name of the facet.
|
|
|
$regex
¶
A regex filter for field values.
|
|
|
Tags
$sort
¶
The sort order of the terms.
|
|
|
One of FieldFacetBuilder::COUNT_ASC, FieldFacetBuilder::COUNT_DESC, FieldFacetBuilder::TERM_ASC, FieldFacetBuilder::TERM_DESC
Note: A given Search engine might not support all options.
Methods¶
__construct()
¶
Construct object optionally with a set of properties.
|
|
|
Readonly properties values must be set using $properties as they are not writable anymore after object has been created.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $properties | array<string|int, mixed> | [] | - |
getProperties()
¶
Function where list of properties are returned.
|
|
|
Used by attributes(), override to add dynamic properties
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $dynamicProperties | array<string|int, mixed> | [] |
Additional dynamic properties exposed on the object |
Return values
array<string|int, mixed>