VuFind API Documentation

MultiIndexListener
in package

MultiIndex listener class file.

Tags
category

VuFind

author

David Maus maus@hab.de

license

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

link

Main Site

Table of Contents

$backend  : BackendInterface
Backend.
$shards  : array<string|int, mixed>
Available shards, indexed by name.
$specs  : array<string|int, mixed>
Base search specs.
$stripfields  : array<string|int, mixed>
Fields to strip, indexed by shard name.
__construct()  : void
Constructor.
attach()  : void
Attach listener to shared event manager.
onSearchPre()  : EventInterface
VuFindSearch.pre()
getFields()  : array<string|int, mixed>
Return array of fields to strip.
getSearchSpecs()  : array<string|int, mixed>
Strip fields from base search specs.
stripSpecsQueryFields()  : array<string|int, mixed>
Strip fields from a search specs QueryFields section.

Properties

$shards

Available shards, indexed by name.

protected array<string|int, mixed> $shards

$stripfields

Fields to strip, indexed by shard name.

protected array<string|int, mixed> $stripfields

Methods

__construct()

Constructor.

public __construct(BackendInterface $backend, array<string|int, mixed> $shards, array<string|int, mixed> $stripfields, array<string|int, mixed> $specs) : void
Parameters
$backend : BackendInterface

Backend

$shards : array<string|int, mixed>

Available shards, indexed by name

$stripfields : array<string|int, mixed>

Fields to strip, indexed by shard name

$specs : array<string|int, mixed>

Base search specs

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()

VuFindSearch.pre()

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

Event

Return values
EventInterface —

getFields()

Return array of fields to strip.

protected getFields(array<string|int, mixed> $shards) : array<string|int, mixed>
Parameters
$shards : array<string|int, mixed>

Active shards

Return values
array<string|int, mixed> —

getSearchSpecs()

Strip fields from base search specs.

protected getSearchSpecs(array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
$fields : array<string|int, mixed>

Fields to strip

Return values
array<string|int, mixed> —

stripSpecsQueryFields()

Strip fields from a search specs QueryFields section.

protected stripSpecsQueryFields(array<string|int, mixed> $settings, array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
$settings : array<string|int, mixed>

QueryField section

$fields : array<string|int, mixed>

Fields to strip

Return values
array<string|int, mixed> —

Search results