AlphaBrowseLink
in package
implements
RecommendInterface
AlphaBrowseLink Recommendations Module
This class recommends a look at the alphabrowse index.
Tags
Interfaces, Classes, Traits and Enums
- RecommendInterface
- Search Recommendations Interface
Table of Contents
- $index : string
- Alphabrowse index to link to
- $query : string
- Search query submitted
- getIndex() : string
- Get the alphabrowse index to link to
- getQuery() : string
- Get the search query.
- 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
$index
Alphabrowse index to link to
protected
string
$index
$query
Search query submitted
protected
string
$query
Methods
getIndex()
Get the alphabrowse index to link to
public
getIndex() : string
Return values
string —getQuery()
Get the search query.
public
getQuery() : 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 $settings) : void
Parameters
- $settings : string
-
Settings from searches.ini.