视图 ¶

创建视图
渲染视图
布局
使用视图组件
视图事件
渲染静态页面
最佳实践

视图是 MVC 模式中的一部分。它是展示数据到终端用户的代码，在网页应用中，根据视图模板来创建视图，视图模板为PHP脚本文件，主要包含HTML代码和展示类PHP代码，通过view应用组件来管理，该组件主要提供通用方法帮助视图构造和渲染，简单起见，我们称视图模板或视图模板文件为视图。

创建视图 ¶

如前所述，视图为包含HTML和PHP代码的PHP脚本，如下代码为一个登录表单的视图，可看到PHP代码用来生成动态内容如页面标题和表单， HTML代码把它组织成一个漂亮的HTML页面。

<?php
use yii\helpers\Html;
use yii\widgets\ActiveForm;

/* @var $this yii\web\View */
/* @var $form yii\widgets\ActiveForm */
/* @var $model app\models\LoginForm */

$this->title = 'Login';
?>
<h1><?= Html::encode($this->title) ?></h1>

<p>Please fill out the following fields to login:</p>

<?php $form = ActiveForm::begin(); ?>
    <?= $form->field($model, 'username') ?>
    <?= $form->field($model, 'password')->passwordInput() ?>
    <?= Html::submitButton('Login') ?>
<?php ActiveForm::end(); ?>

在视图中，可访问 $this 指向 view component 来管理和渲染这个视图文件。

除了 $this之外，上述示例中的视图有其他预定义变量如 $model，这些变量代表从控制器或其他触发视图渲染的对象传入到视图的数据。

Tip: 将预定义变量列到视图文件头部注释处，这样可被IDE编辑器识别，也是生成视图文档的好方法。

安全 ¶

当创建生成HTML页面的视图时，在显示之前将用户输入数据进行转码和过滤非常重要，否则，你的应用可能会被跨站脚本攻击。

要显示纯文本，先调用 yii\helpers\Html::encode() 进行转码，例如如下代码将用户名在显示前先转码：

<?php
use yii\helpers\Html;
?>

<div class="username">
    <?= Html::encode($user->name) ?>
</div>

要显示HTML内容，先调用 yii\helpers\HtmlPurifier 过滤内容，例如如下代码将提交内容在显示前先过滤：

<?php
use yii\helpers\HtmlPurifier;
?>

<div class="post">
    <?= HtmlPurifier::process($post->text) ?>
</div>

Tip: HTMLPurifier在保证输出数据安全上做的不错，但性能不佳，如果你的应用需要高性能可考虑缓存过滤后的结果。

组织视图 ¶

与控制器和模型类似，在组织视图上有一些约定：

控制器渲染的视图文件默认放在 @app/views/ControllerID 目录下，其中 ControllerID 对应控制器 ID, 例如控制器类为 PostController，视图文件目录应为 @app/views/post，控制器类 PostCommentController对应的目录为 @app/views/post-comment，如果是模块中的控制器，目录应为 yii\base\Module::basePath 模块目录下的 views/ControllerID 目录；
对于小部件渲染的视图文件默认放在 WidgetPath/views 目录，其中 WidgetPath 代表小部件类文件所在的目录；
对于其他对象渲染的视图文件，建议遵循和小部件相似的规则。

可覆盖控制器或小部件的 yii\base\ViewContextInterface::getViewPath() 方法来自定义视图文件默认目录。

渲染视图 ¶

可在控制器, 小部件, 或其他地方调用渲染视图方法来渲染视图，该方法类似以下格式：

/**
 * @param string $view 视图名或文件路径，由实际的渲染方法决定
 * @param array $params 传递给视图的数据
 * @return string 渲染结果
 */
methodName($view, $params = [])

控制器中渲染 ¶

在控制器中，可调用以下控制器方法来渲染视图：

render(): 渲染一个视图名并使用一个布局返回到渲染结果。
renderPartial(): 渲染一个视图名并且不使用布局。
renderAjax(): 渲染一个视图名并且不使用布局，并注入所有注册的JS/CSS脚本和文件，通常使用在响应AJAX网页请求的情况下。
别名下的视图文件。
renderContent(): renders a static string by embedding it into the currently applicable layout. This method is available since version 2.0.1.

例如：

namespace app\controllers;

use Yii;
use app\models\Post;
use yii\web\Controller;
use yii\web\NotFoundHttpException;

class PostController extends Controller
{
    public function actionView($id)
    {
        $model = Post::findOne($id);
        if ($model === null) {
            throw new NotFoundHttpException;
        }

        // 渲染一个名称为"view"的视图并使用布局
        return $this->render('view', [
            'model' => $model,
        ]);
    }
}

小部件中渲染 ¶

在小部件中，可调用以下小部件方法来渲染视图：

render(): 渲染一个视图名.
别名下的视图文件。

例如：

namespace app\components;

use yii\base\Widget;
use yii\helpers\Html;

class ListWidget extends Widget
{
    public $items = [];

    public function run()
    {
        // 渲染一个名为 "list" 的视图
        return $this->render('list', [
            'items' => $this->items,
        ]);
    }
}

视图中渲染 ¶

可以在视图中渲染另一个视图，可以调用view component视图组件提供的以下方法：

render(): 渲染一个视图名.
renderAjax(): 渲染一个视图名并注入所有注册的JS/CSS脚本和文件，通常使用在响应AJAX网页请求的情况下。
- 别名下的视图文件。

例如，视图中的如下代码会渲染该视图所在目录下的 _overview.php 视图文件，记住视图中 $this 对应 view 组件:

<?= $this->render('_overview') ?>

其他地方渲染 ¶

在任何地方都可以通过表达式 Yii::$app->view 访问 view 应用组件，调用它的如前所述的方法渲染视图，例如：

// 显示视图文件 "@app/views/site/license.php"
echo \Yii::$app->view->renderFile('@app/views/site/license.php');

视图名 ¶

渲染视图时，可指定一个视图名或视图文件路径/别名，大多数情况下使用前者因为前者简洁灵活，我们称用名字的视图为 视图名.

视图名可以依据以下规则到对应的视图文件路径：

视图名可省略文件扩展名，这种情况下使用 .php 作为扩展，视图名 about 对应到 about.php 文件名；
视图名以双斜杠 // 开头，对应的视图文件路径为 @app/views/ViewName，也就是说视图文件在 yii\base\Application::viewPath 路径下找，例如 //site/about 对应到 @app/views/site/about.php。
视图名以单斜杠/开始，视图文件路径以当前使用模块的yii\base\Module::viewPath开始，如果不存在模块，使用@app/views/ViewName开始，例如，如果当前模块为user， /user/create 对应成 @app/modules/user/views/user/create.php, 如果不在模块中，/user/create对应@app/views/user/create.php。
如果 context 渲染视图并且上下文实现了 yii\base\ViewContextInterface, 视图文件路径由上下文的 view path 开始，这种主要用在控制器和小部件中渲染视图，例如如果上下文为控制器SiteController，site/about 对应到 @app/views/site/about.php。
如果视图渲染另一个视图，包含另一个视图文件的目录以当前视图的文件路径开始，例如被视图@app/views/post/index.php 渲染的 item 对应到 @app/views/post/item。

根据以上规则，在控制器中 app\controllers\PostController 调用 $this->render('view')，实际上渲染 @app/views/post/view.php 视图文件，当在该视图文件中调用 $this->render('_overview') 会渲染 @app/views/post/_overview.php 视图文件。

视图中访问数据 ¶

在视图中有两种方式访问数据：推送和拉取。

推送方式是通过视图渲染方法的第二个参数传递数据，数据格式应为名称-值的数组，视图渲染时，调用PHP extract() 方法将该数组转换为视图可访问的变量。例如，如下控制器的渲染视图代码推送2个变量到 report 视图：$foo = 1 和 $bar = 2。

echo $this->render('report', [
    'foo' => 1,
    'bar' => 2,
]);

拉取方式可让视图从view component视图组件或其他对象中主动获得数据(如Yii::$app)，在视图中使用如下表达式$this->context可获取到控制器ID，可让你在report视图中获取控制器的任意属性或方法，如以下代码获取控制器ID。

The controller ID is: <?= $this->context->id ?>

推送方式让视图更少依赖上下文对象，是视图获取数据优先使用方式，缺点是需要手动构建数组，有些繁琐，在不同地方渲染时容易出错。

视图间共享数据 ¶

view component视图组件提供params 参数属性来让不同视图共享数据。

例如在about视图中，可使用如下代码指定当前breadcrumbs的当前部分。

$this->params['breadcrumbs'][] = 'About Us';

在布局文件（也是一个视图）中，可使用依次加入到params数组的值来生成显示breadcrumbs:

<?= yii\widgets\Breadcrumbs::widget([
    'links' => isset($this->params['breadcrumbs']) ? $this->params['breadcrumbs'] : [],
]) ?>

布局 ¶

布局是一种特殊的视图，代表多个视图的公共部分，例如，大多数Web应用共享相同的页头和页尾，在每个视图中重复相同的页头和页尾，更好的方式是将这些公共放到一个布局中，渲染内容视图后在合适的地方嵌入到布局中。

创建布局 ¶

由于布局也是视图，它可像普通视图一样创建，布局默认存储在@app/views/layouts路径下，模块中使用的布局应存储在 yii\base\Module::basePath模块目录下的views/layouts路径下，可配置yii\base\Module::layoutPath来自定义应用或模块的布局默认路径。

如下示例为一个布局大致内容，注意作为示例，简化了很多代码，在实际中，你可能想添加更多内容，如头部标签，主菜单等。

<?php
use yii\helpers\Html;

/* @var $this yii\web\View */
/* @var $content string 字符串 */
?>
<?php $this->beginPage() ?>
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8"/>
    <?= Html::csrfMetaTags() ?>
    <title><?= Html::encode($this->title) ?></title>
    <?php $this->head() ?>
</head>
<body>
<?php $this->beginBody() ?>
    <header>My Company</header>
    <?= $content ?>
    <footer>&copy; 2014 by My Company</footer>
<?php $this->endBody() ?>
</body>
</html>
<?php $this->endPage() ?>

如上所示，布局生成每个页面通用的HTML标签，在<body>标签中，打印$content变量， $content变量代表当yii\base\Controller::render() 控制器渲染方法调用时传递到布局的内容视图渲染结果。

大多数视图应调用上述代码中的如下方法，这些方法触发关于渲染过程的事件，这样其他地方注册的脚本和标签会添加到这些方法调用的地方。

它触发表明页面开始的 EVENT_BEGIN_PAGE 事件。
它触发表明页面结尾的 EVENT_END_PAGE 事件。
它生成一个占位符，在页面渲染结束时会被注册的头部HTML代码（如，link标签, meta标签）替换。
它触发 EVENT_BEGIN_BODY 事件并生成一个占位符，会被注册的HTML代码（如JavaScript）在页面主体开始处替换。
它触发 EVENT_END_BODY 事件并生成一个占位符，会被注册的HTML代码（如JavaScript）在页面主体结尾处替换。

布局中访问数据 ¶

在布局中可访问两个预定义变量：$this 和 $content，前者对应和普通视图类似的view 视图组件后者包含调用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 作为布局文件。

namespace app\controllers;

use yii\web\Controller;

class PostController extends Controller
{
    public $layout = 'post';
    
    // ...
}

对于模块中的控制器，可配置模块的 layout 属性指定布局文件应用到模块的所有控制器。

由于layout 可在不同层级（控制器、模块，应用）配置，在幕后Yii使用两步来决定控制器实际使用的布局。

第一步，它决定布局的值和上下文模块：

如果控制器的 yii\base\Controller::$layout 属性不为空null，使用它作为布局的值，控制器的 module模块作为上下文模块。
如果 layout 为空，从控制器的祖先模块（包括应用）开始找第一个layout 属性不为空的模块，使用该模块作为上下文模块，并将它的layout 的值作为布局的值，如果都没有找到，表示不使用布局。

第二步，它决定第一步中布局的值和上下文模块对应到实际的布局文件，布局的值可为：

路径别名 (如 @app/views/layouts/main).
绝对路径 (如 /main): 布局的值以斜杠开始，在应用的yii\base\Application::layoutPath 布局路径中查找实际的布局文件，布局路径默认为 @app/views/layouts。
相对路径 (如 main): 在上下文模块的yii\base\Module::layoutPath布局路径中查找实际的布局文件，布局路径默认为yii\base\Module::basePath 模块目录下的views/layouts 目录。
布尔值 false: 不使用布局。

布局的值没有包含文件扩展名，默认使用 .php作为扩展名。

嵌套布局 ¶

有时候你想嵌套一个布局到另一个，例如，在Web站点不同地方，想使用不同的布局，同时这些布局共享相同的生成全局HTML5页面结构的基本布局，可以在子布局中调用 beginContent() 和endContent() 方法，如下所示：

<?php $this->beginContent('@app/views/layouts/base.php'); ?>

...child layout content here...

<?php $this->endContent(); ?>

如上所示，子布局内容应在 beginContent() 和 endContent() 方法之间，传给 beginContent() 的参数指定父布局，父布局可为布局文件或别名。

使用以上方式可多层嵌套布局。

使用数据块 ¶

数据块可以在一个地方指定视图内容在另一个地方显示，通常和布局一起使用，例如，可在内容视图中定义数据块在布局中显示它。

调用 beginBlock() 和 endBlock() 来定义数据块，使用 $view->blocks[$blockID] 访问该数据块，其中 $blockID 为定义数据块时指定的唯一标识ID。

如下实例显示如何在内容视图中使用数据块让布局使用。

首先，在内容视图中定一个或多个数据块：

...

<?php $this->beginBlock('block1'); ?>

...content of block1...

<?php $this->endBlock(); ?>

...

<?php $this->beginBlock('block3'); ?>

...content of block3...

<?php $this->endBlock(); ?>

然后，在布局视图中，数据块可用的话会渲染数据块，如果数据未定义则显示一些默认内容。

...
<?php if (isset($this->blocks['block1'])): ?>
    <?= $this->blocks['block1'] ?>
<?php else: ?>
    ... default content for block1 ...
<?php endif; ?>

...

<?php if (isset($this->blocks['block2'])): ?>
    <?= $this->blocks['block2'] ?>
<?php else: ?>
    ... default content for block2 ...
<?php endif; ?>

...

<?php if (isset($this->blocks['block3'])): ?>
    <?= $this->blocks['block3'] ?>
<?php else: ?>
    ... default content for block3 ...
<?php endif; ?>
...

使用视图组件 ¶

View components视图组件提供许多视图相关特性，可创建yii\base\View或它的子类实例来获取视图组件，大多数情况下主要使用 view 应用组件，可在应用配置中配置该组件，如下所示：

[
    // ...
    'components' => [
        'view' => [
            'class' => 'app\components\View',
        ],
        // ...
    ],
]

视图组件提供如下实用的视图相关特性，每项详情会在独立章节中介绍：

主题: 允许为你的Web站点开发和修改主题；
片段缓存: 允许你在Web页面中缓存片段；
客户脚本处理: 支持CSS 和 JavaScript 注册和渲染；
资源包处理: 支持资源包的注册和渲染；
模板引擎: 允许你使用其他模板引擎，如 Twig, Smarty。

开发Web页面时，也可能频繁使用以下实用的小特性。

设置页面标题 ¶

每个Web页面应有一个标题，正常情况下标题的标签显示在布局中，但是实际上标题大多由内容视图而不是布局来决定，为解决这个问题， yii\web\View 提供 title 标题属性可让标题信息从内容视图传递到布局中。

为利用这个特性，在每个内容视图中设置页面标题，如下所示：

<?php
$this->title = 'My page title';
?>

然后在视图中，确保在 <head> 段中有如下代码：

<title><?= Html::encode($this->title) ?></title>

注册Meta元标签 ¶

Web页面通常需要生成各种元标签提供给不同的浏览器，如<head>中的页面标题，元标签通常在布局中生成。

如果想在内容视图中生成元标签，可在内容视图中调用yii\web\View::registerMetaTag()方法，如下所示：

<?php
$this->registerMetaTag(['name' => 'keywords', 'content' => 'yii, framework, php']);
?>

以上代码会在视图组件中注册一个 "keywords" 元标签，在布局渲染后会渲染该注册的元标签，然后，如下HTML代码会插入到布局中调用yii\web\View::head()方法处：

<meta name="keywords" content="yii, framework, php">

注意如果多次调用 yii\web\View::registerMetaTag() 方法，它会注册多个元标签，注册时不会检查是否重复。

为确保每种元标签只有一个，可在调用方法时指定键作为第二个参数，例如，如下代码注册两次 "description" 元标签，但是只会渲染第二个。

$this->registerMetaTag(['name' => 'description', 'content' => 'This is my cool website made with Yii!'], 'description');
$this->registerMetaTag(['name' => 'description', 'content' => 'This website is about funny raccoons.'], 'description');

注册链接标签 ¶

和 Meta标签类似，链接标签有时很实用，如自定义网站图标，指定Rss订阅，或授权OpenID到其他服务器。可以和元标签相似的方式调用yii\web\View::registerLinkTag()，例如，在内容视图中注册链接标签如下所示：

$this->registerLinkTag([
    'title' => 'Live News for Yii',
    'rel' => 'alternate',
    'type' => 'application/rss+xml',
    'href' => 'http://www.yiiframework.com/rss.xml/',
]);

上述代码会转换成

<link title="Live News for Yii" rel="alternate" type="application/rss+xml" href="http://www.yiiframework.com/rss.xml/">

和 registerMetaTags() 类似，调用registerLinkTag() 指定键来避免生成重复链接标签。

视图事件 ¶

View components 视图组件会在视图渲染过程中触发几个事件，可以在内容发送给终端用户前，响应这些事件来添加内容到视图中或调整渲染结果。

该事件可设置 yii\base\ViewEvent::$isValid 为 false 取消视图渲染。
EVENT_AFTER_RENDER: 在布局中调用 yii\base\View::afterRender() 时触发，该事件可获取yii\base\ViewEvent::$output的渲染结果，可修改该属性来修改渲染结果。
EVENT_BEGIN_PAGE: 在布局调用 yii\base\View::beginPage() 时触发；
EVENT_END_PAGE: 在布局调用 yii\base\View::endPage() 是触发；
EVENT_BEGIN_BODY: 在布局调用 yii\web\View::beginBody() 时触发；
EVENT_END_BODY: 在布局调用 yii\web\View::endBody() 时触发。

例如，如下代码将当前日期添加到页面结尾处：

\Yii::$app->view->on(View::EVENT_END_BODY, function () {
    echo date('Y-m-d');
});

渲染静态页面 ¶

静态页面指的是大部分内容为静态的不需要控制器传递动态数据的Web页面。

可将HTML代码放置在视图中，在控制器中使用以下代码输出静态页面：

public function actionAbout()
{
    return $this->render('about');
}

如果Web站点包含很多静态页面，多次重复相似的代码显得很繁琐，为解决这个问题，可以使用一个在控制器中称为 yii\web\ViewAction 的独立动作。例如：

namespace app\controllers;

use yii\web\Controller;

class SiteController extends Controller
{
    public function actions()
    {
        return [
            'page' => [
                'class' => 'yii\web\ViewAction',
            ],
        ];
    }
}

现在如果你在@app/views/site/pages目录下创建名为 about 的视图，可通过如下url显示该视图：

http://localhost/index.php?r=site/page&view=about

GET 中 view 参数告知 yii\web\ViewAction 动作请求哪个视图，然后操作在 @app/views/site/pages目录下寻找该视图，可配置 yii\web\ViewAction::$viewPrefix 修改搜索视图的目录。

最佳实践 ¶

视图负责将模型的数据展示用户想要的格式，总之，视图

应主要包含展示代码，如HTML, 和简单的PHP代码来控制、格式化和渲染数据；
不应包含执行数据查询代码，这种代码放在模型中；
应避免直接访问请求数据，如 $_GET, $_POST，这种应在控制器中执行，如果需要请求数据，应由控制器推送到视图。
可读取模型属性，但不应修改它们。

为使模型更易于维护，避免创建太复杂或包含太多冗余代码的视图，可遵循以下方法达到这个目标：

使用布局来展示公共代码（如，页面头部、尾部）；
将复杂的视图分成几个小视图，可使用上面描述的渲染方法将这些小视图渲染并组装成大视图；
创建并使用小部件作为视图的数据块；
创建并使用助手类在视图中转换和格式化数据。