Yii_Widget_how_to_use_使用

Yii_Widget_how_to_use_使用

1. 调用Widget

<?php 
$this
->widget(
'WidgetName'
); ?>

或者

<?php 
$widget
=
$this
->beginWidget(
'path.to.WidgetClass'
); ?>
...可能会由小物件获取的内容主体...
<?php $this
->endWidget(); ?>

也可以传参到Widget类

<?php 
$userId
 = 1; ?>
<?php $this
->widget(
'WidgetName'
,
array
(
'userId'
=>
$userId
)); ?>

参数userId自动映射到Widget类的同名属性，所以在定义Widget时，别忘记了声明该属性。

2. 创建Widget
自定义Widget类要继承CWidget,覆盖方法run

<?php
class
 BannerMagic 
extends
 CWidget {
    public
 
function
 run(){
    }
}

或者:

class
 MyWidget 
extends
 CWidget {
    public
 
function
 init() {
        // 此方法会被 CController::beginWidget() 调用
    }
     public
 
function
 run() {
        // 此方法会被 CController::endWidget() 调用
    }
}

下面是是BannerMagicWidget实现

<?php 
class
 BannerMagicWidget 
extends
 CWidget {
   public
 
function
 run() {
     $random
 = rand(1,3);
     if
 (
$random
 == 1) {
       $advert
 = 
"advert1.jpg"
;
     }  else
 
if
 (
$random
 == 2) {
       $advert
 = 
"advert2.jpg"
;
     }  else
 {
       $advert
 = 
"advert3.jpg"
;
     }
     $this
->render(
'bannermagic'
,
array
(
       "advert"
=>
$advert
,
     ));
   }
}

存储到protected\components\BannerMagicWidget.php

对应的view文件可能的内容如下：

<img src=
"images/adverts/<?php echo $advert; ?>"
 alt=
"whatever"
 />

存储到protected\components\views\bannermagic.php

Widget视图的目录：

这里注意：widget类中也可以像controller一样使用视图，视图的位置：Widget类所在的目录/views/，不是在protected的iews下面。

官方文档真nnd晦涩，刚才我用中文也不容易表达：By default, widget view files are located under the views subdirectory of the directory containing the widget class file.

结果看看源码才懂：

        $className=get_class($this);
        $class=new ReflectionClass($className);
        $path = dirname($class->getFileName()).DIRECTORY_SEPARATOR.'views';

 
3. 调用该Widget

<?php 
$this
->widget(
'BannerMagicWidget'
); ?>

 

大部分来源：http://koda.iteye.com/blog/1134606，有改动和增加。