UrlQueryHelperFactory
in package
Factory to build UrlQueryHelper.
Tags
Table of Contents
- $helperClass : string
- Name of class built by factory.
- fromParams() : UrlQueryHelper
- Construct the UrlQueryHelper
- addDefaultsToConfig() : array<string|int, mixed>
- Load default settings into the user-provided configuration.
- getDefaults() : array<string|int, mixed>
- Extract default settings from the search parameters.
- getUrlParams() : array<string|int, mixed>
- Extract URL query parameters from VuFind search parameters.
Properties
$helperClass
Name of class built by factory.
protected
string
$helperClass
= \VuFind\Search\UrlQueryHelper::class
Methods
fromParams()
Construct the UrlQueryHelper
public
fromParams(Params $params[, array<string|int, mixed> $config = [] ]) : UrlQueryHelper
Parameters
- $params : Params
-
VuFind search parameters
- $config : array<string|int, mixed> = []
-
Config options
Return values
UrlQueryHelper —addDefaultsToConfig()
Load default settings into the user-provided configuration.
protected
addDefaultsToConfig(Params $params, array<string|int, mixed> $config) : array<string|int, mixed>
Parameters
- $params : Params
-
VuFind search parameters
- $config : array<string|int, mixed>
-
Config options
Return values
array<string|int, mixed> —getDefaults()
Extract default settings from the search parameters.
protected
getDefaults(Params $params) : array<string|int, mixed>
Parameters
- $params : Params
-
VuFind search parameters
Return values
array<string|int, mixed> —getUrlParams()
Extract URL query parameters from VuFind search parameters.
protected
getUrlParams(Params $params, array<string|int, mixed> $config) : array<string|int, mixed>
Parameters
- $params : Params
-
VuFind search parameters
- $config : array<string|int, mixed>
-
Config options