VuFind API Documentation

DefaultParametersListener
in package

Solr default parameters listener.

Allows injecting of default parameters depending on request type.

Tags
category

VuFind

author

Ere Maijala ere.maijala@helsinki.fi

license

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

link

Main Site

Table of Contents

$backend  : Backend
Backend.
$contextMap  : array<string|int, mixed>
Mapping from search methods to contexts
$defaultParams  : array<string|int, mixed>
Default parameters
__construct()  : void
Constructor.
attach()  : void
Attach listener to shared event manager.
onSearchPre()  : EventInterface
Add default parameters

Properties

$contextMap

Mapping from search methods to contexts

protected array<string|int, mixed> $contextMap = ['getIds' => 'search', 'random' => 'retrieve', 'retrieveBatch' => 'retrieve']

Methods

__construct()

Constructor.

public __construct(Backend $backend, array<string|int, mixed> $params) : void
Parameters
$backend : Backend

Search backend

$params : array<string|int, mixed>

Default parameters

Return values
void —

attach()

Attach listener to shared event manager.

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

Shared event manager

Return values
void —

onSearchPre()

Add default parameters

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

Event

Return values
EventInterface —

Search results