InjectHighlightingListener
in package
Solr highlighting listener.
Tags
Table of Contents
- $active : bool
- Is highlighting active?
- $backend : BackendInterface
- Backend.
- $extraHighlightingParameters : array<string|int, mixed>
- Extra Solr highlighting parameters.
- $fieldList : string
- Fields to highlight when active.
- __construct() : void
- Constructor.
- attach() : void
- Attach listener to shared event manager.
- onSearchPre() : EventInterface
- Set up highlighting parameters.
Properties
$active
Is highlighting active?
protected
bool
$active
= false
$backend
Backend.
protected
BackendInterface
$backend
$extraHighlightingParameters
Extra Solr highlighting parameters.
protected
array<string|int, mixed>
$extraHighlightingParameters
$fieldList
Fields to highlight when active.
protected
string
$fieldList
Methods
__construct()
Constructor.
public
__construct(BackendInterface $backend[, string $fieldList = '*' ][, array<string|int, mixed> $extras = [] ]) : void
Parameters
- $backend : BackendInterface
-
Backend
- $fieldList : string = '*'
-
Field(s) to highlight (hl.fl param)
- $extras : array<string|int, mixed> = []
-
Extra Solr highlighting parameters
Return values
void —attach()
Attach listener to shared event manager.
public
attach(SharedEventManagerInterface $manager) : void
Parameters
- $manager : SharedEventManagerInterface
-
Shared event manager
Return values
void —onSearchPre()
Set up highlighting parameters.
public
onSearchPre(EventInterface $event) : EventInterface
Parameters
- $event : EventInterface
-
Event