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

 更新时间:2020年05月15日 11:19:14   作者:人生如初见_张默  
这篇文章主要介绍了Yii框架小部件(Widgets)用法,结合实例形式详细分析了Yii框架小部件(Widgets)基本功能、创建、使用方法及操作注意事项,需要的朋友可以参考下

本文实例讲述了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相关内容感兴趣的读者可查看本站专题:《Yii框架入门及常用技巧总结》、《php优秀开发框架总结》、《smarty模板入门基础教程》、《php面向对象程序设计入门教程》、《php字符串(string)用法总结》、《php+mysql数据库操作入门教程》及《php常见数据库操作技巧汇总

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

相关文章

  • Symfony2函数用法实例分析

    Symfony2函数用法实例分析

    这篇文章主要介绍了Symfony2函数用法,结合实例形式分析了Symfony函数的调用及数据库操作的相关技巧,需要的朋友可以参考下
    2016-03-03
  • thinkPHP+ajax实现统计页面pv浏览量的方法

    thinkPHP+ajax实现统计页面pv浏览量的方法

    这篇文章主要介绍了thinkPHP+ajax实现统计页面pv浏览量的方法,涉及thinkPHP模板调用及数据库读写相关操作技巧,需要的朋友可以参考下
    2017-03-03
  • Yii2.0建立公共方法简单示例

    Yii2.0建立公共方法简单示例

    这篇文章主要介绍了Yii2.0建立公共方法,结合实例形式分析了Yii2.0建立公共方法的基本原理、步骤与相关操作注意事项,需要的朋友可以参考下
    2019-01-01
  • php 修改zen-cart下单和付款流程以防止漏单

    php 修改zen-cart下单和付款流程以防止漏单

    zen-cart进入第三方支付网站后,如果不能正常返回,则会造成客户已付款但后台却无订单数据的尴尬局面。本文就针对该问题给出一种解决方案,希望对被同样问题困扰的同行有所帮助。
    2010-03-03
  • PHP可变变量学习小结

    PHP可变变量学习小结

    可变变量,就是一个变量的变量名可以动态的设置和使用。语法形式是PHP的特殊语法,其他语言中少见,本文给大家分享php可变变量学习小结,对php可变变量相关知识感兴趣的朋友一起学习吧
    2015-11-11
  • Zend Framework教程之资源(Resources)用法实例详解

    Zend Framework教程之资源(Resources)用法实例详解

    这篇文章主要介绍了Zend Framework教程之资源(Resources)用法,结合实例形式详细分析了Resources的功能,定义,使用方法与相关注意事项,需要的朋友可以参考下
    2016-03-03
  • PHP抓屏函数实现屏幕快照代码分享

    PHP抓屏函数实现屏幕快照代码分享

    谁说抓图只能用QQ、用打印屏幕,PHP也能做到,本文主要介绍PHP抓屏函数实现屏幕快照的方法
    2014-01-01
  • PHP获取短链接跳转后的真实地址和响应头信息的方法

    PHP获取短链接跳转后的真实地址和响应头信息的方法

    这篇文章主要介绍了PHP获取短链接跳转后的真实地址和响应头信息的方法,本文使用get_headers函数实现,需要的朋友可以参考下
    2014-07-07
  • PHP使用SOAP调用.net的WebService数据

    PHP使用SOAP调用.net的WebService数据

    需要和一个.net系统进行数据交换,对方提供了一个WebService接口,使用PHP如何调用这个数据呢,下面就看看使用SOAP调用的方法吧
    2013-11-11
  • wamp下修改mysql访问密码的解决方法

    wamp下修改mysql访问密码的解决方法

    本篇文章是对wamp下修改mysql访问密码的方法进行了详细的介绍。需要的朋友参考下
    2013-05-05

最新评论