Index

  1. \com\setasign\SetaFramework
    1. Bootstrap
      1. BadRequestException
      2. Bootstrap
      3. ConfigReader
      4. ConfigReaderException
      5. DomainName
      6. ErrorHandler
      7. HttpBootstrap
      8. HttpMessageHandler
      9. MaintenanceException
      10. RequestPathPrefix

com\setasign\SetaFramework\Bootstrap

HttpBootstrap Class Bootstrap Http

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

Class hierarchy

Implements

  • \Psr\Http\Server\MiddlewareInterface

Summary

Static Methods

Methods

Properties

Constants

Constants

EVENT_POST_RUN

public const HttpBootstrap::EVENT_POST_RUN = 'bootstrap.run.post'

Will be called after the main application is finished. Also if there was an exception!

extraParams:
'bootstrap' => Bootstrap

EVENT_PRE_RUN

public const HttpBootstrap::EVENT_PRE_RUN = 'bootstrap.run.pre'

Will be called before the main application will be started.

Listeners are able to modify the route data and change the application.

extraParams:
'bootstrap' => Bootstrap
'routeData' => &array

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

$errorController

protected ?\com\setasign\SetaFramework\Controller\ErrorControllerInterface HttpBootstrap::$errorController

$initialized

protected bool Bootstrap::$initialized = false

$logHandlerConfig

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

$requestPathPrefix

protected string HttpBootstrap::$requestPathPrefix = ''

Prefix to be substracted from the reuqest path before it is processed by routes

$response

protected ?\Psr\Http\Message\ResponseInterface HttpBootstrap::$response

$routerDefaultValues

protected ?\com\setasign\SetaFramework\Config\Config HttpBootstrap::$routerDefaultValues

$sessionConfig

protected ?\com\setasign\SetaFramework\Config\Config HttpBootstrap::$sessionConfig

$trustedProxiesConfig

protected ?\com\setasign\SetaFramework\Config\Config HttpBootstrap::$trustedProxiesConfig

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
 

start()

public static HttpBootstrap::start (
string $configFile,
array $configParams = array ( ),
\Psr\Http\Server\MiddlewareInterface[]|callable[] $middlewares = array ( )
): void

Setups everything and start the application.

Parameters
$configFile : string

Path to config file

$configParams : array
 
$middlewares : \Psr\Http\Server\MiddlewareInterface[]|callable[]

Callables must return a MiddlewareInterface. They get the arguments autowired by the GlobalDi.


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 HttpBootstrap::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

getErrorController()

public HttpBootstrap::getErrorController (
void
): \com\setasign\SetaFramework\Controller\ErrorControllerInterface

getQueue()

public HttpBootstrap::getQueue (
void
): array

Returns the default queue of middlewares

getRequestPathPrefix()

public HttpBootstrap::getRequestPathPrefix (
void
): string

Gets the RequestPathPrefix

getResponse()

public HttpBootstrap::getResponse (
void
): \Psr\Http\Message\ResponseInterface

Returns the Response

If no Response is set, a new instance will be created

getRouterDefaultValues()

public HttpBootstrap::getRouterDefaultValues (
void
): ?\com\setasign\SetaFramework\Config\Config

getSessionConfig()

public HttpBootstrap::getSessionConfig (
void
): ?\com\setasign\SetaFramework\Config\Config

getTrustedProxiesConfig()

public HttpBootstrap::getTrustedProxiesConfig (
void
): ?\com\setasign\SetaFramework\Config\Config

isDebug()

public Bootstrap::isDebug (
void
): bool

Returns whether uncatched exceptions will be shown

process()

public HttpBootstrap::process (
\Psr\Http\Message\ServerRequestInterface $request,
\Psr\Http\Server\RequestHandlerInterface $handler
): \Psr\Http\Message\ResponseInterface
Parameters
$request : \Psr\Http\Message\ServerRequestInterface
 
$handler : \Psr\Http\Server\RequestHandlerInterface
 
Exceptions

Throws \com\setasign\SetaFramework\Exception

Throws \Throwable

resetState()

public HttpBootstrap::resetState (
void
): void

runRouter()

public HttpBootstrap::runRouter (): array
Parameters
$request : \com\setasign\SetaFramework\Request\ServerRequest
 
Exceptions

Throws \com\setasign\SetaFramework\Router\RouteException

setBootstrapLogConfig()

public Bootstrap::setBootstrapLogConfig (): void
Parameters
$config : \com\setasign\SetaFramework\Config\Config
 

setCacheHandlerConfig()

public Bootstrap::setCacheHandlerConfig (): void
Parameters
$config : \com\setasign\SetaFramework\Config\Config
 

setDatabaseConnectionConfig()

public Bootstrap::setDatabaseConnectionConfig (): 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
 

setErrorController()

public HttpBootstrap::setErrorController (
string $file,
string $className
): void

Sets the errorController which will used if in run happens any error

Parameters
$file : string
 
$className : string
 
Exceptions

Throws \InvalidArgumentException If $file doesn't exist.

setLogHandlerConfig()

public Bootstrap::setLogHandlerConfig (): void
Parameters
$config : \com\setasign\SetaFramework\Config\Config
 

setRequestPathPrefix()

public HttpBootstrap::setRequestPathPrefix (
string $prefix
): void

Sets the RequestPathPrefix

Parameters
$prefix : string
 

setResponse()

public HttpBootstrap::setResponse (
\Psr\Http\Message\ResponseInterface $response
): void

Sets the Response

Parameters
$response : \Psr\Http\Message\ResponseInterface
 

setRouterDefaultValues()

public HttpBootstrap::setRouterDefaultValues (): void
Parameters
$routerDefaultValues : ?\com\setasign\SetaFramework\Config\Config
 

setSessionConfig()

public HttpBootstrap::setSessionConfig (): void
Parameters
$sessionConfig : ?\com\setasign\SetaFramework\Config\Config
 

setTrustedProxiesConfig()

public HttpBootstrap::setTrustedProxiesConfig (): void
Parameters
$trustedProxiesConfig : ?\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

setupRouter()

public HttpBootstrap::setupRouter (
void
): \com\setasign\SetaFramework\Router\Router
Exceptions

Throws \com\setasign\SetaFramework\Router\RouteException

setupStoragelessMiddleware()

final public HttpBootstrap::setupStoragelessMiddleware (
void
): \PSR7Sessions\Storageless\Http\SessionMiddleware

shutdownFunction()

protected Bootstrap::shutdownFunction (
void
): void

© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)