Class yii\web\Application

所有类 | 属性 | 方法 | 事件 | 常量

继承	yii\web\Application » yii\base\Application » yii\base\Module » yii\di\ServiceLocator » yii\base\Component » yii\base\BaseObject
实现	yii\base\Configurable
可用版本自	2.0
源码	https://github.com/yiichina/yii2/blob/api/framework/web/Application.php

Application 是所有 Web 应用程序类的基类。

关于 Application 的更多使用参考，请查看应用主体指南。

公共属性

隐藏继承的属性

属性	类型	描述	被定义在
$aliases	array	List of path aliases to be defined.	yii\base\Module
$assetManager	yii\web\AssetManager	The asset manager application component.	yii\base\Application
$authManager	yii\rbac\ManagerInterface	The auth manager application component.	yii\base\Application
$basePath	string	The root directory of the module.	yii\base\Module
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$bootstrap	array	List of components that should be run during the application bootstrapping process.	yii\base\Application
$cache	yii\caching\CacheInterface	The cache application component.	yii\base\Application
$catchAll	array	配置：指定控制器来处理所有的用户请求。这主要在应用程序处于维护模式时使用，通过一个控制器动作来处理所有传入的请求。此配置是一个数组，其第一个元素指定控制器动作的路径。其余的数组元素（键值对）指定此动作要绑定的参数例如， `php [ 'offline/notice', 'param1' => 'value1', 'param2' => 'value2', ] ` 默认为 null，表示不使用 catch-all 功能。	yii\web\Application
$charset	string	The charset currently used for the application.	yii\base\Application
$components	array	The 组件定义列表或加载的组件实例（ID => definition or instance）。	yii\di\ServiceLocator
$container	array	Values given in terms of name-value pairs	yii\base\Application
$controller	yii\web\Controller	当前活动的控制器实例	yii\web\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
$controllerPath	string	The directory that contains the controller classes.	yii\base\Module
$db	yii\db\Connection	The database connection.	yii\base\Application
$defaultRoute	string	此 Application 的默认路由。默认为 'site'.	yii\web\Application
$errorHandler	yii\web\ErrorHandler	错误处理组件。	yii\web\Application
$extensions	array	List of installed Yii extensions.	yii\base\Application
$formatter	yii\i18n\Formatter	The formatter application component.	yii\base\Application
$homeUrl	string	返回主页的 URL	yii\web\Application
$i18n	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.	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
$layoutPath	string	The root directory of layout files.	yii\base\Module
$loadedModules	array	List of loaded modules indexed by their class names.	yii\base\Application
$log	yii\log\Dispatcher	The log dispatcher application component.	yii\base\Application
$mailer	yii\mail\MailerInterface	The mailer application component.	yii\base\Application
$module	yii\base\Module	The parent module of this module.	yii\base\Module
$modules	array	The modules (indexed by their IDs).	yii\base\Module
$name	string	The application name.	yii\base\Application
$params	array	Custom module parameters (name => value).	yii\base\Module
$request	yii\web\Request	请求组件。	yii\web\Application
$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
$response	yii\web\Response	响应组件。	yii\web\Application
$runtimePath	string	The directory that stores runtime files.	yii\base\Application
$security	yii\base\Security	The security application component.	yii\base\Application
$session	yii\web\Session	会话组件。	yii\web\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
$timeZone	string	The time zone used by this application.	yii\base\Application
$uniqueId	string	The unique ID of the module.	yii\base\Application
$urlManager	yii\web\UrlManager	The URL manager for this application.	yii\base\Application
$user	yii\web\User	用户组件。	yii\web\Application
$vendorPath	string	The directory that stores vendor files.	yii\base\Application
$version	string	The version of this module.	yii\base\Module
$view	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

公共方法

隐藏继承的方法

方法	描述	被定义在
__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
__construct()	Constructor.	yii\base\Application
__get()	Getter 魔术方法。重写此方法以支持访问诸如读取属性之类的组件。	yii\di\ServiceLocator
__isset()	检查属性值是否为 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()	Returns the fully qualified name of this class.	yii\base\BaseObject
clear()	从定位器移除组件。	yii\di\ServiceLocator
coreComponents()	Returns the configuration of core application components.	yii\web\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
get()	返回具有指定 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()	返回组件定义列表或已加载的组件实例。	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()	返回错误处理组件。	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()	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()	返回请求组件。	yii\web\Application
getResponse()	返回响应组件。	yii\web\Application
getRuntimePath()	Returns the directory that stores runtime files.	yii\base\Application
getSecurity()	Returns the security component.	yii\base\Application
getSession()	返回会话组件。	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()	返回用户组件。	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
handleRequest()	处理特定的请求。	yii\web\Application
has()	返回一个值，该值表示定位器是否具有指定的组件定义或是否已实例化该组件。此方法根据 `$checkInstance` 的值返回不同的结果。	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()	Initializes the module.	yii\base\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()	用定位器注册一个组件。	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()	在定位器中注册一组组件定义。	yii\di\ServiceLocator
setContainer()	Configures Yii::$container with the $config.	yii\base\Application
setHomeUrl()		yii\web\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
trigger()	Triggers an event.	yii\base\Component

受保护的方法

隐藏继承的方法

方法	描述	被定义在
bootstrap()	Initializes extensions and executes bootstrap components.	yii\web\Application
defaultVersion()	Returns default module version.	yii\base\Module
registerErrorHandler()	Registers the errorHandler component as a PHP error handler.	yii\base\Application

Events

隐藏继承的事件

事件	类型	描述	被定义在
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

常量

隐藏继承的常量

常量	值	描述	被定义在
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

属性详情

$catchAll 公共属性

配置：指定控制器来处理所有的用户请求。这主要在应用程序处于维护模式时使用，通过一个控制器动作来处理所有传入的请求。此配置是一个数组，其第一个元素指定控制器动作的路径。其余的数组元素（键值对）指定此动作要绑定的参数例如，

[
    'offline/notice',
    'param1' => 'value1',
    'param2' => 'value2',
]

默认为 null，表示不使用 catch-all 功能。

public array $catchAll = null

$controller 公共属性

当前活动的控制器实例

public yii\web\Controller $controller = null

$defaultRoute 公共属性

此 Application 的默认路由。默认为 'site'.

public string $defaultRoute = 'site'

$errorHandler 公共只读属性

错误处理组件。

public yii\web\ErrorHandler getErrorHandler ( )

$homeUrl 公共属性

返回主页的 URL

public string getHomeUrl ( )
public void setHomeUrl ( $value )

$request 公共只读属性

请求组件。

public yii\web\Request getRequest ( )

$response 公共只读属性

响应组件。

public yii\web\Response getResponse ( )

$session 公共只读属性

会话组件。

public yii\web\Session getSession ( )

$user 公共只读属性

用户组件。

public yii\web\User getUser ( )

方法详情

bootstrap() 受保护方法

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() 公共方法

Returns the configuration of core application components.

public void coreComponents()

getErrorHandler() 公共方法

返回错误处理组件。

public yii\web\ErrorHandler getErrorHandler()
return	yii\web\ErrorHandler	错误处理组件。

getHomeUrl() 公共方法

public string getHomeUrl()
return	string	返回主页的 URL

getRequest() 公共方法

返回请求组件。

public yii\web\Request getRequest()
return	yii\web\Request	请求组件。

getResponse() 公共方法

返回响应组件。

public yii\web\Response getResponse()
return	yii\web\Response	响应组件。

getSession() 公共方法

返回会话组件。

public yii\web\Session getSession()
return	yii\web\Session	会话组件。

getUser() 公共方法

返回用户组件。

public yii\web\User getUser()
return	yii\web\User	用户组件。

handleRequest() 公共方法

处理特定的请求。

public yii\web\Response handleRequest($request)
$request	yii\web\Request	处理的请求
return	yii\web\Response	生成的响应
throws	yii\web\NotFoundHttpException	如果请求的路由无效

setHomeUrl() 公共方法

public void setHomeUrl($value)
$value	string	设置的主页 URL