视图 - 模板小部件Widget ¶

本文导航

使用小部件
创建小部件
最佳实践

作者：KK
发表日期：2018.0.0

本章节直接基于官方中文文档略有修改：

小部件是在视图中使用的可重用单元，使用面向对象方式创建复杂和可配置用户界面单元。例如，日期选择器小部件可生成一个精致的允许用户选择日期的日期选择器，你只需要在视图中插入如下代码：

<?php
use yii\jui\DatePicker;
?>
<?= DatePicker::widget(['name' => 'date']) ?>

Yii提供许多优秀的小部件，比如yii\widgets\ActiveForm, yii\widgets\Menu, jQuery UI widgets, Twitter Bootstrap widgets。接下来介绍小部件的基本知识，如果你想了解某个小部件请参考对应的类API文档。

使用小部件 ¶

小部件基本上在视图中使用，在视图中可调用 yii\base\Widget::widget() 方法使用小部件。该方法使用 [配置]((base-configure-object.md) 数组初始化小部件并返回小部件渲染后的结果。例如如下代码插入一个日期选择器小部件，它配置为使用俄罗斯语，输入框内容为$model的from_date属性值。

<?php
use yii\jui\DatePicker;
?>
<?= DatePicker::widget([
    'model' => $model,
    'attribute' => 'from_date',
    'language' => 'ru',
    'dateFormat' => 'php:Y-m-d',
]) ?>

一些小部件可在yii\base\Widget::begin() 和 yii\base\Widget::end() 调用中使用数据内容。例如如下代码使用yii\widgets\ActiveForm小部件生成一个登录表单，小部件会在begin() 和0 end()执行处分别生成<form>的开始标签和结束标签，中间的任何代码也会被渲染。

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

<?php $form = ActiveForm::begin(['id' => 'login-form']); ?>

    <?= $form->field($model, 'username') ?>

    <?= $form->field($model, 'password')->passwordInput() ?>

    <div class="form-group">
        <?= Html::submitButton('Login') ?>
    </div>

<?php ActiveForm::end(); ?>

注意和调用 yii\base\Widget::widget() 返回渲染结果不同，调用 yii\base\Widget::begin() 方法返回一个可组建小部件内容的小部件实例。

Note: 当调用 yii\base\Widget::end() 的时候，一些小部件将使用输出缓冲（俗称ob）来调整封闭的内容。因此，当调用 yii\base\Widget::begin() 和 yii\base\Widget::end() 时，最好在同一个视图文件里。不遵循这个规则可能会导致意外的输出。

配置全局默认值 ¶

小部件的全局默认值可以通过 DI 容器配置:

\Yii::$container->set('yii\widgets\LinkPager', ['maxButtonCount' => 5]);

详见依赖注入容器 "实践中的应用" 一节。

创建小部件 ¶

继承 yii\base\Widget 类并覆盖 yii\base\Widget::init() 和/或 yii\base\Widget::run() 方法可创建小部件。通常init() 方法处理小部件属性， run() 方法包含小部件生成渲染结果的代码。渲染结果可在run()方法中直接"echoed"输出或以字符串返回。

如下代码中HelloWidget编码并显示赋给message 属性的值，如果属性没有被赋值，默认会显示"Hello World"。

namespace app\components;

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

class HelloWidget extends Widget
{
    public $message;

    public function init()
    {
        parent::init();
        if ($this->message === null) {
            $this->message = 'Hello World';
        }
    }

    public function run()
    {
        return Html::encode($this->message);
    }
}

使用这个小部件只需在视图中简单使用如下代码:

<?php
use app\components\HelloWidget;
?>
<?= HelloWidget::widget(['message' => 'Good morning']) ?>

以下是另一种可在begin() 和 end()调用中使用的HelloWidget， HTML编码内容然后显示。

namespace app\components;

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

class HelloWidget extends Widget
{
    public function init()
    {
        parent::init();
        ob_start();
    }

    public function run()
    {
        $content = ob_get_clean();
        return Html::encode($content);
    }
}

如上所示，PHP输出缓冲在init()启动，所有在init() 和 run()方法之间的输出内容都会被获取，并在run()处理和返回。

Info: 当你调用 yii\base\Widget::begin() 时会创建一个新的小部件实例并在构造结束时调用init()方法，在end()时会调用run()方法并输出返回结果。

如下代码显示如何使用这种 HelloWidget:

<?php
use app\components\HelloWidget;
?>
<?php HelloWidget::begin(); ?>

    content that may contain <tag>'s

<?php HelloWidget::end(); ?>

有时小部件需要渲染很多内容，一种更好的办法是将内容放入一个视图文件，然后调用yii\base\Widget::render()方法渲染该视图文件，例如：

public function run()
{
    return $this->render('hello');
}

小部件的视图文件默认存储在WidgetPath/views目录，WidgetPath代表小部件类文件所在的目录。假如上述示例小部件类文件在@app/components下，会渲染@app/components/views/hello.php视图文件。 You may override 可以覆盖yii\base\Widget::getViewPath()方法自定义视图文件所在路径。

最佳实践 ¶

小部件是面向对象方式来重用视图代码。

创建小部件时仍需要遵循MVC模式，通常逻辑代码在小部件类，展示内容在视图中。

小部件设计时应是独立的，也就是说使用一个小部件时候，可以直接丢弃它而不需要额外的处理。但是当小部件需要外部资源如CSS, JavaScript, 图片等会比较棘手，幸运的时候Yii提供资源包来解决这个问题。

当一个小部件只包含视图代码，它和视图很相似，实际上，在这种情况下，唯一的区别是小部件是可以重用类，视图只是应用中使用的普通PHP脚本。