PHP的Yii架構中建立視圖和渲染視圖的方法詳解_php技巧

視圖是 MVC 模式中的一部分。 它是展示資料到終端使用者的代碼，在網頁應用中，根據視圖模板來建立視圖，視圖模板為PHP指令檔， 主要包含HTML代碼和展示類PHP代碼，通過yii\web\View應用組件來管理， 該組件主要提供通用方法協助視圖構造和渲染，簡單起見，我們稱視圖模板或視圖模板檔案為視圖。

建立視圖

如前所述，視圖為包含HTML和PHP代碼的PHP指令碼，如下代碼為一個登入表單的視圖， 可看到PHP代碼用來產生動態內容如頁面標題和表單，HTML代碼把它組織成一個漂亮的HTML頁面。

<?phpuse yii\helpers\Html;use yii\widgets\ActiveForm;/* @var $this yii\web\View *//* @var $form yii\widgets\ActiveForm *//* @var $model app\models\LoginForm */$this->title = 'Login';?><h1><?= Html::encode($this->title) ?></h1><p>Please fill out the following fields to login:</p><?php $form = ActiveForm::begin(); ?>  <?= $form->field($model, 'username') ?>  <?= $form->field($model, 'password')->passwordInput() ?>  <?= Html::submitButton('Login') ?><?php ActiveForm::end(); ?>

在視圖中，可訪問 $this 指向 yii\web\View 來管理和渲染這個視圖檔案。

除了 $this之外，上述樣本中的視圖有其他預定義變數如 $model， 這些變數代表從控制器或其他觸發視圖渲染的對象 傳入 到視圖的資料。

技巧: 將預定義變數列到視圖檔案頭部注釋處，這樣可被IDE編輯器識別，也是產生視圖文檔的好方法。
安全

當建立產生HTML頁面的視圖時，在顯示之前將使用者輸入資料進行轉碼和過濾非常重要， 否則，你的應用可能會被跨站指令碼 攻擊。

要顯示純文字，先調用 yii\helpers\Html::encode() 進行轉碼，例如如下代碼將使用者名稱在顯示前先轉碼：

<?phpuse yii\helpers\Html;?><div class="username">  <?= Html::encode($user->name) ?></div>

要顯示HTML內容，先調用 yii\helpers\HtmlPurifier 過濾內容，例如如下代碼將提交內容在顯示前先過濾：

<?phpuse yii\helpers\HtmlPurifier;?><div class="post">  <?= HtmlPurifier::process($post->text) ?></div>

技巧：HTMLPurifier在保證輸出資料安全上做的不錯，但效能不佳，如果你的應用需要高效能可考慮 緩衝 過濾後的結果。

組織視圖

與 控制器 和 模型 類似，在組織視圖上有一些約定：

控制器渲染的視圖檔案預設放在 @app/views/ControllerID 目錄下， 其中 ControllerID 對應 控制器 ID, 例如控制器類為PostController，視圖檔案目錄應為 @app/views/post， 控制器類 PostCommentController對應的目錄為@app/views/post-comment， 如果是模組中的控制器，目錄應為 yii\base\Module::basePath 模組目錄下的views/ControllerID 目錄；
對於 小組件 渲染的視圖檔案預設放在 WidgetPath/views 目錄， 其中 WidgetPath 代表小組件類檔案所在的目錄；
對於其他對象渲染的視圖檔案，建議遵循和小組件相似的規則。
可覆蓋控制器或小組件的 yii\base\ViewContextInterface::getViewPath() 方法來自訂視圖檔案預設目錄。

渲染視圖

可在 控制器, 小組件, 或其他地方調用渲染視圖方法來渲染視圖， 該方法類似以下格式：

/** * @param string $view 視圖名或檔案路徑，由實際的渲染方法決定 * @param array $params 傳遞給視圖的資料 * @return string 渲染結果 */methodName($view, $params = [])

控制器中渲染

在 控制器 中，可調用以下控制器方法來渲染視圖：

• yii\base\Controller::render(): 渲染一個 視圖名 並使用一個 布局 返回到渲染結果。
• yii\base\Controller::renderPartial(): 渲染一個 視圖名 並且不使用布局。
• yii\web\Controller::renderAjax(): 渲染一個 視圖名 並且不使用布局， 並注入所有註冊的JS/CSS指令碼和檔案，通常使用在響應AJAX網頁請求的情況下。
• yii\base\Controller::renderFile(): 渲染一個視圖檔案目錄或別名下的視圖檔案。

例如：

namespace app\controllers;use Yii;use app\models\Post;use yii\web\Controller;use yii\web\NotFoundHttpException;class PostController extends Controller{  public function actionView($id)  {    $model = Post::findOne($id);    if ($model === null) {      throw new NotFoundHttpException;    }    // 渲染一個名稱為"view"的視圖並使用布局    return $this->render('view', [      'model' => $model,    ]);  }}

小物件
小物件是 CWidget 或其子類的執行個體.它是一個主要用於表現資料的組件.小物件通常內嵌於一個視圖來產生一些複雜而獨立的使用者介面.例如,一個日曆小物件可用於渲染一個複雜的日曆介面.小物件使使用者介面更加可複用.

我們可以按如下視圖指令碼來使用一個小物件:

<?php $this->beginWidget('path.to.WidgetClass'); ?>...可能會由小物件擷取的內容主體...<?php $this->endWidget(); ?>

或者

<?php $this->widget('path.to.WidgetClass'); ?>

後者用於不需要任何 body 內容的組件.

小物件可通過配置來定製它的表現.這是通過調用 CBaseController::beginWidget 或 CBaseController::widget 設定其初始化屬性值來完成的.例如,當使用 CMaskedTextField 小物件時,我們想指定被使用的 mask （可理解為一種輸出格式，譯者注）.我們通過傳遞一個攜帶這些屬性初始化值的數組來實現.這裡的數組的鍵是屬性的名稱,而數組的值則是小物件屬性所對應的值.正如以下所示 :

<?php$this->widget('CMaskedTextField',array(  'mask'=>'99/99/9999'));?>

繼承 CWidget 並覆蓋其init() 和 run() 方法,可以定義一個新的小物件:

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

小物件可以像一個控制器一樣擁有它自己的視圖.預設情況下,小物件的視圖檔案位於包含了小物件類檔案目錄的 views 子目錄之下.這些視圖可以通過調用 CWidget::render() 渲染,這一點和控制器很相似.唯一不同的是,小物件的視圖沒有布局檔案支援。另外，小物件視圖中的$this指向小物件執行個體而不是控制器執行個體。

視圖中渲染

可以在視圖中渲染另一個視圖，可以調用yii\base\View視圖組件提供的以下方法：

• yii\base\View::render(): 渲染一個 視圖名.
• yii\web\View::renderAjax(): 渲染一個 視圖名 並注入所有註冊的JS/CSS指令碼和檔案，通常使用在響應AJAX網頁請求的情況下。
• yii\base\View::renderFile(): 渲染一個視圖檔案目錄或別名下的視圖檔案。

例如，視圖中的如下代碼會渲染該視圖所在目錄下的 _overview.php 視圖檔案， 記住視圖中 $this 對應 yii\base\View 組件:

<?= $this->render('_overview') ?>

其他地方渲染

在任何地方都可以通過運算式 Yii::$app->view 訪問 yii\base\View 應用組件， 調用它的如前所述的方法渲染視圖，例如：

// 顯示視圖檔案 "@app/views/site/license.php"echo \Yii::$app->view->renderFile('@app/views/site/license.php');