VuFind API Documentation

HideFacetValueListener
in package

Hide single facet values from displaying.

Tags
category

VuFind

author

Frank Morgner morgnerf@ub.uni-leipzig.de

license

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

link

Main Site

Table of Contents

$backend  : BackendInterface
Backend.
$hideFacets  : array<string|int, mixed>
List of facet values to hide, indexed by facet field.
$showFacets  : array<string|int, mixed>
List of facet values to show, indexed by facet field. All other facets are hidden.
__construct()  : mixed
Constructor.
attach()  : void
Attach listener to shared event manager.
onSearchPost()  : EventInterface
Hide facet values from display
processHideFacetValue()  : void
Process hide facet value

Properties

$hideFacets

List of facet values to hide, indexed by facet field.

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

$showFacets

List of facet values to show, indexed by facet field. All other facets are hidden.

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

Methods

__construct()

Constructor.

public __construct(BackendInterface $backend, array<string|int, mixed> $hideFacetValues[, array<string|int, mixed> $showFacetValues = [] ]) : mixed
Parameters
$backend : BackendInterface

Search backend

$hideFacetValues : array<string|int, mixed>

Assoc. array of field name => values to exclude from display.

$showFacetValues : array<string|int, mixed> = []

Assoc. array of field name => values to exclusively show in display.

Return values
mixed

attach()

Attach listener to shared event manager.

public attach(SharedEventManagerInterface $manager) : void
Parameters
$manager : SharedEventManagerInterface

Shared event manager

Return values
void

onSearchPost()

Hide facet values from display

public onSearchPost(EventInterface $event) : EventInterface
Parameters
$event : EventInterface

Event

Return values
EventInterface

processHideFacetValue()

Process hide facet value

protected processHideFacetValue(EventInterface $event) : void
Parameters
$event : EventInterface

Event

Return values
void

Search results