VuFind API Documentation

AbstractHandlerMap
in package

Base class for search backend handler maps.

The handler map maps search functions to parameterizable backend request handlers. The base class implements the parameter preparation method which applies query defaults, appends, and invariants to an existing set of parameters.

Tags
category

VuFind

author

David Maus maus@hab.de

license

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

link
https://vufind.org

Table of Contents

getAppends()  : ParamBag
Return query appends for search function.
getDefaults()  : ParamBag
Return query defaults for search function.
getInvariants()  : ParamBag
Return query invariants for search function.
prepare()  : void
Prepare final set of parameters for search function.
apply()  : void
Apply query defaults, appends, invariants.

Methods

getAppends()

Return query appends for search function.

public abstract getAppends(string $function) : ParamBag
Parameters
$function : string

Name of search function

Return values
ParamBag —

Query appends

getDefaults()

Return query defaults for search function.

public abstract getDefaults(string $function) : ParamBag
Parameters
$function : string

Name of search function

Return values
ParamBag —

Query defaults

getInvariants()

Return query invariants for search function.

public abstract getInvariants(string $function) : ParamBag
Parameters
$function : string

Name of search function

Return values
ParamBag —

Query invariants

prepare()

Prepare final set of parameters for search function.

public prepare(string $function, ParamBag $params) : void

Applies the query defaults, appends, and invariants.

The concept of defaults, appends, and invariants follows SOLR with regards to the order of the application process: Invariants come last and overwrite runtime parameters, defaults, and appends.

Parameters
$function : string

Name of search function

$params : ParamBag

Parameters

Return values
void —

apply()

Apply query defaults, appends, invariants.

protected apply(ParamBag $params, array<string|int, mixed> $defaults, array<string|int, mixed> $appends, array<string|int, mixed> $invariants) : void
Parameters
$params : ParamBag

Parameters

$defaults : array<string|int, mixed>

Query defaults

$appends : array<string|int, mixed>

Query appends

$invariants : array<string|int, mixed>

Query invariants

Return values
void —

Search results