VuFind API Documentation

FacetCloud extends ExpandFacets
in package

FacetCloud Recommendations Module

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

author

Lutz Biedinger lutz.biedinger@gmail.com

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Main Page

Table of Contents

$configLoader  : PluginManager
Configuration loader
$emptyResults  : Results
Empty result set (used by the template as the basis for URL generation)
$facets  : array<string|int, mixed>
Facets to display
$searchObject  : Results
Search results
$settings  : string
Settings from configuration
__construct()  : mixed
Constructor
getEmptyResults()  : Results
Get an empty search object (the template uses this as the basis for URL generation).
getExpandedSet()  : array<string|int, mixed>
Get the facet data
getFacetLimit()  : int
Get the facet limit.
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

$emptyResults

Empty result set (used by the template as the basis for URL generation)

protected Results $emptyResults

$facets

Facets to display

protected array<string|int, mixed> $facets

$settings

Settings from configuration

protected string $settings

Methods

__construct()

Constructor

public __construct(PluginManager $configLoader, Results $emptyResults) : mixed
Parameters
$configLoader : PluginManager

Configuration loader

$emptyResults : Results

Empty result set (used by the template as the basis for URL generation)

Return values
mixed —

getEmptyResults()

Get an empty search object (the template uses this as the basis for URL generation).

public getEmptyResults() : Results
Return values
Results —

getExpandedSet()

Get the facet data

public getExpandedSet() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getFacetLimit()

Get the facet limit.

public getFacetLimit() : int
Return values
int —

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 —

Search results