視圖是 MVC 模式中的一部分。 它是展示數據到終端用戶的代碼,在網頁應用中,根據視圖模板來創建視圖,視圖模板為PHP腳本文件, 主要包含HTML代碼和展示類PHP代碼,通過yii\web\View應用組件來管理, 該組件主要提供通用方法幫助視圖構造和渲染,簡單起見,我們稱視圖模板或視圖模板文件為視圖。
創建視圖
如前所述,視圖為包含HTML和PHP代碼的PHP腳本,如下代碼為一個登錄表單的視圖, 可看到PHP代碼用來生成動態內容如頁面標題和表單,HTML代碼把它組織成一個漂亮的HTML頁面。
<?php use 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() 進行轉碼,例如如下代碼將用戶名在顯示前先轉碼:
<?php use yii\helpers\Html; ?> <div class="username"> <?= Html::encode($user->name) ?> </div>
要顯示HTML內容,先調用 yii\helpers\HtmlPurifier 過濾內容,例如如下代碼將提交內容在顯示前先過濾:
<?php use 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 = [])
控制器中渲染
在 控制器 中,可調用以下控制器方法來渲染視圖:
例如:
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視圖組件提供的以下方法:
例如,視圖中的如下代碼會渲染該視圖所在目錄下的 _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');