Skip to content

Y
yii2
Commit 332cd72d by Qiang Xue
Options

added anchors [skip ci]

parent 9840bdd3
Showing with 36 additions and 36 deletions
docs/guide/structure-applications.md
...@@ -13,7 +13,7 @@ There are two types of applications: [[yii\web\Application|Web applications]] an ...@@ -13,7 +13,7 @@ There are two types of applications: [[yii\web\Application|Web applications]] an
Web requests while the latter console command requests. Web requests while the latter console command requests.
## Application Configurations ## Application Configurations <a name="application-configurations"></a>
When an [entry script](structure-entry-scripts.md) creates an application, it will load When an [entry script](structure-entry-scripts.md) creates an application, it will load
a [configuration](concept-configurations.md) and apply it to the application, like the following: a [configuration](concept-configurations.md) and apply it to the application, like the following:
...@@ -35,7 +35,7 @@ very complex, they usually are kept in [configuration files](concept-configurati ...@@ -35,7 +35,7 @@ very complex, they usually are kept in [configuration files](concept-configurati
like the `web.php` file in the above example. like the `web.php` file in the above example.
## Application Properties ## Application Properties <a name="application-properties"></a>
There are many important application properties that you should configure in application configurations. There are many important application properties that you should configure in application configurations.
These properties typically describe the environment that applications are running in. These properties typically describe the environment that applications are running in.
...@@ -43,20 +43,20 @@ For example, applications need to know how to load [controllers](structure-contr ...@@ -43,20 +43,20 @@ For example, applications need to know how to load [controllers](structure-contr
where to store temporary files, etc. In the following, we will summarize these properties. where to store temporary files, etc. In the following, we will summarize these properties.
### Required Properties ### Required Properties <a name="required-properties"></a>
In any application, you should at least configure two properties: [[yii\base\Application::id|id]] In any application, you should at least configure two properties: [[yii\base\Application::id|id]]
and [[yii\base\Application::basePath|basePath]]. and [[yii\base\Application::basePath|basePath]].
#### [[yii\base\Application::id|id]] #### [[yii\base\Application::id|id]] <a name="id"></a>
The [[yii\base\Application::id|id]] property specifies a unique ID that differentiates an application The [[yii\base\Application::id|id]] property specifies a unique ID that differentiates an application
from others. It is mainly used programmatically. Although not a requirement, for best interoperability from others. It is mainly used programmatically. Although not a requirement, for best interoperability
it is recommended that you use alphanumeric characters only when specifying an application ID. it is recommended that you use alphanumeric characters only when specifying an application ID.
#### [[yii\base\Application::basePath|basePath]] #### [[yii\base\Application::basePath|basePath]] <a name="basePath"></a>
The [[yii\base\Application::basePath|basePath]] property specifies the root directory of an application. The [[yii\base\Application::basePath|basePath]] property specifies the root directory of an application.
It is the directory that contains all protected source code of an application system. Under this directory, It is the directory that contains all protected source code of an application system. Under this directory,
...@@ -72,13 +72,13 @@ paths (e.g. the runtime path). For this reason, a path alias named `@app` is pre ...@@ -72,13 +72,13 @@ paths (e.g. the runtime path). For this reason, a path alias named `@app` is pre
path. Derived paths may then be formed using this alias (e.g. `@app/runtime` to refer to the runtime directory). path. Derived paths may then be formed using this alias (e.g. `@app/runtime` to refer to the runtime directory).
### Important Properties ### Important Properties <a name="important-properties"></a>
The properties described in this subsection often need to be configured because they differ across The properties described in this subsection often need to be configured because they differ across
different applications. different applications.
#### [[yii\base\Application::aliases|aliases]] #### [[yii\base\Application::aliases|aliases]] <a name="aliases"></a>
This property allows you to define a set of [aliases](concept-aliases.md) in terms of an array. This property allows you to define a set of [aliases](concept-aliases.md) in terms of an array.
The array keys are alias names, and the array values are the corresponding path definitions. The array keys are alias names, and the array values are the corresponding path definitions.
...@@ -97,7 +97,7 @@ This property is provided such that you can define aliases in terms of applicati ...@@ -97,7 +97,7 @@ This property is provided such that you can define aliases in terms of applicati
the method calls [[Yii::setAlias()]]. the method calls [[Yii::setAlias()]].
#### [[yii\base\Application::bootstrap|bootstrap]] #### [[yii\base\Application::bootstrap|bootstrap]] <a name="bootstrap"></a>
This is a very useful property. It allows you to specify an array of components that should This is a very useful property. It allows you to specify an array of components that should
be run during the application [[yii\base\Application::bootstrap()|bootstrapping process]]. be run during the application [[yii\base\Application::bootstrap()|bootstrapping process]].
...@@ -154,7 +154,7 @@ if (YII_ENV_DEV) { ...@@ -154,7 +154,7 @@ if (YII_ENV_DEV) {
for each request, the same set of components need to be run. So use bootstrap components judiciously. for each request, the same set of components need to be run. So use bootstrap components judiciously.
#### [[yii\web\Application::catchAll|catchAll]] #### [[yii\web\Application::catchAll|catchAll]] <a name="catchAll"></a>
This property is supported by [[yii\web\Application|Web applications]] only. It specifies This property is supported by [[yii\web\Application|Web applications]] only. It specifies
a [controller action](structure-controllers.md) which should handle all user requests. This is mainly a [controller action](structure-controllers.md) which should handle all user requests. This is mainly
...@@ -174,7 +174,7 @@ The rest of the array elements (key-value pairs) specify the parameters to be bo ...@@ -174,7 +174,7 @@ The rest of the array elements (key-value pairs) specify the parameters to be bo
``` ```
#### [[yii\base\Application::components|components]] #### [[yii\base\Application::components|components]] <a name="components"></a>
This is the single most important property. It allows you to register a list of named components This is the single most important property. It allows you to register a list of named components
called [application components](#application-components) that you can use in other places. For example, called [application components](#application-components) that you can use in other places. For example,
...@@ -202,7 +202,7 @@ using the expression `\Yii::$app->ComponentID`. ...@@ -202,7 +202,7 @@ using the expression `\Yii::$app->ComponentID`.
Please read the [application components](#application-components) section for details. Please read the [application components](#application-components) section for details.
#### [[yii\base\Application::controllerMap|controllerMap]] #### [[yii\base\Application::controllerMap|controllerMap]] <a name="controllerMap"></a>
This property allows you to map a controller ID to an arbitrary controller class. By default, Yii maps This property allows you to map a controller ID to an arbitrary controller class. By default, Yii maps
controller IDs to controller classes based on a [convention](#controllerNamespace) (e.g. the ID `post` would be mapped controller IDs to controller classes based on a [convention](#controllerNamespace) (e.g. the ID `post` would be mapped
...@@ -228,7 +228,7 @@ The array keys of this property represent the controller IDs, while the array va ...@@ -228,7 +228,7 @@ The array keys of this property represent the controller IDs, while the array va
controller class names or [configurations](concept-configurations.md). controller class names or [configurations](concept-configurations.md).
#### [[yii\base\Application::controllerNamespace|controllerNamespace]] #### [[yii\base\Application::controllerNamespace|controllerNamespace]] <a name="controllerNamespace"></a>
This property specifies the default namespace under which controller classes should be located. It defaults to This property specifies the default namespace under which controller classes should be located. It defaults to
`app\controllers`. If a controller ID is `post`, by convention the corresponding controller class name (without `app\controllers`. If a controller ID is `post`, by convention the corresponding controller class name (without
...@@ -246,7 +246,7 @@ In case you want to break the convention as described above, you may configure t ...@@ -246,7 +246,7 @@ In case you want to break the convention as described above, you may configure t
property. property.
#### [[yii\base\Application::language|language]] #### [[yii\base\Application::language|language]] <a name="language"></a>
This property specifies the language in which the application should display content to end users. This property specifies the language in which the application should display content to end users.
The default value of this property is `en`, meaning English. You should configure this property The default value of this property is `en`, meaning English. You should configure this property
...@@ -263,7 +263,7 @@ For example, `en` stands for English, while `en-US` stands for English (United S ...@@ -263,7 +263,7 @@ For example, `en` stands for English, while `en-US` stands for English (United S
More details about this property can be found in the [Internationalization](tutorial-i18n.md) section. More details about this property can be found in the [Internationalization](tutorial-i18n.md) section.
#### [[yii\base\Application::modules|modules]] #### [[yii\base\Application::modules|modules]] <a name="modules"></a>
This property specifies the [modules](structure-modules.md) that the application contains. This property specifies the [modules](structure-modules.md) that the application contains.
...@@ -288,7 +288,7 @@ being the module IDs. For example, ...@@ -288,7 +288,7 @@ being the module IDs. For example,
Please refer to the [Modules](structure-modules.md) section for more details. Please refer to the [Modules](structure-modules.md) section for more details.
#### [[yii\base\Application::name|name]] #### [[yii\base\Application::name|name]] <a name="name"></a>
This property specifies the application name that may be displayed to end users. Unlike the This property specifies the application name that may be displayed to end users. Unlike the
[[yii\base\Application::id|id]] property which should take a unique value, the value of this property is mainly for [[yii\base\Application::id|id]] property which should take a unique value, the value of this property is mainly for
...@@ -297,7 +297,7 @@ display purpose and does not need to be unique. ...@@ -297,7 +297,7 @@ display purpose and does not need to be unique.
You do not always need to configure this property if none of your code is using it. You do not always need to configure this property if none of your code is using it.
#### [[yii\base\Application::params|params]] #### [[yii\base\Application::params|params]] <a name="params"></a>
This property specifies an array of globally accessible application parameters. Instead of using hardcoded This property specifies an array of globally accessible application parameters. Instead of using hardcoded
numbers and strings everywhere in your code, it is a good practice to define them as application parameters numbers and strings everywhere in your code, it is a good practice to define them as application parameters
...@@ -323,7 +323,7 @@ Later if you decide to change the thumbnail size, you only need to modify it in ...@@ -323,7 +323,7 @@ Later if you decide to change the thumbnail size, you only need to modify it in
without touching any dependent code. without touching any dependent code.
#### [[yii\base\Application::sourceLanguage|sourceLanguage]] #### [[yii\base\Application::sourceLanguage|sourceLanguage]] <a name="sourceLanguage"></a>
This property specifies the language that the application code is written in. The default value is `'en'`, This property specifies the language that the application code is written in. The default value is `'en'`,
meaning English. You should configure this property if the text content in your code is not in English. meaning English. You should configure this property if the text content in your code is not in English.
...@@ -335,7 +335,7 @@ while `en-US` stands for English (United States). ...@@ -335,7 +335,7 @@ while `en-US` stands for English (United States).
More details about this property can be found in the [Internationalization](tutorial-i18n.md) section. More details about this property can be found in the [Internationalization](tutorial-i18n.md) section.
#### [[yii\base\Application::timeZone|timeZone]] #### [[yii\base\Application::timeZone|timeZone]] <a name="timeZone"></a>
This property is provided as an alternative way of setting the default time zone of PHP runtime. This property is provided as an alternative way of setting the default time zone of PHP runtime.
By configuring this property, you are essentially calling the PHP function By configuring this property, you are essentially calling the PHP function
...@@ -348,25 +348,25 @@ By configuring this property, you are essentially calling the PHP function ...@@ -348,25 +348,25 @@ By configuring this property, you are essentially calling the PHP function
``` ```
#### [[yii\base\Application::version|version]] #### [[yii\base\Application::version|version]] <a name="version"></a>
This property specifies the version of the application. It defaults to `'1.0'`. You do not always need to configure This property specifies the version of the application. It defaults to `'1.0'`. You do not always need to configure
this property if none of your code is using it. this property if none of your code is using it.
### Useful Properties ### Useful Properties <a name="useful-properties"></a>
The properties described in this subsection are not commonly configured because their default values The properties described in this subsection are not commonly configured because their default values
stipulate common conventions. However, you may still configure them in case you want to break the conventions. stipulate common conventions. However, you may still configure them in case you want to break the conventions.
#### [[yii\base\Application::charset|charset]] #### [[yii\base\Application::charset|charset]] <a name="charset"></a>
This property specifies the charset that the application uses. The default value is `'UTF-8'` which should This property specifies the charset that the application uses. The default value is `'UTF-8'` which should
be kept as is for most applications unless you are working with some legacy systems that use a lot of non-unicode data. be kept as is for most applications unless you are working with some legacy systems that use a lot of non-unicode data.
#### [[yii\base\Application::defaultRoute|defaultRoute]] #### [[yii\base\Application::defaultRoute|defaultRoute]] <a name="defaultRoute"></a>
This property specifies the [route](runtime-routing.md) that an application should use when a request This property specifies the [route](runtime-routing.md) that an application should use when a request
does not specify one. The route may consist of child module ID, controller ID, and/or action ID. does not specify one. The route may consist of child module ID, controller ID, and/or action ID.
...@@ -382,7 +382,7 @@ For [yii\console\Application|console applications], the default value is `'help' ...@@ -382,7 +382,7 @@ For [yii\console\Application|console applications], the default value is `'help'
without providing any arguments, it will display the help information. without providing any arguments, it will display the help information.
#### [[yii\base\Application::extensions|extensions]] #### [[yii\base\Application::extensions|extensions]] <a name="extensions"></a>
This property specifies the list of [extensions](structure-extensions.md) that are installed and used by the application. This property specifies the list of [extensions](structure-extensions.md) that are installed and used by the application.
By default, it will take the array returned by the file `@vendor/yiisoft/extensions.php`. The `extensions.php` file By default, it will take the array returned by the file `@vendor/yiisoft/extensions.php`. The `extensions.php` file
...@@ -416,7 +416,7 @@ property, a `bootstrap` element may be specified with a bootstrap class name or ...@@ -416,7 +416,7 @@ property, a `bootstrap` element may be specified with a bootstrap class name or
array. An extension may also define a few [aliases](concept-aliases.md). array. An extension may also define a few [aliases](concept-aliases.md).
#### [[yii\base\Application::layout|layout]] #### [[yii\base\Application::layout|layout]] <a name="layout"></a>
This property specifies the name of the default layout that should be used when rendering a [view](structure-views.md). This property specifies the name of the default layout that should be used when rendering a [view](structure-views.md).
The default value is `'main'`, meaning the layout file `main.php` under the [layout path](#layoutPath) should be used. The default value is `'main'`, meaning the layout file `main.php` under the [layout path](#layoutPath) should be used.
...@@ -426,7 +426,7 @@ the default layout file can be represented as the path alias `@app/views/layouts ...@@ -426,7 +426,7 @@ the default layout file can be represented as the path alias `@app/views/layouts
You may configure this property to be `false` if you want to disable layout by default, although this is very rare. You may configure this property to be `false` if you want to disable layout by default, although this is very rare.
#### [[yii\base\Application::layoutPath|layoutPath]] #### [[yii\base\Application::layoutPath|layoutPath]] <a name="layoutPath"></a>
This property specifies the path where layout files should be looked for. The default value is This property specifies the path where layout files should be looked for. The default value is
the `layouts` sub-directory under the [view path](#viewPath). If the [view path](#viewPath) is taking the `layouts` sub-directory under the [view path](#viewPath). If the [view path](#viewPath) is taking
...@@ -435,7 +435,7 @@ its default value, the default layout path can be represented as the path alias ...@@ -435,7 +435,7 @@ its default value, the default layout path can be represented as the path alias
You may configure it as a directory or a path [alias](concept-aliases.md). You may configure it as a directory or a path [alias](concept-aliases.md).
#### [[yii\base\Application::runtimePath|runtimePath]] #### [[yii\base\Application::runtimePath|runtimePath]] <a name="runtimePath"></a>
This property specifies the path where temporary files, such as log files, cache files, can be generated. This property specifies the path where temporary files, such as log files, cache files, can be generated.
The default value is the directory represented by the alias `@app/runtime`. The default value is the directory represented by the alias `@app/runtime`.
...@@ -447,13 +447,13 @@ by end users because the temporary files under it may contain sensitive informat ...@@ -447,13 +447,13 @@ by end users because the temporary files under it may contain sensitive informat
To simplify accessing to this path, Yii has predefined a path alias named `@runtime` for it. To simplify accessing to this path, Yii has predefined a path alias named `@runtime` for it.
#### [[yii\base\Application::viewPath|viewPath]] #### [[yii\base\Application::viewPath|viewPath]] <a name="viewPath"></a>
This property specifies the root directory where view files are located. The default value is the directory This property specifies the root directory where view files are located. The default value is the directory
represented by the alias `@app/views`. You may configure it as a directory or a path [alias](concept-aliases.md). represented by the alias `@app/views`. You may configure it as a directory or a path [alias](concept-aliases.md).
#### [[yii\base\Application::vendorPath|vendorPath]] #### [[yii\base\Application::vendorPath|vendorPath]] <a name="vendorPath"></a>
This property specifies the vendor directory managed by [Composer](http://getcomposer.org). It contains This property specifies the vendor directory managed by [Composer](http://getcomposer.org). It contains
all third party libraries used by your application, including the Yii framework. The default value is all third party libraries used by your application, including the Yii framework. The default value is
...@@ -465,13 +465,13 @@ this property, make sure you also adjust the Composer configuration accordingly. ...@@ -465,13 +465,13 @@ this property, make sure you also adjust the Composer configuration accordingly.
To simplify accessing to this path, Yii has predefined a path alias named `@vendor` for it. To simplify accessing to this path, Yii has predefined a path alias named `@vendor` for it.
#### [[yii\console\Application::enableCoreCommands|enableCoreCommands]] #### [[yii\console\Application::enableCoreCommands|enableCoreCommands]] <a name="enableCoreCommands"></a>
This property is supported by [[yii\console\Application|console applications]] only. It specifies This property is supported by [[yii\console\Application|console applications]] only. It specifies
whether the core commands included in the Yii release should be enabled. The default value is `true`. whether the core commands included in the Yii release should be enabled. The default value is `true`.
## Application Events ## Application Events <a name="application-events"></a>
An application triggers several events during the lifecycle of handling an request. You may attach event An application triggers several events during the lifecycle of handling an request. You may attach event
handlers to these events in application configurations like the following, handlers to these events in application configurations like the following,
...@@ -496,7 +496,7 @@ after the application instance is created. For example, ...@@ -496,7 +496,7 @@ after the application instance is created. For example,
}); });
``` ```
### [[yii\base\Application::EVENT_BEFORE_REQUEST|EVENT_BEFORE_REQUEST]] ### [[yii\base\Application::EVENT_BEFORE_REQUEST|EVENT_BEFORE_REQUEST]] <a name="beforeRequest"></a>
This event is triggered *before* an application handles a request. The actual event name is `beforeRequest`. This event is triggered *before* an application handles a request. The actual event name is `beforeRequest`.
...@@ -505,7 +505,7 @@ to insert your custom code via the event mechanism to intercept the request hand ...@@ -505,7 +505,7 @@ to insert your custom code via the event mechanism to intercept the request hand
in the event handler, you may dynamically set the [[yii\base\Application::language]] property based on some parameters. in the event handler, you may dynamically set the [[yii\base\Application::language]] property based on some parameters.
### [[yii\base\Application::EVENT_BEFORE_REQUEST|EVENT_AFTER_REQUEST]] ### [[yii\base\Application::EVENT_BEFORE_REQUEST|EVENT_AFTER_REQUEST]] <a name="afterRequest"></a>
This event is triggered *after* an application finishes handling a request but *before* sending the response. This event is triggered *after* an application finishes handling a request but *before* sending the response.
The actual event name is `afterRequest`. The actual event name is `afterRequest`.
...@@ -517,7 +517,7 @@ Note that the [[yii\web\Response|response]] component also triggers some events ...@@ -517,7 +517,7 @@ Note that the [[yii\web\Response|response]] component also triggers some events
response content to end users. Those events are triggered *after* this event. response content to end users. Those events are triggered *after* this event.
### [[yii\base\Application::EVENT_BEFORE_REQUEST|EVENT_BEFORE_ACTION]] ### [[yii\base\Application::EVENT_BEFORE_REQUEST|EVENT_BEFORE_ACTION]] <a name="beforeAction"></a>
This event is triggered *before* running every [controller action](structure-controllers.md). This event is triggered *before* running every [controller action](structure-controllers.md).
The actual event name is `beforeAction`. The actual event name is `beforeAction`.
...@@ -543,7 +543,7 @@ triggering this event, followed by modules (if any), and finally controllers. If ...@@ -543,7 +543,7 @@ triggering this event, followed by modules (if any), and finally controllers. If
sets [[yii\base\ActionEvent::isValid]] to be `false`, all the following events will NOT be triggered. sets [[yii\base\ActionEvent::isValid]] to be `false`, all the following events will NOT be triggered.
### [[yii\base\Application::EVENT_BEFORE_REQUEST|EVENT_AFTER_ACTION]] ### [[yii\base\Application::EVENT_BEFORE_REQUEST|EVENT_AFTER_ACTION]] <a name="afterAction"></a>
This event is triggered *after* running every [controller action](structure-controllers.md). This event is triggered *after* running every [controller action](structure-controllers.md).
The actual event name is `afterAction`. The actual event name is `afterAction`.
...@@ -569,7 +569,7 @@ as for that of `beforeAction`. That is, controllers are the first objects trigge ...@@ -569,7 +569,7 @@ as for that of `beforeAction`. That is, controllers are the first objects trigge
followed by modules (if any), and finally applications. followed by modules (if any), and finally applications.
## Application Components ## Application Components <a name="application-components"></a>
Applications are [service locators](concept-service-locators.md). They host a set of the so-called Applications are [service locators](concept-service-locators.md). They host a set of the so-called
*application components* that provide different services for processing requests. For example, *application components* that provide different services for processing requests. For example,
...@@ -629,7 +629,7 @@ if you do not specify its class, the default one will be used. ...@@ -629,7 +629,7 @@ if you do not specify its class, the default one will be used.
Please refer to the [Views](structure-views.md) section for more details. Please refer to the [Views](structure-views.md) section for more details.
## Application Lifecycle ## Application Lifecycle <a name="application-lifecycle"></a>
When an [entry script](structure-entry-scripts.md) is being executed to handle a request, When an [entry script](structure-entry-scripts.md) is being executed to handle a request,
an application will undergo the following lifecycle: an application will undergo the following lifecycle:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment