BrowZineBackendFactory
extends AbstractBackendFactory
in package
Uses
SecretTrait
Factory for BrowZine backend.
Tags
Table of Contents
- $browzineConfig : Config
- BrowZine configuration
- $logger : LoggerInterface
- Logger.
- $serviceLocator : ContainerInterface
- Service manager
- __construct() : mixed
- Constructor
- __invoke() : Backend
- Create service
- getService() : T
- Retrieve a service
- setup() : void
- Initialize the factory
- createBackend() : Backend
- Create the Primo Central backend.
- createConnector() : Connector
- Create the Primo Central connector.
- createConnectorCache() : StorageInterface|null
- Create cache for the connector if enabled in configuration
- createHttpClient() : Client
- Create HTTP Client
- createQueryBuilder() : QueryBuilder
- Create the Primo query builder.
- createRecordCollectionFactory() : RecordCollectionFactory
- Create the record collection factory
- getSecretFromConfig() : string|null
- Load a secret value from the specified configuration and key.
Properties
$browzineConfig
BrowZine configuration
protected
Config
$browzineConfig
$logger
Logger.
protected
LoggerInterface
$logger
$serviceLocator
Service manager
protected
ContainerInterface
$serviceLocator
Methods
__construct()
Constructor
public
__construct() : mixed
Return values
mixed —__invoke()
Create service
public
__invoke(ContainerInterface $sm, string $name[, array<string|int, mixed> $options = null ]) : Backend
Parameters
- $sm : ContainerInterface
-
Service manager
- $name : string
-
Requested service name (unused)
- $options : array<string|int, mixed> = null
-
Extra options (unused)
Tags
Return values
Backend —getService()
Retrieve a service
public
getService(class-string<\VuFind\Service\T> $name) : T
Parameters
- $name : class-string<\VuFind\Service\T>
-
Name of service to retrieve
Tags
Return values
T —setup()
Initialize the factory
public
setup(ContainerInterface $sm) : void
Parameters
- $sm : ContainerInterface
-
Service manager
Return values
void —createBackend()
Create the Primo Central backend.
protected
createBackend(Connector $connector) : Backend
Parameters
- $connector : Connector
-
Connector
Return values
Backend —createConnector()
Create the Primo Central connector.
protected
createConnector() : Connector
Return values
Connector —createConnectorCache()
Create cache for the connector if enabled in configuration
protected
createConnectorCache(Config $searchConfig) : StorageInterface|null
Parameters
- $searchConfig : Config
-
Search configuration
Return values
StorageInterface|null —createHttpClient()
Create HTTP Client
protected
createHttpClient([int $timeout = null ][, array<string|int, mixed> $options = [] ][, string $url = null ]) : Client
Parameters
- $timeout : int = null
-
Request timeout
- $options : array<string|int, mixed> = []
-
Other options
- $url : string = null
-
Request URL (needed for proper local address check when the client is being proxified)
Return values
Client —createQueryBuilder()
Create the Primo query builder.
protected
createQueryBuilder() : QueryBuilder
Return values
QueryBuilder —createRecordCollectionFactory()
Create the record collection factory
protected
createRecordCollectionFactory() : RecordCollectionFactory
Return values
RecordCollectionFactory —getSecretFromConfig()
Load a secret value from the specified configuration and key.
protected
getSecretFromConfig(Config|array<string|int, mixed>|null $config, string $key) : string|null
Will look for a _file-suffixed version of the key first, and load the data from a separate file if configured to do so.
Parameters
- $config : Config|array<string|int, mixed>|null
-
The config to read from
- $key : string
-
The key to retrieve