Browse Source

Update structure-views.md

tags/2.0.16
strive 7 years ago committed by GitHub
parent
commit
b2b0914871
  1. 154
      docs/guide-zh-CN/structure-views.md

154
docs/guide-zh-CN/structure-views.md

@ -2,15 +2,18 @@
=====
视图是 [MVC](http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller) 模式中的一部分。
它是展示数据到终端用户的代码,在网页应用中,根据*视图模板*来创建视图,视图模板为PHP脚本文件,
它是展示数据到终端用户的代码,在网页应用中,
根据*视图模板*来创建视图,视图模板为PHP脚本文件,
主要包含HTML代码和展示类PHP代码,通过[[yii\web\View|view]]应用组件来管理,
该组件主要提供通用方法帮助视图构造和渲染,简单起见,我们称视图模板或视图模板文件为视图。
该组件主要提供通用方法帮助视图构造和渲染,
简单起见,我们称视图模板或视图模板文件为视图。
## 创建视图 <span id="creating-views"></span>
如前所述,视图为包含HTML和PHP代码的PHP脚本,如下代码为一个登录表单的视图,
可看到PHP代码用来生成动态内容如页面标题和表单,HTML代码把它组织成一个漂亮的HTML页面。
可看到PHP代码用来生成动态内容如页面标题和表单,
HTML代码把它组织成一个漂亮的HTML页面。
```php
<?php
@ -34,20 +37,25 @@ $this->title = 'Login';
<?php ActiveForm::end(); ?>
```
在视图中,可访问 `$this` 指向 [[yii\web\View|view component]] 来管理和渲染这个视图文件。
在视图中,可访问 `$this` 指向 [[yii\web\View|view component]]
来管理和渲染这个视图文件。
除了 `$this`之外,上述示例中的视图有其他预定义变量如 `$model`
这些变量代表从[控制器](structure-controllers.md)或其他触发[视图渲染](#rendering-views)的对象 *传入* 到视图的数据。
这些变量代表从[控制器](structure-controllers.md)
或其他触发[视图渲染](#rendering-views)的对象 *传入* 到视图的数据。
> Tip: 将预定义变量列到视图文件头部注释处,这样可被IDE编辑器识别,也是生成视图文档的好方法。
> Tip: 将预定义变量列到视图文件头部注释处,
这样可被IDE编辑器识别,也是生成视图文档的好方法。
### 安全 <span id="security"></span>
当创建生成HTML页面的视图时,在显示之前将用户输入数据进行转码和过滤非常重要,
否则,你的应用可能会被[跨站脚本](http://en.wikipedia.org/wiki/Cross-site_scripting) 攻击。
否则,你的应用可能会被
[跨站脚本](http://en.wikipedia.org/wiki/Cross-site_scripting) 攻击。
要显示纯文本,先调用 [[yii\helpers\Html::encode()]] 进行转码,例如如下代码将用户名在显示前先转码:
要显示纯文本,先调用 [[yii\helpers\Html::encode()]] 进行转码,
例如如下代码将用户名在显示前先转码:
```php
<?php
@ -59,7 +67,8 @@ use yii\helpers\Html;
</div>
```
要显示HTML内容,先调用 [[yii\helpers\HtmlPurifier]] 过滤内容,例如如下代码将提交内容在显示前先过滤:
要显示HTML内容,先调用 [[yii\helpers\HtmlPurifier]] 过滤内容,
例如如下代码将提交内容在显示前先过滤:
```php
<?php
@ -88,7 +97,8 @@ use yii\helpers\HtmlPurifier;
其中 `WidgetPath` 代表小部件类文件所在的目录;
* 对于其他对象渲染的视图文件,建议遵循和小部件相似的规则。
可覆盖控制器或小部件的 [[yii\base\ViewContextInterface::getViewPath()]] 方法来自定义视图文件默认目录。
可覆盖控制器或小部件的 [[yii\base\ViewContextInterface::getViewPath()]]
方法来自定义视图文件默认目录。
## 渲染视图 <span id="rendering-views"></span>
@ -115,7 +125,10 @@ methodName($view, $params = [])
* [[yii\base\Controller::renderPartial()|renderPartial()]]: 渲染一个 [视图名](#named-views) 并且不使用布局。
* [[yii\web\Controller::renderAjax()|renderAjax()]]: 渲染一个 [视图名](#named-views) 并且不使用布局,
并注入所有注册的JS/CSS脚本和文件,通常使用在响应AJAX网页请求的情况下。
* [[yii\base\Controller::renderFile()|renderFile()]]: 渲染一个视图文件目录或[别名](concept-aliases.md)下的视图文件。
* [[yii\base\Controller::renderFile()|renderFile()]]: 渲染一个视图文件目录或
[别名](concept-aliases.md)下的视图文件。
* [[yii\base\Controller::renderContent()|renderContent()]]: renders a static string by embedding it into
the currently applicable [layout](#layouts). This method is available since version 2.0.1.
例如:
@ -148,10 +161,10 @@ class PostController extends Controller
### 小部件中渲染 <span id="rendering-in-widgets"></span>
在 [小部件](structure-widgets.md) 中,可调用以下小部件方法来渲染视图:
Within [widgets](structure-widgets.md), you may call the following widget methods to render views.
* [[yii\base\Widget::render()|render()]]: 渲染一个 [视图名](#named-views).
* [[yii\base\Widget::renderFile()|renderFile()]]: 渲染一个视图文件目录或[别名](concept-aliases.md)下的视图文件。
* [[yii\base\Widget::renderFile()|renderFile()]]: 渲染一个视图文件目录或
[别名](concept-aliases.md)下的视图文件。
例如:
@ -183,7 +196,8 @@ class ListWidget extends Widget
* [[yii\base\View::render()|render()]]: 渲染一个 [视图名](#named-views).
* [[yii\web\View::renderAjax()|renderAjax()]]: 渲染一个 [视图名](#named-views)
并注入所有注册的JS/CSS脚本和文件,通常使用在响应AJAX网页请求的情况下。
* [[yii\base\View::renderFile()|renderFile()]]: 渲染一个视图文件目录或[别名](concept-aliases.md)下的视图文件。
* [[yii\base\View::renderFile()|renderFile()]]: 渲染一个视图文件目录或
[别名](concept-aliases.md)下的视图文件。
例如,视图中的如下代码会渲染该视图所在目录下的 `_overview.php` 视图文件,
记住视图中 `$this` 对应 [[yii\base\View|view]] 组件:
@ -216,15 +230,18 @@ echo \Yii::$app->view->renderFile('@app/views/site/license.php');
* 视图名以双斜杠 `//` 开头,对应的视图文件路径为 `@app/views/ViewName`
也就是说视图文件在 [[yii\base\Application::viewPath|application's view path]] 路径下找,
例如 `//site/about` 对应到 `@app/views/site/about.php`
* 视图名以单斜杠`/`开始,视图文件路径以当前使用[模块](structure-modules.md) 的[[yii\base\Module::viewPath|view path]]开始,
* 视图名以单斜杠`/`开始,视图文件路径以当前使用[模块](structure-modules.md)
的[[yii\base\Module::viewPath|view path]]开始,
如果不存在模块,使用`@app/views/ViewName`开始,例如,如果当前模块为`user`, `/user/create` 对应成
`@app/modules/user/views/user/create.php`, 如果不在模块中,`/user/create`对应`@app/views/user/create.php`。
`@app/modules/user/views/user/create.php`,
如果不在模块中,`/user/create`对应`@app/views/user/create.php`。
* 如果 [[yii\base\View::context|context]] 渲染视图 并且上下文实现了 [[yii\base\ViewContextInterface]],
视图文件路径由上下文的 [[yii\base\ViewContextInterface::getViewPath()|view path]] 开始,
这种主要用在控制器和小部件中渲染视图,例如
如果上下文为控制器`SiteController`,`site/about` 对应到 `@app/views/site/about.php`
* 如果视图渲染另一个视图,包含另一个视图文件的目录以当前视图的文件路径开始,
例如被视图`@app/views/post/index.php` 渲染的 `item` 对应到 `@app/views/post/item`
例如被视图`@app/views/post/index.php` 渲染的
`item` 对应到 `@app/views/post/item`
根据以上规则,在控制器中 `app\controllers\PostController` 调用 `$this->render('view')`
实际上渲染 `@app/views/post/view.php` 视图文件,当在该视图文件中调用 `$this->render('_overview')`
@ -235,9 +252,11 @@ echo \Yii::$app->view->renderFile('@app/views/site/license.php');
在视图中有两种方式访问数据:推送和拉取。
推送方式是通过视图渲染方法的第二个参数传递数据,数据格式应为名称-值的数组,
推送方式是通过视图渲染方法的第二个参数传递数据,
数据格式应为名称-值的数组,
视图渲染时,调用PHP `extract()` 方法将该数组转换为视图可访问的变量。
例如,如下控制器的渲染视图代码推送2个变量到 `report` 视图:`$foo = 1` 和 `$bar = 2`
例如,如下控制器的渲染视图代码推送2个变量到
`report` 视图:`$foo = 1` 和 `$bar = 2`
```php
echo $this->render('report', [
@ -248,22 +267,25 @@ echo $this->render('report', [
拉取方式可让视图从[[yii\base\View|view component]]视图组件或其他对象中主动获得数据(如`Yii::$app`),
在视图中使用如下表达式`$this->context`可获取到控制器ID,
可让你在`report`视图中获取控制器的任意属性或方法,如以下代码获取控制器ID。
可让你在`report`视图中获取控制器的任意属性或方法,
如以下代码获取控制器ID。
```php
The controller ID is: <?= $this->context->id ?>
?>
```
推送方式让视图更少依赖上下文对象,是视图获取数据优先使用方式,
缺点是需要手动构建数组,有些繁琐,在不同地方渲染时容易出错。
缺点是需要手动构建数组,有些繁琐,
在不同地方渲染时容易出错。
### 视图间共享数据 <span id="sharing-data-among-views"></span>
[[yii\base\View|view component]]视图组件提供[[yii\base\View::params|params]]参数属性来让不同视图共享数据。
[[yii\base\View|view component]]视图组件提供[[yii\base\View::params|params]]
参数属性来让不同视图共享数据。
例如在`about`视图中,可使用如下代码指定当前breadcrumbs的当前部分。
例如在`about`视图中,
可使用如下代码指定当前breadcrumbs的当前部分。
```php
$this->params['breadcrumbs'][] = 'About Us';
@ -281,7 +303,8 @@ $this->params['breadcrumbs'][] = 'About Us';
## 布局 <span id="layouts"></span>
布局是一种特殊的视图,代表多个视图的公共部分,例如,大多数Web应用共享相同的页头和页尾,
布局是一种特殊的视图,代表多个视图的公共部分,
例如,大多数Web应用共享相同的页头和页尾,
在每个视图中重复相同的页头和页尾,更好的方式是将这些公共放到一个布局中,
渲染内容视图后在合适的地方嵌入到布局中。
@ -289,8 +312,10 @@ $this->params['breadcrumbs'][] = 'About Us';
### 创建布局 <span id="creating-layouts"></span>
由于布局也是视图,它可像普通视图一样创建,布局默认存储在`@app/views/layouts`路径下,
[模块](structure-modules.md)中使用的布局应存储在[[yii\base\Module::basePath|module directory]]模块目录
下的`views/layouts`路径下,可配置[[yii\base\Module::layoutPath]]来自定义应用或模块的布局默认路径。
[模块](structure-modules.md)中使用的布局应存储在
[[yii\base\Module::basePath|module directory]]模块目录
下的`views/layouts`路径下,
可配置[[yii\base\Module::layoutPath]]来自定义应用或模块的布局默认路径。
如下示例为一个布局大致内容,注意作为示例,简化了很多代码,
在实际中,你可能想添加更多内容,如头部标签,主菜单等。
@ -323,9 +348,11 @@ use yii\helpers\Html;
```
如上所示,布局生成每个页面通用的HTML标签,在`<body>`标签中,打印`$content`变量,
`$content`变量代表当[[yii\base\Controller::render()]]控制器渲染方法调用时传递到布局的内容视图渲染结果。
`$content`变量代表当[[yii\base\Controller::render()]]
控制器渲染方法调用时传递到布局的内容视图渲染结果。
大多数视图应调用上述代码中的如下方法,这些方法触发关于渲染过程的事件,
大多数视图应调用上述代码中的如下方法,
这些方法触发关于渲染过程的事件,
这样其他地方注册的脚本和标签会添加到这些方法调用的地方。
- [[yii\base\View::beginPage()|beginPage()]]: 该方法应在布局的开始处调用,
@ -333,7 +360,8 @@ use yii\helpers\Html;
- [[yii\base\View::endPage()|endPage()]]: 该方法应在布局的结尾处调用,
它触发表明页面结尾的 [[yii\base\View::EVENT_END_PAGE|EVENT_END_PAGE]] 时间。
- [[yii\web\View::head()|head()]]: 该方法应在HTML页面的`<head>`标签中调用,
它生成一个占位符,在页面渲染结束时会被注册的头部HTML代码(如,link标签, meta标签)替换。
它生成一个占位符,在页面渲染结束时会被注册的头部HTML代码
(如,link标签, meta标签)替换。
- [[yii\web\View::beginBody()|beginBody()]]: 该方法应在`<body>`标签的开始处调用,
它触发 [[yii\web\View::EVENT_BEGIN_BODY|EVENT_BEGIN_BODY]] 事件并生成一个占位符,
会被注册的HTML代码(如JavaScript)在页面主体开始处替换。
@ -344,22 +372,26 @@ use yii\helpers\Html;
### 布局中访问数据 <span id="accessing-data-in-layouts"></span>
在布局中可访问两个预定义变量:`$this` 和 `$content`,前者对应和普通视图类似的[[yii\base\View|view]] 视图组件
在布局中可访问两个预定义变量:`$this` 和 `$content`
前者对应和普通视图类似的[[yii\base\View|view]] 视图组件
后者包含调用[[yii\base\Controller::render()|render()]]方法渲染内容视图的结果。
如果想在布局中访问其他数据,必须使用[视图中访问数据](#accessing-data-in-views)一节介绍的拉取方式,
如果想从内容视图中传递数据到布局,可使用[视图间共享数据](#sharing-data-among-views)一节中的方法。
如果想从内容视图中传递数据到布局,
可使用[视图间共享数据](#sharing-data-among-views)一节中的方法。
### 使用布局 <span id="using-layouts"></span>
如[控制器中渲染](#rendering-in-controllers)一节描述,当控制器调用[[yii\base\Controller::render()|render()]]
如[控制器中渲染](#rendering-in-controllers)一节描述,
当控制器调用[[yii\base\Controller::render()|render()]]
方法渲染视图时,会同时使用布局到渲染结果中,默认会使用`@app/views/layouts/main.php`布局文件。
可配置[[yii\base\Application::layout]] 或 [[yii\base\Controller::layout]] 使用其他布局文件,
前者管理所有控制器的布局,后者覆盖前者来控制单个控制器布局。
例如,如下代码使 `post` 控制器渲染视图时使用 `@app/views/layouts/post.php` 作为布局文件,
假如 `layout` 属性没改变,控制器默认使用 `@app/views/layouts/main.php` 作为布局文件。
假如 `layout` 属性没改变,
控制器默认使用 `@app/views/layouts/main.php` 作为布局文件。
```php
namespace app\controllers;
@ -374,9 +406,11 @@ class PostController extends Controller
}
```
对于模块中的控制器,可配置模块的 [[yii\base\Module::layout|layout]] 属性指定布局文件应用到模块的所有控制器。
对于模块中的控制器,可配置模块的 [[yii\base\Module::layout|layout]]
属性指定布局文件应用到模块的所有控制器。
由于`layout` 可在不同层级(控制器、模块,应用)配置,在幕后Yii使用两步来决定控制器实际使用的布局。
由于`layout` 可在不同层级(控制器、模块,应用)配置,
在幕后Yii使用两步来决定控制器实际使用的布局。
第一步,它决定布局的值和上下文模块:
@ -387,13 +421,16 @@ class PostController extends Controller
并将它的[[yii\base\Module::layout|layout]] 的值作为布局的值,
如果都没有找到,表示不使用布局。
第二步,它决定第一步中布局的值和上下文模块对应到实际的布局文件,布局的值可为:
第二步,它决定第一步中布局的值和上下文模块对应到实际的布局文件,
布局的值可为:
- 路径别名 (如 `@app/views/layouts/main`).
- 绝对路径 (如 `/main`): 布局的值以斜杠开始,在应用的[[yii\base\Application::layoutPath|layout path]] 布局路径
- 绝对路径 (如 `/main`): 布局的值以斜杠开始,
在应用的[[yii\base\Application::layoutPath|layout path]] 布局路径
中查找实际的布局文件,布局路径默认为 `@app/views/layouts`
- 相对路径 (如 `main`): 在上下文模块的[[yii\base\Module::layoutPath|layout path]]布局路径中查找实际的布局文件,
布局路径默认为[[yii\base\Module::basePath|module directory]]模块目录下的`views/layouts` 目录。
布局路径默认为[[yii\base\Module::basePath|module directory]]
模块目录下的`views/layouts` 目录。
- 布尔值 `false`: 不使用布局。
布局的值没有包含文件扩展名,默认使用 `.php`作为扩展名。
@ -427,7 +464,8 @@ class PostController extends Controller
例如,可在内容视图中定义数据块在布局中显示它。
调用 [[yii\base\View::beginBlock()|beginBlock()]] 和 [[yii\base\View::endBlock()|endBlock()]] 来定义数据块,
使用 `$view->blocks[$blockID]` 访问该数据块,其中 `$blockID` 为定义数据块时指定的唯一标识ID。
使用 `$view->blocks[$blockID]` 访问该数据块,
其中 `$blockID` 为定义数据块时指定的唯一标识ID。
如下实例显示如何在内容视图中使用数据块让布局使用。
@ -451,7 +489,8 @@ class PostController extends Controller
<?php $this->endBlock(); ?>
```
然后,在布局视图中,数据块可用的话会渲染数据块,如果数据未定义则显示一些默认内容。
然后,在布局视图中,数据块可用的话会渲染数据块,
如果数据未定义则显示一些默认内容。
```php
...
@ -482,8 +521,9 @@ class PostController extends Controller
## 使用视图组件 <span id="using-view-components"></span>
[[yii\base\View|View components]]视图组件提供许多视图相关特性,可创建[[yii\base\View]]或它的子类实例来获取视图组件,
大多数情况下主要使用 `view` 应用组件,可在[应用配置](structure-applications.md#application-configurations)中配置该组件,
[[yii\base\View|View components]]视图组件提供许多视图相关特性,
可创建[[yii\base\View]]或它的子类实例来获取视图组件,大多数情况下主要使用 `view` 应用组件,
可在[应用配置](structure-applications.md#application-configurations)中配置该组件,
如下所示:
```php
@ -533,9 +573,11 @@ $this->title = 'My page title';
### 注册Meta元标签 <span id="registering-meta-tags"></span>
Web页面通常需要生成各种元标签提供给不同的浏览器,如`<head>`中的页面标题,元标签通常在布局中生成。
Web页面通常需要生成各种元标签提供给不同的浏览器,
如`<head>`中的页面标题,元标签通常在布局中生成。
如果想在内容视图中生成元标签,可在内容视图中调用[[yii\web\View::registerMetaTag()]]方法,如下所示:
如果想在内容视图中生成元标签,可在内容视图中调用[[yii\web\View::registerMetaTag()]]方法,
如下所示:
```php
<?php
@ -543,14 +585,16 @@ $this->registerMetaTag(['name' => 'keywords', 'content' => 'yii, framework, php'
?>
```
以上代码会在视图组件中注册一个 "keywords" 元标签,在布局渲染后会渲染该注册的元标签,
以上代码会在视图组件中注册一个 "keywords" 元标签,
在布局渲染后会渲染该注册的元标签,
然后,如下HTML代码会插入到布局中调用[[yii\web\View::head()]]方法处:
```php
<meta name="keywords" content="yii, framework, php">
```
注意如果多次调用 [[yii\web\View::registerMetaTag()]] 方法,它会注册多个元标签,注册时不会检查是否重复。
注意如果多次调用 [[yii\web\View::registerMetaTag()]] 方法,
它会注册多个元标签,注册时不会检查是否重复。
为确保每种元标签只有一个,可在调用方法时指定键作为第二个参数,
例如,如下代码注册两次 "description" 元标签,但是只会渲染第二个。
@ -564,7 +608,8 @@ $this->registerMetaTag(['name' => 'description', 'content' => 'This website is a
### 注册链接标签 <span id="registering-link-tags"></span>
和 [Meta标签](#adding-meta-tags) 类似,链接标签有时很实用,如自定义网站图标,指定Rss订阅,或授权OpenID到其他服务器。
可以和元标签相似的方式调用[[yii\web\View::registerLinkTag()]],例如,在内容视图中注册链接标签如下所示:
可以和元标签相似的方式调用[[yii\web\View::registerLinkTag()]],
例如,在内容视图中注册链接标签如下所示:
```php
$this->registerLinkTag([
@ -593,7 +638,8 @@ $this->registerLinkTag([
- [[yii\base\View::EVENT_BEFORE_RENDER|EVENT_BEFORE_RENDER]]: 在控制器渲染文件开始时触发,
该事件可设置 [[yii\base\ViewEvent::isValid]] 为 false 取消视图渲染。
- [[yii\base\View::EVENT_AFTER_RENDER|EVENT_AFTER_RENDER]]: 在布局中调用 [[yii\base\View::beginPage()]] 时触发,
该事件可获取[[yii\base\ViewEvent::output]]的渲染结果,可修改该属性来修改渲染结果。
该事件可获取[[yii\base\ViewEvent::output]]的渲染结果,
可修改该属性来修改渲染结果。
- [[yii\base\View::EVENT_BEGIN_PAGE|EVENT_BEGIN_PAGE]]: 在布局调用 [[yii\base\View::beginPage()]] 时触发;
- [[yii\base\View::EVENT_END_PAGE|EVENT_END_PAGE]]: 在布局调用 [[yii\base\View::endPage()]] 是触发;
- [[yii\web\View::EVENT_BEGIN_BODY|EVENT_BEGIN_BODY]]: 在布局调用 [[yii\web\View::beginBody()]] 时触发;
@ -610,7 +656,8 @@ $this->registerLinkTag([
## 渲染静态页面 <span id="rendering-static-pages"></span>
静态页面指的是大部分内容为静态的不需要控制器传递动态数据的Web页面。
静态页面指的是大部分内容为静态的不需要控制器传递
动态数据的Web页面。
可将HTML代码放置在视图中,在控制器中使用以下代码输出静态页面:
@ -665,9 +712,12 @@ http://localhost/index.php?r=site/page&view=about
如果需要请求数据,应由控制器推送到视图。
* 可读取模型属性,但不应修改它们。
为使模型更易于维护,避免创建太复杂或包含太多冗余代码的视图,可遵循以下方法达到这个目标:
为使模型更易于维护,避免创建太复杂或包含太多冗余代码的视图,
可遵循以下方法达到这个目标:
* 使用 [布局](#layouts) 来展示公共代码(如,页面头部、尾部);
* 将复杂的视图分成几个小视图,可使用上面描述的渲染方法将这些小视图渲染并组装成大视图;
* 将复杂的视图分成几个小视图,可使用上面描述的渲染方法将这些
小视图渲染并组装成大视图;
* 创建并使用 [小部件](structure-widgets.md) 作为视图的数据块;
* 创建并使用助手类在视图中转换和格式化数据。

Loading…
Cancel
Save