AuthorFacets
in package
implements
RecommendInterface
AuthorFacets Recommendations Module
This class provides recommendations displaying authors on top of the page. Default on author searches.
Tags
Interfaces, Classes, Traits and Enums
- RecommendInterface
- Search Recommendations Interface
Table of Contents
- $results : Results
- Search results object
- $resultsManager : PluginManager
- Results plugin manager
- $settings : string
- Configuration settings
- __construct() : mixed
- Constructor
- getResults() : Results
- Get results stored in the object.
- getSearchTerm() : string
- Returns search term.
- getSimilarAuthors() : array<string|int, mixed>
- Process similar authors from an author search
- 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
$results
Search results object
protected
Results
$results
$resultsManager
Results plugin manager
protected
PluginManager
$resultsManager
$settings
Configuration settings
protected
string
$settings
Methods
__construct()
Constructor
public
__construct(PluginManager $results) : mixed
Parameters
- $results : PluginManager
-
Results plugin manager
Return values
mixed —getResults()
Get results stored in the object.
public
getResults() : Results
Return values
Results —getSearchTerm()
Returns search term.
public
getSearchTerm() : string
Return values
string —getSimilarAuthors()
Process similar authors from an author search
public
getSimilarAuthors() : array<string|int, mixed>
Return values
array<string|int, mixed> —Facets data arrays
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.