Yii 自定义Widget Portlet

能够重用的小的代码模块,不涉及业务逻辑的,用在跟视图相关的方面比较多,一般把Sidebar,Navigation,Page，JS控件(上传，日历)封装成Widget,但Portlet生成的html系统会自动套2层div在html外面，改变了页面样式，可能操作页面样式布局js等失效

下面以一个随机广告图片为例说明Yii中Widget的用法 
1. 调用Widget

Java代码  

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

 或者

Java代码  

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

 也可以传参到Widget类

Java代码  

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

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

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

Java代码  

1. <?php  
2. class BannerMagic extends CWidget {  
3.     public function run(){  
4.     }  
5. }  

或者:

Java代码  

1. class MyWidget extends CWidget {  
2.     public function init() {  
3.         // 此方法会被 CController::beginWidget() 调用  
4.     }  
5.      public function run() {  
6.         // 此方法会被 CController::endWidget() 调用  
7.     }  
8. }  

 下面是是BannerMagicWidget实现，存储到protected\components\BannerMagicWidget.php

Java代码  

1. <?php class BannerMagicWidget extends CWidget {  
2.    public function run() {  
3.      $random = rand(1,3);  
4.      if ($random == 1) {  
5.        $advert = "advert1.jpg";  
6.      }  else if ($random == 2) {  
7.        $advert = "advert2.jpg";  
8.      }  else {  
9.        $advert = "advert3.jpg";  
10.      }   
11.      $this->render('bannermagic',array(  
12.        "advert"=>$advert,  
13.      ));  
14.    }  
15. }  

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

Java代码  

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

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

3. 调用该Widget

Java代码  

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

CPortlet继承自CWidget。这意味portlet作为一个widget，可以在用widget()方法在页面中插入.它覆盖了CPortlet类的 renderContent() 方法等

 protected\components\RecentComments.php  (1)

Java代码  

1. <?php  
2.   
3. Yii::import('zii.widgets.CPortlet');  
4.   
5. class RecentComments extends CPortlet  
6. {  
7.     public $title='Recent Comments'; //title   
8.     public $maxComments=10;  
9.   
10.     public function getRecentComments()  
11.     {  
12.         return Comment::model()->findRecentComments($this->maxComments);  
13.     }  
14.   
15.     protected function renderContent()  
16.     {  
17.         $this->render('recentComments'); //模板文件  
18.     }  
19. }  

protected\components\views\recentComments.php   模板文件(2)

Java代码  

1. <ul>  
2.     <?php foreach($this->getRecentComments() as $comment): ?>  
3.     <li><?php echo $comment->authorLink; ?> on  
4.         <?php echo CHtml::link(CHtml::encode($comment->post->title), $comment->getUrl()); ?>  
5.     </li>  
6.     <?php endforeach; ?>  
7. </ul>  

 调用方法 （3）

Java代码  

1. <?php $this->widget('RecentComments', array('maxComments'=>Yii::app()->params['recentCommentCount'],  
2. )); ?>