AbstractSummonRecommend
in package
implements
RecommendInterface
Abstract base class for pulling Summon-specific recommendations.
Tags
Interfaces, Classes, Traits and Enums
- RecommendInterface
- Search Recommendations Interface
Table of Contents
- $lookfor : string
- User query
- $requestParam : string
- Request parameter to pull query from
- $results : Results
- Database details
- $resultsManager : PluginManager
- Results plugin manager
- __construct() : mixed
- Constructor
- getResults() : array<string|int, mixed>
- Get specific results needed by template.
- init() : void
- Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).
- 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.
- setConfig() : void
- Store the configuration of the recommendation module.
- configureSummonResults() : void
- If we have to create a new Summon results object, this method is used to configure it with appropriate settings.
Properties
$lookfor
User query
protected
string
$lookfor
$requestParam
Request parameter to pull query from
protected
string
$requestParam
= 'lookfor'
$results
Database details
protected
Results
$results
$resultsManager
Results plugin manager
protected
PluginManager
$resultsManager
Methods
__construct()
Constructor
public
__construct(PluginManager $results) : mixed
Parameters
- $results : PluginManager
-
Results plugin manager
Return values
mixed —getResults()
Get specific results needed by template.
public
abstract getResults() : array<string|int, mixed>
Return values
array<string|int, mixed> —init()
Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).
public
init(Params $params, Parameters $request) : void
This method is responsible for setting search parameters needed by the recommendation module and for reading any existing search parameters that may be needed.
Parameters
- $params : Params
-
Search parameter object
- $request : Parameters
-
Parameter object representing user request.
Return values
void —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 —setConfig()
Store the configuration of the recommendation module.
public
setConfig(string $settings) : void
Parameters
- $settings : string
-
Settings from searches.ini.
Return values
void —configureSummonResults()
If we have to create a new Summon results object, this method is used to configure it with appropriate settings.
protected
configureSummonResults(Results $results) : void
Parameters
- $results : Results
-
Search results object