DOI
in package
implements
RecommendInterface
DOI Recommendations Module
This class directs the user to a DOI resolver when appropriate.
Tags
Interfaces, Classes, Traits and Enums
- RecommendInterface
- Search Recommendations Interface
Table of Contents
- $exact : bool
- Does the DOI in $match exactly match the user's query?
- $match : string
- DOI found in search query (or null for none)
- $prefix : string
- URL prefix for resolving DOIs
- $redirectFullMatch : bool
- Are we configured to redirect to the resolver when a full match is found?
- getDOI() : string
- Get the matched DOI (or null if no match found)
- getURL() : string
- Get the URL to resolve the matched DOI (or null if no match found)
- init() : void
- Called before the Search Results object performs its main search (specifically, in response to \VuFind\Search\SearchRunner::EVENT_CONFIGURED).
- isFullMatch() : bool
- Is the DOI returned by getDOI a match to the user's full search query?
- 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.
- redirectFullMatch() : bool
- Are we configured to redirect to the resolver when a full match is found?
- setConfig() : void
- Store the configuration of the recommendation module.
Properties
$exact
Does the DOI in $match exactly match the user's query?
protected
bool
$exact
= false
$match
DOI found in search query (or null for none)
protected
string
$match
= null
$prefix
URL prefix for resolving DOIs
protected
string
$prefix
$redirectFullMatch
Are we configured to redirect to the resolver when a full match is found?
protected
bool
$redirectFullMatch
= true
Methods
getDOI()
Get the matched DOI (or null if no match found)
public
getDOI() : string
Return values
string —getURL()
Get the URL to resolve the matched DOI (or null if no match found)
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 —isFullMatch()
Is the DOI returned by getDOI a match to the user's full search query?
public
isFullMatch() : bool
Return values
bool —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 —redirectFullMatch()
Are we configured to redirect to the resolver when a full match is found?
public
redirectFullMatch() : bool
Return values
bool —setConfig()
Store the configuration of the recommendation module.
public
setConfig(string $settings) : void
Parameters
- $settings : string
-
Settings from searches.ini.