RecommendLinks
in package
implements
RecommendInterface
RecommendLinks Recommendations Module
This class recommends links to services, that user may try.
Tags
Interfaces, Classes, Traits and Enums
- RecommendInterface
- Search Recommendations Interface
Table of Contents
- $configLoader : PluginManager
- Configuration loader
- $links : array<string|int, mixed>
- Links to show
- __construct() : mixed
- Constructor
- getLinks() : Results
- Get array of links with title as key and value as link
- 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
$configLoader
Configuration loader
protected
PluginManager
$configLoader
$links
Links to show
protected
array<string|int, mixed>
$links
= []
Methods
__construct()
Constructor
public
__construct(PluginManager $configLoader) : mixed
Parameters
- $configLoader : PluginManager
-
Configuration loader
Return values
mixed —getLinks()
Get array of links with title as key and value as link
public
getLinks() : Results
Return values
Results —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
RecommendLinks:[ini section]:[ini name] Display a list of recommended links, taken from [ini section] in [ini name], where the section is a mapping of label => URL. [ini name] defaults to searches.ini, and [ini section] defaults to RecommendLinks.
Parameters
- $settings : string
-
Settings from searches.ini.