VuFind API Documentation

Bootstrapper
in package

VuFind Bootstrapper

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

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

link

Main Site

Table of Contents

$config  : Config
Main VuFind configuration
$container  : ContainerInterface
Service manager
$event  : MvcEvent
Current MVC event
$events  : EventManagerInterface
Event manager
__construct()  : mixed
Constructor
bootstrap()  : void
Bootstrap all necessary resources.
getDbService()  : T
Get a database service object.
initContentSecurityPolicy()  : void
Set up content security policy
initContext()  : void
Set view variables representing the current context.
initErrorLogging()  : void
Set up logging.
initExceptionBasedHttpStatuses()  : void
Set up custom HTTP status based on exception information.
initLoginTokenManager()  : void
The login token manager needs to be informed after the theme has been initialized, so that it can send warning emails if necessary.
initRateLimiter()  : void
Set up rate limiter
initRenderErrorEvent()  : void
Set up handling for rendering problems.
initSearch()  : void
Set up search subsystem.
initSystemStatus()  : void
If the system is offline, set up a handler to override the routing output.
initTestMode()  : void
Set up cookie to flag test mode.
initTheme()  : void
Set up theme handling.
initTimeZone()  : void
Initializes timezone value
initUserLanguage()  : void
Update language in user account, as needed.
initViewModel()  : void
Set up the initial view model.

Properties

$config

Main VuFind configuration

protected Config $config

$container

Service manager

protected ContainerInterface $container

$events

Event manager

protected EventManagerInterface $events

Methods

__construct()

Constructor

public __construct(MvcEvent $event) : mixed
Parameters
$event : MvcEvent

Laminas MVC Event object

Return values
mixed

bootstrap()

Bootstrap all necessary resources.

public bootstrap() : void
Return values
void

getDbService()

Get a database service object.

public getDbService(class-string<\VuFind\T> $name) : T
Parameters
$name : class-string<\VuFind\T>

Name of service to retrieve

Tags
template

T

Return values
T

initContentSecurityPolicy()

Set up content security policy

protected initContentSecurityPolicy() : void
Return values
void

initContext()

Set view variables representing the current context.

protected initContext() : void
Return values
void

initErrorLogging()

Set up logging.

protected initErrorLogging() : void
Return values
void

initExceptionBasedHttpStatuses()

Set up custom HTTP status based on exception information.

protected initExceptionBasedHttpStatuses() : void
Return values
void

initLoginTokenManager()

The login token manager needs to be informed after the theme has been initialized, so that it can send warning emails if necessary.

protected initLoginTokenManager() : void
Return values
void

initRateLimiter()

Set up rate limiter

protected initRateLimiter() : void
Return values
void

initRenderErrorEvent()

Set up handling for rendering problems.

protected initRenderErrorEvent() : void
Return values
void

initSearch()

Set up search subsystem.

protected initSearch() : void
Return values
void

initSystemStatus()

If the system is offline, set up a handler to override the routing output.

protected initSystemStatus() : void
Return values
void

initTestMode()

Set up cookie to flag test mode.

protected initTestMode() : void
Return values
void

initTheme()

Set up theme handling.

protected initTheme() : void
Return values
void

initTimeZone()

Initializes timezone value

protected initTimeZone() : void
Return values
void

initUserLanguage()

Update language in user account, as needed.

protected initUserLanguage() : void
Return values
void

initViewModel()

Set up the initial view model.

protected initViewModel() : void
Return values
void

Search results