VuFind API Documentation

PubDateVisAjax
in package
implements RecommendInterface

PubDateVisAjax Recommendations Module

This class displays a visualisation of facet values in a recommendation module

Tags
category

VuFind

author

Till Kinstler kinstler@gbv.de

license

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

link

Wiki

Interfaces, Classes, Traits and Enums

RecommendInterface
Search Recommendations Interface

Table of Contents

$dateFacets  : array<string|int, mixed>
Facet fields to use
$searchObject  : Results
Search results object
$settings  : string
Raw settings string
$zooming  : string
Should we allow zooming? (String of "true" or "false")
getFacetFields()  : array<string|int, mixed>
Get facet fields
getSearchParams()  : string
Get search parameters
getVisFacets()  : array<string|int, mixed>
Get visual facet details.
getZooming()  : array<string|int, mixed>
Get zoom setting
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.
processDateFacets()  : array<string|int, mixed>
Support method for getVisData() -- extract details from applied filters.

Properties

$dateFacets

Facet fields to use

protected array<string|int, mixed> $dateFacets = []

$zooming

Should we allow zooming? (String of "true" or "false")

protected string $zooming

Methods

getFacetFields()

Get facet fields

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

getSearchParams()

Get search parameters

public getSearchParams() : string
Return values
string —

of params

getVisFacets()

Get visual facet details.

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

getZooming()

Get zoom setting

public getZooming() : array<string|int, mixed>
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 —

processDateFacets()

Support method for getVisData() -- extract details from applied filters.

protected processDateFacets(array<string|int, mixed> $filters) : array<string|int, mixed>
Parameters
$filters : array<string|int, mixed>

Current filter list

Return values
array<string|int, mixed> —

Search results