FacetRestrictionsTrait
Trait to add facet limiting settings to a Params object.
Tags
Table of Contents
- $facetMatchesByField : array<string|int, mixed>
- Per-field facet matches
- $facetPrefixByField : array<string|int, mixed>
- Per-field facet prefix
- setFacetMatchesByField() : void
- Set Facet Matches by Field
- setFacetPrefixByField() : void
- Set Facet Prefix by Field
- getFacetMatchesForField() : string
- Get the facet matches for the specified field.
- getFacetPrefixForField() : string
- Get the facet prefix for the specified field.
- initFacetRestrictionsFromConfig() : void
- Initialize facet prefix and matches from a Config object.
Properties
$facetMatchesByField
Per-field facet matches
protected
array<string|int, mixed>
$facetMatchesByField
= []
$facetPrefixByField
Per-field facet prefix
protected
array<string|int, mixed>
$facetPrefixByField
= []
Methods
setFacetMatchesByField()
Set Facet Matches by Field
public
setFacetMatchesByField(array<string|int, mixed> $new) : void
Parameters
- $new : array<string|int, mixed>
-
Associative array of $field name => $limit
Return values
void —setFacetPrefixByField()
Set Facet Prefix by Field
public
setFacetPrefixByField(array<string|int, mixed> $new) : void
Parameters
- $new : array<string|int, mixed>
-
Associative array of $field name => $limit
Return values
void —getFacetMatchesForField()
Get the facet matches for the specified field.
protected
getFacetMatchesForField(string $field) : string
Parameters
- $field : string
-
Field to look up
Return values
string —getFacetPrefixForField()
Get the facet prefix for the specified field.
protected
getFacetPrefixForField(string $field) : string
Parameters
- $field : string
-
Field to look up
Return values
string —initFacetRestrictionsFromConfig()
Initialize facet prefix and matches from a Config object.
protected
initFacetRestrictionsFromConfig([Config $config = null ]) : void
Parameters
- $config : Config = null
-
Configuration