LibGuidesAZResults
extends AbstractSearchObject
in package
LibGuidesAZResults Recommendations Module
This class provides recommendations by doing a search of LibGuides AZ Databases.
Tags
Table of Contents
- $configManager : PluginManager
- Config PluginManager
- $filterIniSection : string
- Config section with filters for this search
- $heading : string
- Heading for this recommendation module
- $limit : int
- Number of results to show
- $requestParam : string
- Name of request parameter to use for search query
- $results : Results
- Results object
- $runner : SearchRunner
- Search runner
- $sort : string|null
- Sort order for results (null = default)
- __construct() : mixed
- Constructor
- getHeading() : string
- Get the heading.
- getResults() : Results
- Get search results.
- 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.
- getDefaultHeading() : string
- Get the default heading for this recommendation module.
- getSearchClassId() : string
- Get the search class ID to use for building search objects.
Properties
$configManager
Config PluginManager
protected
PluginManager
$configManager
$filterIniSection
Config section with filters for this search
protected
string
$filterIniSection
$heading
Heading for this recommendation module
protected
string
$heading
$limit
Number of results to show
protected
int
$limit
$requestParam
Name of request parameter to use for search query
protected
string
$requestParam
$results
Results object
protected
Results
$results
$runner
Search runner
protected
SearchRunner
$runner
$sort
Sort order for results (null = default)
protected
string|null
$sort
Methods
__construct()
Constructor
public
__construct(SearchRunner $runner, PluginManager $configManager) : mixed
Parameters
- $runner : SearchRunner
-
Search runner
- $configManager : PluginManager
-
Config manager
Return values
mixed —getHeading()
Get the heading.
public
getHeading() : string
Return values
string —getResults()
Get search results.
public
getResults() : 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
Parameters
- $settings : string
-
Settings from searches.ini.
Return values
void —getDefaultHeading()
Get the default heading for this recommendation module.
protected
getDefaultHeading() : string
Return values
string —getSearchClassId()
Get the search class ID to use for building search objects.
protected
getSearchClassId() : string