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 相关文章推荐
新安装的MySQL数据库需要注意的安全知识
Jul 30 PHP
学习php笔记 字符串处理
Oct 19 PHP
php数组函数序列之end() - 移动数组内部指针到最后一个元素,并返回该元素的值
Oct 31 PHP
php教程 插件机制在PHP中实现方案
Nov 02 PHP
在win7中搭建Linux+PHP 开发环境
Oct 08 PHP
Yii入门教程之目录结构、入口文件及路由设置
Nov 25 PHP
php中smarty模板条件判断用法实例
Jun 11 PHP
PHP去除字符串最后一个字符的三种方法实例
Mar 01 PHP
php表单文件iframe异步上传实例讲解
Jul 26 PHP
Yii2.0使用阿里云OSS的SDK上传图片、下载、删除图片示例
Sep 20 PHP
php安装扩展mysqli的实现步骤及报错解决办法
Sep 23 PHP
一文搞懂php的垃圾回收机制
Jun 18 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 获取客户端的真实ip
2009/11/30 PHP
php数据类型判断函数有哪些
2013/09/23 PHP
zf框架的数据库追踪器使用示例
2014/03/13 PHP
PHP利用APC模块实现文件上传进度条的方法
2015/01/26 PHP
详解PHP实现异步调用的4种方法
2016/03/14 PHP
使用phpQuery获取数组的实例
2017/03/13 PHP
PHP面向对象程序设计(OOP)之方法重写(override)操作示例
2018/12/21 PHP
JavaScript语句可以不以;结尾的烦恼
2007/03/08 Javascript
Javascript 原型和继承(Prototypes and Inheritance)
2009/04/01 Javascript
javascript 限制输入脚本大全
2009/11/03 Javascript
setInterval,setTimeout与jquery混用的问题
2013/04/08 Javascript
JavaScript中的常见问题解决方法(乱码,IE缓存,代理)
2013/11/28 Javascript
浅析JavaScript中的delete运算符
2013/11/30 Javascript
javascript去除字符串中所有标点符号和提取纯文本的正则
2014/06/07 Javascript
jQuery  ready方法实现原理详解
2016/10/19 Javascript
JS判断指定dom元素是否在屏幕内的方法实例
2017/01/23 Javascript
js+html5实现页面可刷新的倒计时效果
2017/07/15 Javascript
vue2.0 根据状态值进行样式的改变展示方法
2018/03/13 Javascript
echarts实现地图定时切换散点与多图表级联联动详解
2018/08/07 Javascript
基于JavaScript实现简单抽奖功能代码实例
2020/10/20 Javascript
Python赋值语句后逗号的作用分析
2015/06/08 Python
Python操作csv文件实例详解
2017/07/31 Python
Python实现按照指定要求逆序输出一个数字的方法
2018/04/19 Python
python对列进行平移变换的方法(shift)
2019/01/10 Python
五种Python转义表示法
2020/11/27 Python
HTML5 层的叠加的实现
2020/07/07 HTML / CSS
世界各地的当地人的食物体验:Eatwith
2019/07/26 全球购物
MIRTA官网:手工包,100%意大利制造
2020/02/11 全球购物
港湾网络笔试题
2014/04/19 面试题
厉行勤俭节约倡议书
2014/05/16 职场文书
意外伤害赔偿协议书范文
2014/09/23 职场文书
2014乡镇班子个人对照检查材料思想汇报
2014/09/26 职场文书
刑事上诉状范文
2015/05/22 职场文书
宝宝满月宴答谢词
2015/09/30 职场文书
Golang解析JSON对象
2022/04/30 Golang
Spring Cloud OAuth2实现自定义token返回格式
2022/06/25 Java/Android