Application

API reference › PSR bridge › http › Application

class	`yii2\extensions\psrbridge\http\Application`
Extends	`yii\web\Application` » `yii\base\Application` » `yii\base\Module` » `yii\di\ServiceLocator` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`Psr\Http\Server\RequestHandlerInterface`, `yii\base\Configurable`
Source	`src/http/Application.php`

Handles PSR-7 requests with a stateless Yii application lifecycle.

RequestHandlerInterface PSR-7 request handler contract.

This handler requires post-emission finalization when used by a PSR-15 host. The request lifecycle spans two calls: handle() runs the request and returns the PSR-7 response (pre-send), then the runtime emits it and MUST call finalize() to complete Yii’s after-send lifecycle and release per-request worker state.

Calling handle() without finalize() leaves event tracking attached across requests in workers.

Properties

Property	Type	Description	Defined by
`$actionMap`	`array<string, class-string\|array<string, mixed>>`	Mapping from action IDs to standalone `Action` class configurations. Default: `[]`. Available since 22.0.	`yii\base\Module`
`$actionNamespace`	`string\|null`	The namespace where standalone `Action` subclasses are located for convention-based discovery, parallel to `$controllerNamespace` for controllers. Default: `null`. Available since 22.0.	`yii\base\Module`
`$aliases` write-only	`array`	List of path aliases to be defined.	`yii\base\Module`
`$assetManager` read-only	`yii\web\AssetManager`	The asset manager application component.	`yii\base\Application`
`$authManager` read-only	`yii\rbac\ManagerInterface\|null`	The auth manager application component or null if it’s not configured.	`yii\base\Application`
`$basePath`	`string`	The root directory of the application.	`yii\base\Application`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$bootstrap`	`array`	List of components that should be run during the application bootstrapping process. Default: `[]`.	`yii\base\Application`
`$cache` read-only	`yii\caching\CacheInterface\|null`	The cache application component.	`yii\base\Application`
`$catchAll`	`array\|null`	The configuration specifying a controller action which should handle all user requests. Default: `null`.	`yii\web\Application`
`$charset`	`string`	The charset currently used for the application. Default: `'UTF-8'`.	`yii\base\Application`
`$components`	`array`	The list of the component definitions or the loaded component instances (ID => definition or instance).	`yii\di\ServiceLocator`
`$container` write-only	`array`	Values given in terms of name-value pairs.	`yii\base\Application`
`$controller`	`yii\web\Controller\|null`	The currently active controller instance Default: `null`.	`yii\web\Application`
`$controllerMap`	`array`	Mapping from controller ID to controller configurations. Default: `[]`.	`yii\base\Module`
`$controllerNamespace`	`string`	The namespace that controller classes are located in. Default: `'app\controllers'`.	`yii\base\Application`
`$controllerPath`	`string`	The directory that contains the controller classes.	`yii\base\Module`
`$db` read-only	`yii\db\Connection`	The database connection.	`yii\base\Application`
`$defaultRoute`	`string`	The default route of this application. Default: `'site'`.	`yii\web\Application`
`$errorHandler` read-only	`yii\web\ErrorHandler`	The error handler application component.	`yii\web\Application`
`$extensions`	`array\|null`	List of installed Yii extensions. Default: `null`.	`yii\base\Application`
`$flushLogger`	`bool`	Flushes the logger during `finalize()` when set to `true`. Default: `true`.	`Application`
`$formatter` read-only	`yii\i18n\Formatter`	The formatter application component.	`yii\base\Application`
`$homeUrl`	`string`	The homepage URL.	`yii\web\Application`
`$i18n` read-only	`yii\i18n\I18N`	The internationalization application component.	`yii\base\Application`
`$id`	`string`	An ID that uniquely identifies this module among other modules which have the same parent. Default: `null`.	`yii\base\Module`
`$language`	`string`	The language that is meant to be used for end users. Default: `'en-US'`.	`yii\base\Application`
`$layout`	`string\|bool`	The layout that should be applied for views in this application. Default: `'main'`.	`yii\base\Application`
`$layoutPath`	`string`	The root directory of layout files.	`yii\base\Module`
`$loadedModules`	`array`	List of loaded modules indexed by their class names. Default: `[]`.	`yii\base\Application`
`$log` read-only	`yii\log\Dispatcher`	The log dispatcher application component.	`yii\base\Application`
`$mailer` read-only	`yii\mail\MailerInterface`	The mailer application component.	`yii\base\Application`
`$memoryLimit`	`int`	Limit in bytes, or `PHP_INT_MAX` for an unlimited PHP setting.	`Application`
`$module`	`yii\base\Module\|null`	The parent module of this module. `null` if this module does not have a parent. Default: `null`.	`yii\base\Module`
`$modules`	`array`	The modules (indexed by their IDs).	`yii\base\Module`
`$name`	`string`	The application name. Default: `'My Application'`.	`yii\base\Application`
`$params`	`array`	Custom module parameters (name => value). Default: `[]`.	`yii\base\Module`
`$persistentComponents`	`array<int, string>`	Lists component IDs that should stay alive across requests in long-running workers. Default: `['db', 'cache']`.	`Application`
`$request` read-only	`yii\web\Request`	The request component.	`yii\web\Application`
`$requestedAction`	`yii\base\Action<yii\base\Controller>\|null`	The requested Action. Default: `null`.	`yii\base\Application`
`$requestedParams`	`array\|null`	The parameters supplied to the requested action. Default: `null`.	`yii\base\Application`
`$requestedRoute`	`string`	The requested route Default: `null`.	`yii\base\Application`
`$resetUploadedFiles`	`bool`	Retained for configuration compatibility; request preparation always resets uploaded file state. Default: `true`.	`Application`
`$response` read-only	`yii\web\Response`	The response component.	`yii\web\Application`
`$runtimePath`	`string`	The directory that stores runtime files.	`yii\base\Application`
`$security` read-only	`yii\base\Security`	The security application component.	`yii\base\Application`
`$session` read-only	`yii\web\Session`	The session component.	`yii\web\Application`
`$sourceLanguage`	`string`	The language that the application is written in. Default: `'en-US'`.	`yii\base\Application`
`$state`	`int`	The current application state during a request handling life cycle. Default: `null`.	`yii\base\Application`
`$syncCookieValidation`	`bool`	Controls whether cookie validation settings are synchronized between request and response. Default: `true`.	`Application`
`$timeZone`	`string`	The time zone used by this application.	`yii\base\Application`
`$uniqueId` read-only	`string`	The unique ID of the module.	`yii\base\Application`
`$urlManager` read-only	`yii\web\UrlManager`	The URL manager for this application.	`yii\base\Application`
`$user` read-only	`yii\web\User<yii\web\TUserIdentity>`	The user component.	`yii\web\Application`
`$useSession`	`bool`	Controls whether the session is opened before bootstrap and closed after it for each request. Default: `true`.	`Application`
`$vendorPath`	`string`	The directory that stores vendor files.	`yii\base\Application`
`$version`	`string`	Defines the application version string. Default: `'0.3.0'`.	`Application`
`$view` read-only	`yii\base\View\|yii\web\View`	The view application component that is used to render various view files.	`yii\base\Application`
`$viewPath`	`string`	The root directory of view files.	`yii\base\Module`

Methods

Method	Description	Defined by
`__construct()`	Initializes a new application instance.	`Application`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Component`
`__get()`	Getter magic method.	`yii\di\ServiceLocator`
`__isset()`	Checks if a property value is null.	`yii\di\ServiceLocator`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`afterAction()`	This method is invoked right after an action within this module is executed.	`yii\base\Module`
`attachBehavior()`	Attaches a behavior to this component.	`yii\base\Component`
`attachBehaviors()`	Attaches a list of behaviors to the component.	`yii\base\Component`
`beforeAction()`	This method is invoked right before an action within this module is executed.	`yii\base\Module`
`behaviors()`	Returns a list of behaviors that this component should behave as.	`yii\base\Component`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`clean()`	Runs garbage collection and reports whether allocated memory reached 90% of the configured limit.	`Application`
`clear()`	Removes the component from the locator.	`yii\di\ServiceLocator`
`coreComponents()`	Returns Yii core components with bridge request, response, session, and error handler definitions.	`Application`
`createController()`	Creates a controller instance based on the given route.	`yii\base\Module`
`createControllerByID()`	Creates a controller based on the given controller ID.	`yii\base\Module`
`detachBehavior()`	Detaches a behavior from the component.	`yii\base\Component`
`detachBehaviors()`	Detaches all behaviors from the component.	`yii\base\Component`
`end()`	Terminates the application.	`yii\base\Application`
`ensureBehaviors()`	Makes sure that the behaviors declared in `behaviors()` are attached to this component.	`yii\base\Component`
`finalize()`	Completes after-send processing and worker cleanup following the runtime’s emission attempt.	`Application`
`get()`	Returns the component instance with the specified ID.	`yii\base\Module`
`getAssetManager()`	Returns the asset manager.	`yii\base\Application`
`getAuthManager()`	Returns the auth manager for this application.	`yii\base\Application`
`getBasePath()`	Returns the root directory of the module.	`yii\base\Module`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`getCache()`	Returns the cache component.	`yii\base\Application`
`getComponents()`	Returns the list of the component definitions or the loaded component instances.	`yii\di\ServiceLocator`
`getControllerPath()`	Returns the directory that contains the controller classes according to `$controllerNamespace`.	`yii\base\Module`
`getDb()`	Returns the database connection component.	`yii\base\Application`
`getErrorHandler()`	Returns the error handler component.	`yii\web\Application`
`getFormatter()`	Returns the formatter component.	`yii\base\Application`
`getHomeUrl()`		`yii\web\Application`
`getI18n()`	Returns the internationalization (i18n) component.	`yii\base\Application`
`getInstance()` static	Returns the currently requested instance of this module class.	`yii\base\Module`
`getLayoutPath()`	Returns the directory that contains layout view files for this module.	`yii\base\Module`
`getLog()`	Returns the log dispatcher component.	`yii\base\Application`
`getMailer()`	Returns the mailer component.	`yii\base\Application`
`getMemoryLimit()`	Returns the cached memory limit, parsing PHP’s setting when needed.	`Application`
`getModule()`	Retrieves the child module of the specified ID.	`yii\base\Module`
`getModules()`	Returns the sub-modules in this module.	`yii\base\Module`
`getRequest()`	Returns the request component.	`yii\web\Application`
`getResponse()`	Returns the response component.	`yii\web\Application`
`getRuntimePath()`	Returns the directory that stores runtime files.	`yii\base\Application`
`getSecurity()`	Returns the security component.	`yii\base\Application`
`getSession()`	Returns the session component.	`yii\web\Application`
`getTimeZone()`	Returns the time zone used by this application.	`yii\base\Application`
`getUniqueId()`	Returns an ID that uniquely identifies this module among all modules within the current application.	`yii\base\Application`
`getUrlManager()`	Returns the URL manager for this application.	`yii\base\Application`
`getUser()`	Returns the user component.	`yii\web\Application`
`getVendorPath()`	Returns the directory that stores vendor files.	`yii\base\Application`
`getVersion()`	Returns current module version.	`yii\base\Module`
`getView()`	Returns the view object.	`yii\base\Application`
`getViewPath()`	Returns the directory that contains the view files for this module.	`yii\base\Module`
`handle()`	Handles a PSR-7 request and returns the prepared response before emission.	`Application`
`handleRequest()`	Handles the specified request.	`yii\web\Application`
`has()`	Returns a value indicating whether the locator has the specified component definition or has instantiated the component.	`yii\base\Module`
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	`yii\base\Component`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\Component`
`hasModule()`	Checks whether the child module of the specified ID exists.	`yii\base\Module`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Sets the per-request state to `STATE_INIT`; bootstrap runs after the PSR request is attached.	`Application`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`preInit()`	Pre-initializes the application.	`yii\base\Application`
`run()`	Runs the application.	`yii\base\Application`
`runAction()`	Runs a controller action specified by a route.	`yii\base\Module`
`set()`	Registers a component definition with this locator.	`yii\di\ServiceLocator`
`setAliases()`	Defines path aliases.	`yii\base\Module`
`setBasePath()`	Sets the root directory of the application and the @app alias.	`yii\base\Application`
`setComponents()`	Registers a set of component definitions in this locator.	`yii\di\ServiceLocator`
`setContainer()`	Configures `Yii::$container` with the $config.	`yii\base\Application`
`setControllerPath()`	Sets the directory that contains the controller classes.	`yii\base\Module`
`setHomeUrl()`		`yii\web\Application`
`setInstance()` static	Sets the currently requested instance of this module class.	`yii\base\Module`
`setLayoutPath()`	Sets the directory that contains the layout files.	`yii\base\Module`
`setMemoryLimit()`	Overrides the cached worker memory threshold or requests recalculation from PHP’s setting.	`Application`
`setModule()`	Adds a sub-module to this module.	`yii\base\Module`
`setModules()`	Registers sub-modules in the current module.	`yii\base\Module`
`setRuntimePath()`	Sets the directory that stores runtime files.	`yii\base\Application`
`setTimeZone()`	Sets the time zone used by this application.	`yii\base\Application`
`setVendorPath()`	Sets the directory that stores vendor files.	`yii\base\Application`
`setVersion()`	Sets current module version.	`yii\base\Module`
`setViewPath()`	Sets the directory that contains the view files.	`yii\base\Module`
`trigger()`	Triggers an event.	`yii\base\Component`
`attachPsrRequest()` protected	Attaches the PSR-7 request to the Yii request adapter.	`Application`
`bootstrap()` protected	Initializes extensions and executes bootstrap components.	`yii\web\Application`
`createStandaloneAction()` protected	Resolves a route to a standalone `Action` class through convention-based discovery under `$actionNamespace`.	`yii\base\Module`
`defaultVersion()` protected	Returns default module version.	`yii\base\Module`
`finalizeSessionState()` protected	Closes the session after bootstrap completes.	`Application`
`openSessionFromRequestCookies()` protected	Opens the session before bootstrap when `$useSession` is `true`.	`Application`
`prepareErrorHandler()` protected	Resets the error handler response target for the current request.	`Application`
`prepareForRequest()` protected	Prepares the application state for a new PSR-7 request.	`Application`
`registerErrorHandler()` protected	Registers the errorHandler component as a PHP error handler.	`yii\base\Application`
`reinitializeApplication()` protected	Reinitializes the application instance for the current request.	`Application`
`resetRequestState()` protected	Resets route and action resolution state.	`Application`
`resetUploadedFilesState()` protected	Resets uploaded file static state for the current request.	`Application`
`runMappedAction()` protected	Runs a standalone action registered in `$actionMap`.	`yii\base\Module`
`runStandaloneAction()` protected	Runs a standalone `Action` instance through the standard module/action event lifecycle.	`yii\base\Module`
`syncCookieValidationState()` protected	Synchronizes cookie validation settings between request and response.	`Application`
`syncSessionIdFromRequestCookies()` protected	Isolates PHP session state for the current request without opening the session.	`Application`
`terminate()` protected	Converts the Yii response to PSR-7 and stores it for deferred after-send finalization.	`Application`

Events

Event	Type	Description	Defined by
`EVENT_BEFORE_REQUEST`	`yii\base\Event`	An event raised before the application starts to handle a request. Event name: `'beforeRequest'`.	`yii\base\Application`
`EVENT_AFTER_REQUEST`	`yii\base\Event`	An event raised after the application successfully handles a request (before the response is sent out). Event name: `'afterRequest'`.	`yii\base\Application`
`EVENT_BEFORE_ACTION`	`yii\base\ActionEvent`	An event raised before executing a controller action. Event name: `'beforeAction'`.	`yii\base\Module`
`EVENT_AFTER_ACTION`	`yii\base\ActionEvent`	An event raised after executing a controller action. Event name: `'afterAction'`.	`yii\base\Module`

Constants

Constant	Value	Description	Defined by
`STATE_BEGIN`	`0`	Application state used by `$state`: application just started.	`yii\base\Application`
`STATE_INIT`	`1`	Application state used by `$state`: application is initializing.	`yii\base\Application`
`STATE_BEFORE_REQUEST`	`2`	Application state used by `$state`: application is triggering `EVENT_BEFORE_REQUEST`.	`yii\base\Application`
`STATE_HANDLING_REQUEST`	`3`	Application state used by `$state`: application is handling the request.	`yii\base\Application`
`STATE_AFTER_REQUEST`	`4`	Application state used by `$state`: application is triggering `EVENT_AFTER_REQUEST`.	`yii\base\Application`
`STATE_SENDING_RESPONSE`	`5`	Application state used by `$state`: application is about to send response.	`yii\base\Application`
`STATE_END`	`6`	Application state used by `$state`: application has ended.	`yii\base\Application`

Property details

$persistentComponents

public array<int, string> $persistentComponents = ['db', 'cache']

Lists component IDs that should stay alive across requests in long-running workers.

Keep request-sensitive components (such as request or response) out of this list.

$resetUploadedFiles

public bool $resetUploadedFiles = true

Retained for configuration compatibility; request preparation always resets uploaded file state.

Setting this property to false does not disable the reset.

$syncCookieValidation

public bool $syncCookieValidation = true

Controls whether cookie validation settings are synchronized between request and response.

Set to false to skip request-to-response cookie validation key synchronization.

$useSession

public bool $useSession = true

Controls whether the session is opened before bootstrap and closed after it for each request.

The bridge always isolates PHP session state between requests through syncSessionIdFromRequestCookies(): it closes a session left active and applies the session ID from the request cookie (or an empty ID when the cookie is missing or malformed), so a lazily opened session belongs to the current visitor. Set to false to skip only the eager openSessionFromRequestCookies() and finalizeSessionState() hooks.

Method details

__construct()

public function __construct(mixed[] $config = [])

Initializes a new application instance.

Parameters

Parameter	Type	Description
`$config`	`mixed[]`	Application configuration.

clean()

public function clean(): bool

Runs garbage collection and reports whether allocated memory reached 90% of the configured limit.

The runtime decides whether to recycle the worker. An unlimited PHP memory setting maps to PHP_INT_MAX.

Returns

bool: Whether allocated memory is at least 90% of the limit.

coreComponents()

public function coreComponents(): mixed[]

Returns Yii core components with bridge request, response, session, and error handler definitions.

Returns

mixed[]: Core component definitions.

finalize()

public function finalize(bool $success = true): void

Completes after-send processing and worker cleanup following the runtime’s emission attempt.

On success, calls Response::completeSend() on the response returned by handle(). Pass false when emission failed to skip after-send. Tracked event cleanup runs even if an after-send handler throws; logger flushing runs when enabled and a converted response is available.

Call exactly once per emission attempt. Keep this call outside an emitter catch block so an after-send exception is not treated as an emission failure and does not cause a second call.

Parameters

Parameter	Type	Description
`$success`	`bool`	Whether emission completed successfully.

Throws

Throwable: when an after-send handler, event cleanup, or logger flush fails.

getMemoryLimit()

public function getMemoryLimit(): int

Returns the cached memory limit, parsing PHP’s setting when needed.

Returns

int: Limit in bytes, or PHP_INT_MAX for an unlimited PHP setting.

handle()

public function handle(Psr\Http\Message\ServerRequestInterface $request): Psr\Http\Message\ResponseInterface

Handles a PSR-7 request and returns the prepared response before emission.

The runtime must emit this response and call finalize(). Application and request state are reinitialized before handling; bootstrap observes the current request’s session state.

Parameters

Parameter	Type	Description
`$request`	`Psr\Http\Message\ServerRequestInterface`	Request to process.

Returns

Psr\Http\Message\ResponseInterface: Prepared response; after-send processing remains deferred.

Throws

Throwable: When initialization, error handling, or response conversion cannot produce a response.

init()

public function init(): void

Sets the per-request state to STATE_INIT; bootstrap runs after the PSR request is attached.

setMemoryLimit()

public function setMemoryLimit(int $limit): void

Overrides the cached worker memory threshold or requests recalculation from PHP’s setting.

Parameters

Parameter	Type	Description
`$limit`	`int`	Limit in bytes; a non-positive value recalculates on the next `getMemoryLimit()` call.

attachPsrRequest()

protected function attachPsrRequest(Psr\Http\Message\ServerRequestInterface $request): void

Attaches the PSR-7 request to the Yii request adapter.

Parameters

Parameter	Type	Description
`$request`	`Psr\Http\Message\ServerRequestInterface`	Request to attach.

finalizeSessionState()

protected function finalizeSessionState(): void

Closes the session after bootstrap completes.

openSessionFromRequestCookies()

protected function openSessionFromRequestCookies(): void

Opens the session before bootstrap when $useSession is true.

Runs after syncSessionIdFromRequestCookies(), so the session resumes the ID from the request cookie or starts with a new one.

prepareErrorHandler()

protected function prepareErrorHandler(): void

Resets the error handler response target for the current request.

prepareForRequest()

protected function prepareForRequest(Psr\Http\Message\ServerRequestInterface $request): void

Prepares the application state for a new PSR-7 request.

Parameters

Parameter	Type	Description
`$request`	`Psr\Http\Message\ServerRequestInterface`	Request to bind to the Yii adapter.

Throws

yii\base\InvalidConfigException: when application configuration is invalid.

reinitializeApplication()

protected function reinitializeApplication(): void

Reinitializes the application instance for the current request.

Throws

yii\base\InvalidConfigException: when application configuration is invalid.

resetRequestState()

protected function resetRequestState(): void

Resets route and action resolution state.

resetUploadedFilesState()

protected function resetUploadedFilesState(): void

Resets uploaded file static state for the current request.

syncCookieValidationState()

protected function syncCookieValidationState(): void

Synchronizes cookie validation settings between request and response.

syncSessionIdFromRequestCookies()

protected function syncSessionIdFromRequestCookies(): void

Isolates PHP session state for the current request without opening the session.

Runs for every request, regardless of $useSession: closes a session left active by a previous request and applies the session ID from the request cookie, or an empty ID when the request carries no session cookie, so a later session_start() resumes the current visitor’s session or creates a new one. Request cookies are read only when the session cookie is present. A malformed cookie value (not a string, or not accepted by PHP as a session ID) is discarded and an empty ID is applied instead, so the session starts with a new ID.

terminate()

protected function terminate(yii2\extensions\psrbridge\http\Response $response): Psr\Http\Message\ResponseInterface

Converts the Yii response to PSR-7 and stores it for deferred after-send finalization.

Runs the pre-send conversion only. After-send finalization, event cleanup, and logger flushing are deferred to finalize(), which the runtime calls once the PSR-7 response has been emitted.

Parameters

Parameter	Type	Description
`$response`	`Response`	Yii response to convert.

Returns

Psr\Http\Message\ResponseInterface: PSR-7 response produced by the conversion.

Throws

yii\base\InvalidConfigException: when configuration is invalid.
yii\di\NotInstantiableException: when a service cannot be instantiated.