FacetList
in package
implements
ContentBlockInterface
FacetList content block.
Tags
Interfaces, Classes, Traits and Enums
- ContentBlockInterface
- Content block interface
Table of Contents
- $columnSize : int
- Number of values to put in each column of results.
- $configManager : PluginManager
- Configuration manager
- $facetCacheManager : PluginManager
- Facet cache plugin manager
- $searchClassId : string
- Search class ID to use for retrieving facets.
- __construct() : mixed
- Constructor
- getContext() : array<string|int, mixed>
- Return context variables used for rendering the block's template.
- setConfig() : void
- Store the configuration of the content block.
- getHierarchicalFacets() : array<string|int, mixed>
- Get an array of hierarchical facets
- getHierarchicalFacetSortSettings() : array<string|int, mixed>
- Get hierarchical facet sort settings
Properties
$columnSize
Number of values to put in each column of results.
protected
int
$columnSize
= 10
$configManager
Configuration manager
protected
PluginManager
$configManager
$facetCacheManager
Facet cache plugin manager
protected
PluginManager
$facetCacheManager
$searchClassId
Search class ID to use for retrieving facets.
protected
string
$searchClassId
= 'Solr'
Methods
__construct()
Constructor
public
__construct(PluginManager $fcm, PluginManager $cm) : mixed
Parameters
- $fcm : PluginManager
-
Facet cache plugin manager
- $cm : PluginManager
-
Configuration manager
Return values
mixed —getContext()
Return context variables used for rendering the block's template.
public
getContext() : array<string|int, mixed>
Return values
array<string|int, mixed> —setConfig()
Store the configuration of the content block.
public
setConfig(string $settings) : void
Parameters
- $settings : string
-
Settings from searches.ini.
Return values
void —getHierarchicalFacets()
Get an array of hierarchical facets
protected
getHierarchicalFacets(Config $facetConfig) : array<string|int, mixed>
Parameters
- $facetConfig : Config
-
Facet configuration object.
Return values
array<string|int, mixed> —Facets
getHierarchicalFacetSortSettings()
Get hierarchical facet sort settings
protected
getHierarchicalFacetSortSettings(Config $facetConfig) : array<string|int, mixed>
Parameters
- $facetConfig : Config
-
Facet configuration object.
Return values
array<string|int, mixed> —Array of sort settings keyed by facet