Abstract Class yii\base\Application

All Classes | Properties | Methods | Events | Constants
Inheritanceyii\base\Application » yii\base\Module » yii\di\ServiceLocator
Subclassesyii\console\Application
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/base/Application.php

Application is the base class for all application classes.

For more details and usage information on Application, see the guide article on applications.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$bootstrap array List of components that should be run during the application bootstrapping process. yii\base\Application
$charset string The charset currently used for the application. yii\base\Application
$controller yii\base\Controller The currently active controller instance yii\base\Application
$controllerMap array Mapping from controller ID to controller configurations. yii\base\Module
$controllerNamespace string The namespace that controller classes are located in. yii\base\Application
$defaultRoute string The default route of this module. yii\base\Module
$extensions array List of installed Yii extensions. yii\base\Application
$id string An ID that uniquely identifies this module among other modules which have the same parent. yii\base\Module
$language string The language that is meant to be used for end users. yii\base\Application
$layout string|boolean The layout that should be applied for views in this application. yii\base\Application
$loadedModules array List of loaded modules indexed by their class names. yii\base\Application
$module yii\base\Module The parent module of this module. yii\base\Module
$name string The application name. yii\base\Application
$params array Custom module parameters (name => value). yii\base\Module
$requestedAction yii\base\Action The requested Action. yii\base\Application
$requestedParams array The parameters supplied to the requested action. yii\base\Application
$requestedRoute string The requested route yii\base\Application
$sourceLanguage string The language that the application is written in. yii\base\Application
$state integer The current application state during a request handling life cycle. yii\base\Application

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Constructor. yii\base\Application
afterAction() This method is invoked right after an action within this module is executed. yii\base\Module
beforeAction() This method is invoked right before an action within this module is executed. yii\base\Module
coreComponents() Returns the configuration of core application components. yii\base\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
end() Terminates the application. yii\base\Application
get() 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
getCache() Returns the cache component. yii\base\Application
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\base\Application
getFormatter() Returns the formatter component. yii\base\Application
getI18n() Returns the internationalization (i18n) component. yii\base\Application
getInstance() 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
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\base\Application
getResponse() Returns the response component. yii\base\Application
getRuntimePath() Returns the directory that stores runtime files. yii\base\Application
getSecurity() Returns the security component. yii\base\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
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
handleRequest() Handles the specified request. yii\base\Application
has() yii\base\Module
hasModule() Checks whether the child module of the specified ID exists. yii\base\Module
init() Initializes the module. yii\base\Application
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
setAliases() Defines path aliases. yii\base\Module
setBasePath() Sets the root directory of the application and the @app alias. yii\base\Application
setContainer() Configures \Yii::$container with the $config. yii\base\Application
setInstance() Sets the currently requested instance of this module class. yii\base\Module
setLayoutPath() Sets the directory that contains the layout files. yii\base\Module
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

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
bootstrap() Initializes extensions and executes bootstrap components. yii\base\Application
defaultVersion() Returns default module version. yii\base\Module
registerErrorHandler() Registers the errorHandler component as a PHP error handler. yii\base\Application

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_ACTION yii\base\ActionEvent An event raised after executing a controller action. yii\base\Module
EVENT_AFTER_REQUEST yii\base\Event An event raised after the application successfully handles a request (before the response is sent out). yii\base\Application
EVENT_BEFORE_ACTION yii\base\ActionEvent An event raised before executing a controller action. yii\base\Module
EVENT_BEFORE_REQUEST yii\base\Event An event raised before the application starts to handle a request. yii\base\Application

Constants

Hide inherited constants

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

Property Details

$bootstrap public property

List of components that should be run during the application bootstrapping process.

Each component may be specified in one of the following formats:

  • an application component ID as specified via \yii\base\components.
  • a module ID as specified via \yii\base\modules.
  • a class name.
  • a configuration array.
  • a Closure

During the bootstrapping process, each component will be instantiated. If the component class implements yii\base\BootstrapInterface, its bootstrap() method will be also be called.

public array $bootstrap = []
$charset public property

The charset currently used for the application.

public string $charset = 'UTF-8'
$controller public property

The currently active controller instance

public yii\base\Controller $controller = null
$controllerNamespace public property

The namespace that controller classes are located in. This namespace will be used to load controller classes by prepending it to the controller class name. The default namespace is app\controllers.

Please refer to the guide about class autoloading for more details.

public string $controllerNamespace = 'app\\controllers'
$extensions public property

List of installed Yii extensions. Each array element represents a single extension with the following structure:

[
    'name' => 'extension name',
    'version' => 'version number',
    'bootstrap' => 'BootstrapClassName',  // optional, may also be a configuration array
    'alias' => [
        '@alias1' => 'to/path1',
        '@alias2' => 'to/path2',
    ],
]

The "bootstrap" class listed above will be instantiated during the application bootstrapping process. If the class implements yii\base\BootstrapInterface, its bootstrap() method will be also be called.

If not set explicitly in the application config, this property will be populated with the contents of @vendor/yiisoft/extensions.php.

public array $extensions = null
$language public property

The language that is meant to be used for end users. It is recommended that you use IETF language tags. For example, en stands for English, while en-US stands for English (United States).

See also $sourceLanguage.

public string $language = 'en-US'
$layout public property

The layout that should be applied for views in this application. Defaults to 'main'. If this is false, layout will be disabled.

public string|boolean $layout = 'main'
$loadedModules public property

List of loaded modules indexed by their class names.

public array $loadedModules = []
$name public property

The application name.

public string $name = 'My Application'
$requestedAction public property

The requested Action. If null, it means the request cannot be resolved into an action.

public yii\base\Action $requestedAction = null
$requestedParams public property

The parameters supplied to the requested action.

public array $requestedParams = null
$requestedRoute public property

The requested route

public string $requestedRoute = null
$sourceLanguage public property

The language that the application is written in. This mainly refers to the language that the messages and view files are written in.

See also $language.

public string $sourceLanguage = 'en-US'
$state public property

The current application state during a request handling life cycle. This property is managed by the application. Do not modify this property.

public integer $state = null

Method Details

__construct() public method

Constructor.

public void __construct ( $config = [] )
$config array

Name-value pairs that will be used to initialize the object properties. Note that the configuration must contain both $id and \yii\base\basePath.
throws yii\base\InvalidConfigException

if either $id or \yii\base\basePath configuration is missing.
bootstrap() protected method

Initializes extensions and executes bootstrap components.

This method is called by init() after the application has been fully configured. If you override this method, make sure you also call the parent implementation.

protected void bootstrap ( )
coreComponents() public method

Returns the configuration of core application components.

See also \yii\base\set().

public void coreComponents ( )
end() public method

Terminates the application.

This method replaces the exit() function by ensuring the application life cycle is completed before terminating the application.

public void end ( $status = 0, $response = null )
$status integer

The exit status (value 0 means normal exit while other values mean abnormal exit).
$response yii\base\Response

The response to be sent. If not set, the default application \yii\base\response component will be used.
throws yii\base\ExitException

if the application is in testing mode
getAssetManager() public method

Returns the asset manager.

public \yii\web\AssetManager getAssetManager ( )
return \yii\web\AssetManager

The asset manager application component.
getAuthManager() public method

Returns the auth manager for this application.

public \yii\rbac\ManagerInterface getAuthManager ( )
return \yii\rbac\ManagerInterface

The auth manager application component. Null is returned if auth manager is not configured.
getCache() public method

Returns the cache component.

public \yii\caching\CacheInterface getCache ( )
return \yii\caching\CacheInterface

The cache application component. Null if the component is not enabled.
getDb() public method

Returns the database connection component.

public yii\db\Connection getDb ( )
return yii\db\Connection

The database connection.
getErrorHandler() public method

Returns the error handler component.

public \yii\web\ErrorHandler|yii\console\ErrorHandler getErrorHandler ( )
return \yii\web\ErrorHandler|yii\console\ErrorHandler

The error handler application component.
getFormatter() public method

Returns the formatter component.

public \yii\i18n\Formatter getFormatter ( )
return \yii\i18n\Formatter

The formatter application component.
getI18n() public method

Returns the internationalization (i18n) component.

public \yii\i18n\I18N getI18n ( )
return \yii\i18n\I18N

The internationalization application component.
getLog() public method

Returns the log dispatcher component.

public \yii\log\Dispatcher getLog ( )
return \yii\log\Dispatcher

The log dispatcher application component.
getMailer() public method

Returns the mailer component.

public \yii\mail\MailerInterface getMailer ( )
return \yii\mail\MailerInterface

The mailer application component.
getRequest() public method

Returns the request component.

public \yii\web\Request|yii\console\Request getRequest ( )
return \yii\web\Request|yii\console\Request

The request component.
getResponse() public method

Returns the response component.

public \yii\web\Response|yii\console\Response getResponse ( )
return \yii\web\Response|yii\console\Response

The response component.
getRuntimePath() public method

Returns the directory that stores runtime files.

public string getRuntimePath ( )
return string

The directory that stores runtime files. Defaults to the "runtime" subdirectory under \yii\base\basePath.
getSecurity() public method

Returns the security component.

public yii\base\Security getSecurity ( )
return yii\base\Security

The security application component.
getTimeZone() public method

Returns the time zone used by this application.

This is a simple wrapper of PHP function date_default_timezone_get(). If time zone is not configured in php.ini or application config, it will be set to UTC by default.

See also https://secure.php.net/manual/en/function.date-default-timezone-get.php.

public string getTimeZone ( )
return string

The time zone used by this application.
getUniqueId() public method

Returns an ID that uniquely identifies this module among all modules within the current application.

Since this is an application instance, it will always return an empty string.

public string getUniqueId ( )
return string

The unique ID of the module.
getUrlManager() public method

Returns the URL manager for this application.

public \yii\web\UrlManager getUrlManager ( )
return \yii\web\UrlManager

The URL manager for this application.
getVendorPath() public method

Returns the directory that stores vendor files.

public string getVendorPath ( )
return string

The directory that stores vendor files. Defaults to "vendor" directory under \yii\base\basePath.
getView() public method

Returns the view object.

public yii\base\View|\yii\web\View getView ( )
return yii\base\View|\yii\web\View

The view application component that is used to render various view files.
handleRequest() public abstract method

Handles the specified request.

This method should return an instance of yii\base\Response or its child class which represents the handling result of the request.

public abstract yii\base\Response handleRequest ( $request )
$request yii\base\Request

The request to be handled
return yii\base\Response

The resulting response
init() public method

Initializes the module.

This method is called after the module is created and initialized with property values given in configuration. The default implementation will initialize $controllerNamespace if it is not set.

If you override this method, please make sure you call the parent implementation.

public void init ( )
preInit() public method

Pre-initializes the application.

This method is called at the beginning of the application constructor. It initializes several important application properties. If you override this method, please make sure you call the parent implementation.

public void preInit ( &$config )
$config array

The application configuration
throws yii\base\InvalidConfigException

if either $id or \yii\base\basePath configuration is missing.
registerErrorHandler() protected method

Registers the errorHandler component as a PHP error handler.

protected void registerErrorHandler ( &$config )
$config array

Application config
run() public method

Runs the application.

This is the main entrance of an application.

public integer run ( )
return integer

The exit status (0 means normal, non-zero values mean abnormal)
setBasePath() public method

Sets the root directory of the application and the @app alias.

This method can only be invoked at the beginning of the constructor.

public void setBasePath ( $path )
$path string

The root directory of the application.
throws yii\base\InvalidArgumentException

if the directory does not exist.
setContainer() public method (available since version 2.0.11)

Configures \Yii::$container with the $config.

public void setContainer ( $config )
$config array

Values given in terms of name-value pairs
setRuntimePath() public method

Sets the directory that stores runtime files.

public void setRuntimePath ( $path )
$path string

The directory that stores runtime files.
setTimeZone() public method

Sets the time zone used by this application.

This is a simple wrapper of PHP function date_default_timezone_set(). Refer to the php manual for available timezones.

See also https://secure.php.net/manual/en/function.date-default-timezone-set.php.

public void setTimeZone ( $value )
$value string

The time zone used by this application.
setVendorPath() public method

Sets the directory that stores vendor files.

public void setVendorPath ( $path )
$path string

The directory that stores vendor files.

Event Details

EVENT_AFTER_REQUEST event of type yii\base\Event

An event raised after the application successfully handles a request (before the response is sent out).

EVENT_BEFORE_REQUEST event of type yii\base\Event

An event raised before the application starts to handle a request.