ExternalSearch
in package
implements
RecommendInterface
ExternalSearch Recommendation Module
Tags
Interfaces, Classes, Traits and Enums
- RecommendInterface
- Search Recommendations Interface
Table of Contents
- $linkText : string
- Link text
- $lookfor : string
- Search query
- $template : string
- URL template string
- getLinkText() : string
- Get the link text.
- getUrl() : string
- Get the link URL.
- 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.
Properties
$linkText
Link text
protected
string
$linkText
$lookfor
Search query
protected
string
$lookfor
$template
URL template string
protected
string
$template
Methods
getLinkText()
Get the link text.
public
getLinkText() : string
Return values
string —getUrl()
Get the link URL.
public
getUrl() : string
Return values
string —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 $settingsStr) : void
Parameters
- $settingsStr : string
-
Settings from searches.ini.