SearchRunner
in package
VuFind Search Runner
Tags
Table of Contents
- EVENT_COMPLETE = 'complete'
- EVENT_CONFIGURED = 'configured'
- Event identifiers.
- $events : EventManager
- Event manager.
- $resultsManager : PluginManager
- Search results object manager.
- $searchId : int
- Counter of how many searches we have run (for differentiating listeners).
- __construct() : mixed
- Constructor
- getEventManager() : EventManagerInterface
- Return EventManager instance.
- run() : Results
- Run the search.
- setEventManager() : void
- Set EventManager instance.
Constants
EVENT_COMPLETE
public
mixed
EVENT_COMPLETE
= 'complete'
EVENT_CONFIGURED
Event identifiers.
public
string
EVENT_CONFIGURED
= 'configured'
Properties
$events
Event manager.
protected
EventManager
$events
= null
$resultsManager
Search results object manager.
protected
PluginManager
$resultsManager
$searchId
Counter of how many searches we have run (for differentiating listeners).
protected
int
$searchId
= 0
Methods
__construct()
Constructor
public
__construct(PluginManager $resultsManager[, EventManager $events = null ]) : mixed
Parameters
- $resultsManager : PluginManager
-
Results manager
- $events : EventManager = null
-
Event manager (optional)
Return values
mixed —getEventManager()
Return EventManager instance.
public
getEventManager() : EventManagerInterface
Lazy loads a new EventManager if none was set.
Return values
EventManagerInterface —run()
Run the search.
public
run(array<string|int, mixed>|Parameters $rawRequest[, string $searchClassId = 'Solr' ][, mixed $setupCallback = null ][, string $lastView = null ]) : Results
Parameters
- $rawRequest : array<string|int, mixed>|Parameters
-
Incoming parameters for search
- $searchClassId : string = 'Solr'
-
Type of search to perform
- $setupCallback : mixed = null
-
Optional callback for setting up params and attaching listeners; if provided, will be passed three parameters: this object, the search parameters object, and a unique identifier for the current running search.
- $lastView : string = null
-
Last valid view parameter loaded from a previous search (optional; used for view persistence).
Tags
Return values
Results —setEventManager()
Set EventManager instance.
public
setEventManager(EventManagerInterface $events) : void
Parameters
- $events : EventManagerInterface
-
Event manager