AbstractFacets
in package
implements
RecommendInterface
SideFacets Recommendations Module
This class provides recommendations displaying facets beside search results
Tags
Interfaces, Classes, Traits and Enums
- RecommendInterface
- Search Recommendations Interface
Table of Contents
- $configLoader : PluginManager
- Configuration loader
- $excludableFacets : array<string|int, mixed>
- Facets with "exclude" links enabled
- $orFacets : array<string|int, mixed>
- Facets that are "ORed" instead of "ANDed."
- $results : Results
- Search results
- __construct() : mixed
- Constructor
- excludeAllowed() : bool
- Is the specified field allowed to be excluded?
- getFacetOperator() : string
- Get the facet boolean operator
- getResults() : Results
- Get results stored in the object.
- process() : void
- Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.
- loadBooleanConfigs() : void
- Read boolean (OR/NOT) settings from the provided configuration
Properties
$configLoader
Configuration loader
protected
PluginManager
$configLoader
$excludableFacets
Facets with "exclude" links enabled
protected
array<string|int, mixed>
$excludableFacets
= []
$orFacets
Facets that are "ORed" instead of "ANDed."
protected
array<string|int, mixed>
$orFacets
= []
$results
Search results
protected
Results
$results
Methods
__construct()
Constructor
public
__construct(PluginManager $configLoader) : mixed
Parameters
- $configLoader : PluginManager
-
Configuration loader
Return values
mixed —excludeAllowed()
Is the specified field allowed to be excluded?
public
excludeAllowed(string $field) : bool
Parameters
- $field : string
-
Field name
Return values
bool —getFacetOperator()
Get the facet boolean operator
public
getFacetOperator(string $field) : string
Parameters
- $field : string
-
Field name
Return values
string —'AND' or 'OR'
getResults()
Get results stored in the object.
public
getResults() : Results
Return values
Results —process()
Called after the Search Results object has performed its main search. This may be used to extract necessary information from the Search Results object or to perform completely unrelated processing.
public
process(Results $results) : void
Parameters
- $results : Results
-
Search results object
Return values
void —loadBooleanConfigs()
Read boolean (OR/NOT) settings from the provided configuration
protected
loadBooleanConfigs(Config $config, array<string|int, mixed> $allFacets[, string $section = 'Results_Settings' ]) : void
Parameters
- $config : Config
-
Configuration to read
- $allFacets : array<string|int, mixed>
-
All facets (to use when config = *)
- $section : string = 'Results_Settings'
-
Configuration section containing settings