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 相关文章推荐
实现了一个PHP5的getter/setter基类的代码
Feb 25 PHP
台湾中原大学php教程孙仲岳主讲
Jan 07 PHP
使用PHP Socket写的POP3类
Oct 30 PHP
php中curl、fsocket、file_get_content三个函数的使用比较
May 09 PHP
ThinkPHP标签制作教程
Jul 10 PHP
php中单个数据库字段多列显示(单字段分页、横向输出)
Jul 28 PHP
PHP中使用curl入门教程
Jul 02 PHP
thinkphp框架下404页面设置 仅三步
May 14 PHP
PHPExcel实现表格导出功能示例【带有多个工作sheet】
Jun 13 PHP
PhpStorm配置Xdebug调试的方法步骤
Feb 02 PHP
WordPress免插件实现面包屑导航的示例代码
Aug 20 PHP
PHP中的输出echo、print、printf、sprintf、print_r和var_dump的示例代码
Dec 01 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
snoopy 强大的PHP采集类使用实例代码
2010/12/09 PHP
php对关联数组循环遍历的实现方法
2015/03/13 PHP
PHP递归删除多维数组中的某个值
2017/04/17 PHP
仿迅雷焦点广告效果(JQuery版)
2008/11/19 Javascript
JavaScript(js)设置默认输入焦点(focus)
2012/12/28 Javascript
JS 两个字符串时间的天数差计算
2013/08/25 Javascript
自己动手实现jQuery Callbacks完整功能代码详解
2013/11/25 Javascript
javascript连续赋值问题
2015/07/08 Javascript
jQuery和hwSlider实现内容响应式可触控滑动切换效果附源码下载(二)
2016/06/22 Javascript
nodejs中使用HTTP分块响应和定时器示例代码
2017/03/19 NodeJs
Vue 2.0学习笔记之使用$refs访问Vue中的DOM
2017/12/19 Javascript
浅谈Vue网络请求之interceptors实际应用
2018/02/28 Javascript
详解关于element级联选择器数据回显问题
2019/02/20 Javascript
30分钟用Node.js构建一个API服务器的步骤详解
2019/05/24 Javascript
react+redux仿微信聊天界面
2019/06/21 Javascript
JavaScript如何把两个数组对象合并过程解析
2019/10/10 Javascript
JavaScript闭包相关知识解析
2019/10/19 Javascript
基于Vue实现微前端的示例代码
2020/04/24 Javascript
[05:20]卡尔工作室_DOTA2新手教学_DOTA2超强新手功能
2013/04/22 DOTA
日常整理python执行系统命令的常见方法(全)
2015/10/22 Python
Python编程之Re模块下的函数介绍
2017/10/28 Python
在Mac下使用python实现简单的目录树展示方法
2018/11/01 Python
pytorch中tensor.expand()和tensor.expand_as()函数详解
2019/12/27 Python
Python爬虫库BeautifulSoup获取对象(标签)名,属性,内容,注释
2020/01/25 Python
浅析border-radius如何兼容IE
2016/04/19 HTML / CSS
美国眼镜网站:EyeBuyDirect
2017/04/13 全球购物
小学生班会演讲稿
2014/01/09 职场文书
通信工程专业求职信
2014/06/04 职场文书
教师一帮一活动总结
2014/07/08 职场文书
土建施工员岗位职责
2014/07/16 职场文书
党员作风建设整改方案
2014/10/27 职场文书
乌镇导游词
2015/02/02 职场文书
2015年统计员个人工作总结
2015/07/23 职场文书
2016银行求职自荐信
2016/01/28 职场文书
浅析Python中的套接字编程
2021/06/22 Python
Python可变集合和不可变集合的构造方法大全
2021/12/06 Python