SwitchTab
in package
implements
RecommendInterface
SwitchType Recommendations Module
This class recommends switching to a different search type.
Tags
Interfaces, Classes, Traits and Enums
- RecommendInterface
- Search Recommendations Interface
Table of Contents
- $tabSelections : array<string|int, mixed>
- Current tab settings
- getActiveTab() : array<string|int, mixed>|null
- Get the active tab.
- getInactiveTabs() : array<string|int, mixed>
- Get the other (inactive) tabs.
- 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.
- setTabSelections() : void
- Set the tab state based on the current tabConfig.
Properties
$tabSelections
Current tab settings
protected
array<string|int, mixed>
$tabSelections
= null
Methods
getActiveTab()
Get the active tab.
public
getActiveTab(array<string|int, mixed> $tabEnv) : array<string|int, mixed>|null
Parameters
- $tabEnv : array<string|int, mixed>
-
tabConfig
Return values
array<string|int, mixed>|null —getInactiveTabs()
Get the other (inactive) tabs.
public
getInactiveTabs(array<string|int, mixed> $tabEnv) : array<string|int, mixed>
Parameters
- $tabEnv : array<string|int, mixed>
-
tabConfig
Return values
array<string|int, mixed> —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 —setTabSelections()
Set the tab state based on the current tabConfig.
protected
setTabSelections(array<string|int, mixed> $tabEnv) : void
Parameters
- $tabEnv : array<string|int, mixed>
-
tabConfig