Yii2中定義自己的Widget

1. 調用Widget 

Php代碼，在需要調用的view層頁面中：　

<?=HotWidget::widget()?>

或者 將內容包含在H1標簽中，頁面中代碼為：

<?php
   use frontend\widgets\hot\HotWidget;
?>
<?php HotWidget::begin(); ?>
   第一個Widget在H1標簽中
<?php HotWidget::end(); ?>

 

請注意，我們使用 ob_start()函數來緩沖輸出，對應的HotWidget中代碼為：

<?php
   namespace frontend\widgets\hot;
   use yii\base\Widget;
   class HotWidget extends Widget {
      public function init() {
         parent::init();
         ob_start();
      }
      public function run() {
         $content = ob_get_clean();
         return "<h1>$content</h1>";
      }
   }
?>  

也可以傳參到Widget類 

<?=PostWidget::widget(['limit' => 1, 'title' => 'More 文章'] );?>

參數limit , title 自動映射到Widget類的同名屬性，所以在定義Widget時，別忘記了聲明該屬性。 

2. 創建Widget 

  要創建一個窗口小部件，應該擴展類 yii\base\Widget或者是類yii\bootstrap\Widget。
  那么需要重寫 yii\base\Widget::init() 和 yii\base\Widget::run() 函數。
  run()函數將返回渲染的結果。
  init()函數將標准化小部件的屬性。

 

<?php

namespace frontend\widgets\post;

use yii\base\Widget;

class PostWidget extends Widget
{
    /**
     * [$title 文章列表]
     * @var string
     */
    public $title = '';
    /**
     * [$limit 顯示條數]
     * @var integer
     */
    public $limit = 6;
    
    public function run ()
    {
        
        return $this->render('index', ['data' => $result]);
    }
}

 

或者,同時包括init 和 run:

<?php
namespace frontend\widgets\banner;

use Yii;
use yii\bootstrap\Widget;

class BannerWidget extends Widget
{
    public $items = [];

    public function init()
    {
        parent::init();
        ob_start();
    }

    public function run()
    {
         $content = ob_get_clean();
         return "<h1>$content</h1>";
    }
}

 

要點
窗口小部件應該 -
要在MVC模式下創建。應該保持表現層在視圖，邏輯在窗口小部件(widget)類。
設計成自包含的。最終開發人員應該能夠將它設計到一個視圖。