Yii框架小部件(Widgets)用法实例详解


Posted in PHP onMay 15, 2020

本文实例讲述了Yii框架小部件(Widgets)用法。分享给大家供大家参考,具体如下:

小部件 ¶

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

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

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

使用小部件

小部件基本上在views中使用, 在视图中可调用 yii\base\Widget::widget() 方法使用小部件。 该方法使用 配置 数组初始化小部件并返回小部件渲染后的结果。 例如如下代码插入一个日期选择器小部件,它配置为使用俄罗斯语, 输入框内容为$modelfrom_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() 方法返回一个可组建小部件内容的小部件实例。

注意: 当调用 yii\base\Widget::end() 的时候,一些小部件将使用 输出缓冲 来调整封闭的内容。因此,当调用 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()处理和返回。

信息: 当你调用 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脚本。

希望本文所述对大家基于Yii框架的PHP程序设计有所帮助。

PHP 相关文章推荐
PHP4之COOKIE支持详解
Oct 09 PHP
php替换超长文本中的特殊字符的函数代码
May 22 PHP
ThinkPHP惯例配置文件详解
Jul 14 PHP
Yii把CGridView文本框换成下拉框的方法
Dec 03 PHP
php中删除数组的第一个元素和最后一个元素的函数
Mar 07 PHP
PHP 开发者该知道的 5 个 Composer 小技巧
Feb 03 PHP
Zend Framework基本页面布局分析
Mar 19 PHP
php生成Android客户端扫描可登录的二维码
May 13 PHP
基于thinkPHP实现的微信自定义分享功能示例
Sep 23 PHP
PHP数据的提交与过滤基本操作实例详解
Nov 11 PHP
zend框架实现支持sql server的操作方法
Dec 08 PHP
php封装单文件上传到数据库(路径)
Oct 15 PHP
Yii框架安装简明教程
May 15 #PHP
php字符串函数 str类常见用法示例
May 15 #PHP
PHP数组array类常见操作示例
May 15 #PHP
php数值计算num类简单操作示例
May 15 #PHP
Thinkphp 框架配置操作之动态配置、扩展配置及批量配置实例分析
May 15 #PHP
Thinkphp 框架配置操作之配置加载与读取配置实例分析
May 15 #PHP
PHP程序员简单的开展服务治理架构操作详解(三)
May 14 #PHP
You might like
劣质的PHP代码简化
2010/02/08 PHP
snoopy 强大的PHP采集类使用实例代码
2010/12/09 PHP
PHP 使用header函数设置HTTP头的示例解析 表头
2013/06/17 PHP
php 生成自动创建文件夹并上传文件的示例代码
2014/03/07 PHP
30个php操作redis常用方法代码例子
2014/07/05 PHP
php中创建和调用webservice接口示例
2014/07/25 PHP
C# WinForm中实现快捷键自定义设置实例
2015/01/23 PHP
js异或加解密效果代码
2008/06/25 Javascript
Javascript根据指定下标或对象删除数组元素
2012/12/21 Javascript
js屏蔽鼠标键盘(右键/Ctrl+N/Shift+F10/F11/F5刷新/退格键)
2013/01/24 Javascript
javascript实现table选中的行以指定颜色高亮显示的方法
2015/05/13 Javascript
完美解决IE不支持Data.parse()的问题
2016/11/24 Javascript
JS实现简易刻度时钟示例代码
2017/03/11 Javascript
在Vue中用canvas实现二维码和图片合成海报的方法
2019/06/10 Javascript
基于Taro的微信小程序模板消息-获取formId功能模块封装实践
2019/07/15 Javascript
ES2020系列之空值合并运算符 '??'
2020/07/22 Javascript
原生js实现分页效果
2020/09/23 Javascript
python练习程序批量修改文件名
2014/01/16 Python
Python使用matplotlib实现在坐标系中画一个矩形的方法
2015/05/20 Python
Python for Informatics 第11章之正则表达式(四)
2016/04/21 Python
Python实现的单向循环链表功能示例
2017/11/10 Python
Python及PyCharm下载与安装教程
2017/11/18 Python
PyCharm设置SSH远程调试的方法
2018/07/17 Python
浅谈Python采集网页时正则表达式匹配换行符的问题
2018/12/20 Python
用Python逐行分析文件方法
2019/01/28 Python
使用python list 查找所有匹配元素的位置实例
2019/06/11 Python
python循环定时中断执行某一段程序的实例
2019/06/29 Python
python实现图片转字符画的完整代码
2021/02/21 Python
CSS3属性 line-clamp控制文本行数的使用
2020/03/19 HTML / CSS
Darphin迪梵官网: 来自巴黎,植物和精油调制的护肤品牌
2016/10/11 全球购物
zooplus意大利:在线宠物商店
2019/08/07 全球购物
机关保密承诺书
2014/06/03 职场文书
建筑结构施工求职信
2014/07/11 职场文书
寻衅滋事罪辩护词
2015/05/21 职场文书
2015年文秘个人工作总结
2015/10/14 职场文书
Java 实现限流器处理Rest接口请求详解流程
2021/11/02 Java/Android