HandlerMap
extends AbstractHandlerMap
in package
SOLR backend handler map.
Tags
Table of Contents
- $fallback : string
- Fallback handler, if any.
- $handlers : array<string|int, mixed>
- Search handlers, indexed by function.
- $parameters : array<string|int, mixed>
- Query defaults/appends/invariants, indexed by handler.
- __construct() : void
- Constructor.
- addParameter() : void
- Add handler default, append, or invariant.
- getAppends() : array<string|int, mixed>
- Return query appends for search function.
- getDefaults() : array<string|int, mixed>
- Return query defaults for search function.
- getHandler() : string
- Return function handler.
- getInvariants() : array<string|int, mixed>
- Return query invariants for search function.
- getParameters() : ParamBag
- Return handler defaults, appends, or invariants.
- prepare() : void
- Prepare final set of parameters for search function.
- setHandlerMap() : void
- Set the handler map.
- setParameters() : void
- Set handler defaults, appends, or invariants.
- apply() : void
- Apply query defaults, appends, invariants.
Properties
$fallback
Fallback handler, if any.
protected
string
$fallback
$handlers
Search handlers, indexed by function.
protected
array<string|int, mixed>
$handlers
$parameters
Query defaults/appends/invariants, indexed by handler.
protected
array<string|int, mixed>
$parameters
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $map = [] ]) : void
Parameters
- $map : array<string|int, mixed> = []
-
Handler map
Return values
void —addParameter()
Add handler default, append, or invariant.
public
addParameter(string $handler, string $type, string $name, string $value) : void
Parameters
- $handler : string
-
Request handler
- $type : string
-
Parameter type, one of 'defaults', 'appends', or 'invariants'
- $name : string
-
Parameter name
- $value : string
-
Parameter value
Return values
void —getAppends()
Return query appends for search function.
public
getAppends(string $function) : array<string|int, mixed>
Parameters
- $function : string
-
Name of search function
Return values
array<string|int, mixed> —Query appends
getDefaults()
Return query defaults for search function.
public
getDefaults(string $function) : array<string|int, mixed>
Parameters
- $function : string
-
Name of search function
Return values
array<string|int, mixed> —Query defaults
getHandler()
Return function handler.
public
getHandler(string $function) : string
Parameters
- $function : string
-
Name of search function
Tags
Return values
string —Handler name
getInvariants()
Return query invariants for search function.
public
getInvariants(string $function) : array<string|int, mixed>
Parameters
- $function : string
-
Name of search function
Return values
array<string|int, mixed> —Query invariants
getParameters()
Return handler defaults, appends, or invariants.
public
getParameters(string $handler, string $type) : ParamBag
Parameters
- $handler : string
-
Request handler
- $type : string
-
Parameter type, one of 'defaults', 'appends', or 'invariants'
Tags
Return values
ParamBag —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 —setHandlerMap()
Set the handler map.
public
setHandlerMap(array<string|int, mixed> $map) : void
Parameters
- $map : array<string|int, mixed>
-
Handler map
Tags
Return values
void —setParameters()
Set handler defaults, appends, or invariants.
public
setParameters(string $handler, string $type, array<string|int, mixed> $parameters) : void
Parameters
- $handler : string
-
Request handler
- $type : string
-
Parameter type, one of 'defaults', 'appends', or 'invariants'
- $parameters : array<string|int, mixed>
-
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