FacetLimitTrait
Trait to add facet limiting settings to a Params object.
Tags
Table of Contents
- $facetLimit : int
- Default facet result limit
- $facetLimitByField : array<string|int, mixed>
- Per-field facet result limit
- $hierarchicalFacetLimit : int
- Hierarchical facet limit when facets are requested.
- getHierarchicalFacetLimit() : int
- Get current limit for hierarchical facets
- setFacetLimit() : void
- Set Facet Limit
- setFacetLimitByField() : void
- Set Facet Limit by Field
- setHierarchicalFacetLimit() : void
- Set limit for hierarchical facets
- getFacetLimitForField() : int
- Get the facet limit for the specified field.
- initFacetLimitsFromConfig() : void
- Initialize facet limit from a Config object.
Properties
$facetLimit
Default facet result limit
protected
int
$facetLimit
= 30
$facetLimitByField
Per-field facet result limit
protected
array<string|int, mixed>
$facetLimitByField
= []
$hierarchicalFacetLimit
Hierarchical facet limit when facets are requested.
protected
int
$hierarchicalFacetLimit
= -1
-1 = unlimited
Methods
getHierarchicalFacetLimit()
Get current limit for hierarchical facets
public
getHierarchicalFacetLimit() : int
Return values
int —setFacetLimit()
Set Facet Limit
public
setFacetLimit(int $l) : void
Parameters
- $l : int
-
the new limit value
Return values
void —setFacetLimitByField()
Set Facet Limit by Field
public
setFacetLimitByField(array<string|int, mixed> $new) : void
Parameters
- $new : array<string|int, mixed>
-
Associative array of $field name => $limit
Return values
void —setHierarchicalFacetLimit()
Set limit for hierarchical facets
public
setHierarchicalFacetLimit(int $limit) : void
Parameters
- $limit : int
-
New limit
Return values
void —getFacetLimitForField()
Get the facet limit for the specified field.
protected
getFacetLimitForField(string $field) : int
Parameters
- $field : string
-
Field to look up
Return values
int —initFacetLimitsFromConfig()
Initialize facet limit from a Config object.
protected
initFacetLimitsFromConfig([Config $config = null ]) : void
Parameters
- $config : Config = null
-
Configuration