Class Bootstrap in namespace com\setasign\SetaFramework\Bootstrap in SetaFramework API Reference

Index

\com\setasign\SetaFramework
1. Bootstrap

com\setasign\SetaFramework\Bootstrap

Bootstrap

File: /SetaFramework/src/Bootstrap/Bootstrap.php

Class hierarchy

Bootstrap
- HttpBootstrap

Summary

Constants

EVENT_SHUTDOWN_HANDLER

public const Bootstrap::EVENT_SHUTDOWN_HANDLER = 'bootstrap.shutdown_handler'

Will be called after script execution finishes or exit() is called.

Note: HttpBootstrap and Bootstrap share the same shutdown-event.

Show also shutdown functions.

extraParams:
'bootstrap' => Bootstrap

Properties

$bootstrapLogConfig

protected ?\com\setasign\SetaFramework\Config\Config Bootstrap::$bootstrapLogConfig

$cacheHandlerConfig

protected ?\com\setasign\SetaFramework\Config\Config Bootstrap::$cacheHandlerConfig

$databaseConnectionConfig

protected ?\com\setasign\SetaFramework\Config\Config Bootstrap::$databaseConnectionConfig

$debug

protected bool Bootstrap::$debug = false

$defaultDomain

protected Bootstrap::$defaultDomain

$di

protected ?\com\setasign\SetaFramework\Di\Di Bootstrap::$di

$initialized

protected bool Bootstrap::$initialized = false

$logHandlerConfig

protected ?\com\setasign\SetaFramework\Config\Config Bootstrap::$logHandlerConfig

Static Methods

prepare()

public static Bootstrap::prepare (

string $configFile,
array $configParams = array ( )

): Bootstrap

Helper method if you want to call the bootstrap manually.

Parameters

$configFile : string
$configParams : array

Exceptions

Throws ConfigReaderException

registerShutdownFunction()

WARNING: This method is marked as deprecated!

Use eventManager Bootstrap::EVENT_SHUTDOWN_HANDLER directly.

public static Bootstrap::registerShutdownFunction (

callable $function

): void

You should always use this method instead of "register_shutdown_function" to prevent memory leaks in application server structure.

Parameters

$function : callable

Methods

__construct()

final public Bootstrap::__construct (

string $configFile,
array $configParams = array ( )

)

Parameters

$configFile : string
$configParams : array

Exceptions

Throws ConfigReaderException

__wakeup()

public Bootstrap::__wakeup (

void

): void

configureDi()

protected Bootstrap::configureDi (

void

): void

getDefaultDomain()

public Bootstrap::getDefaultDomain (

void

): ?string

getDi()

public Bootstrap::getDi (

void

): \com\setasign\SetaFramework\Di\Di

Returns the Di

If no Di is set, the global di will be used

isDebug()

public Bootstrap::isDebug (

void

): bool

Returns whether uncatched exceptions will be shown

resetState()

public Bootstrap::resetState (

void

): void

setBootstrapLogConfig()

public Bootstrap::setBootstrapLogConfig (

\com\setasign\SetaFramework\Config\Config $config

): void

Parameters

$config : \com\setasign\SetaFramework\Config\Config

setCacheHandlerConfig()

public Bootstrap::setCacheHandlerConfig (

\com\setasign\SetaFramework\Config\Config $config

): void

Parameters

$config : \com\setasign\SetaFramework\Config\Config

setDatabaseConnectionConfig()

public Bootstrap::setDatabaseConnectionConfig (

\com\setasign\SetaFramework\Config\Config $config

): void

Parameters

$config : \com\setasign\SetaFramework\Config\Config

setDebug()

public Bootstrap::setDebug (

bool $debug

): void

Parameters

$debug : bool

setDefaultDomain()

public Bootstrap::setDefaultDomain (

?string $domain

): void

Parameters

$domain : ?string

setLogHandlerConfig()

public Bootstrap::setLogHandlerConfig (

\com\setasign\SetaFramework\Config\Config $config

): void

Parameters

$config : \com\setasign\SetaFramework\Config\Config

setupCacheBuilder()

final protected Bootstrap::setupCacheBuilder (

void

): \com\setasign\SetaFramework\SimpleCache\CacheBuilderInterface

Exceptions

Throws \Throwable

setupDatabaseConnectionManager()

final protected Bootstrap::setupDatabaseConnectionManager (

void

): \com\setasign\SetaFramework\Database\DatabaseConnectionManager

Exceptions

Throws \Throwable

setupErrorHandler()

final protected Bootstrap::setupErrorHandler (

void

): ErrorHandler

Exceptions

Throws \Throwable

setupLogBuilder()

final protected Bootstrap::setupLogBuilder (

void

): \com\setasign\SetaFramework\Log\LogBuilderInterface

Exceptions

Throws \Throwable

setupLogHandler()

final protected Bootstrap::setupLogHandler (

void

): \com\setasign\SetaFramework\Log\LogHandler

Exceptions

Throws \Throwable

shutdownFunction()

protected Bootstrap::shutdownFunction (

void

): void