視圖是 MVC 模式中的一部分。 它是展示數(shù)據(jù)到終端用戶的代碼,在網(wǎng)頁(yè)應(yīng)用中,根據(jù)視圖模板來(lái)創(chuàng)建視圖,視圖模板為PHP腳本文件, 主要包含HTML代碼和展示類PHP代碼,通過(guò)yii\web\View應(yīng)用組件來(lái)管理, 該組件主要提供通用方法幫助視圖構(gòu)造和渲染,簡(jiǎn)單起見(jiàn),我們稱視圖模板或視圖模板文件為視圖。
創(chuàng)建視圖
如前所述,視圖為包含HTML和PHP代碼的PHP腳本,如下代碼為一個(gè)登錄表單的視圖, 可看到PHP代碼用來(lái)生成動(dòng)態(tài)內(nèi)容如頁(yè)面標(biāo)題和表單,HTML代碼把它組織成一個(gè)漂亮的HTML頁(yè)面。
<?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(); ?>
在視圖中,可訪問(wèn) $this 指向 yii\web\View 來(lái)管理和渲染這個(gè)視圖文件。
除了 $this之外,上述示例中的視圖有其他預(yù)定義變量如 $model, 這些變量代表從控制器或其他觸發(fā)視圖渲染的對(duì)象 傳入 到視圖的數(shù)據(jù)。
技巧: 將預(yù)定義變量列到視圖文件頭部注釋處,這樣可被IDE編輯器識(shí)別,也是生成視圖文檔的好方法。
安全
當(dāng)創(chuàng)建生成HTML頁(yè)面的視圖時(shí),在顯示之前將用戶輸入數(shù)據(jù)進(jìn)行轉(zhuǎn)碼和過(guò)濾非常重要, 否則,你的應(yīng)用可能會(huì)被跨站腳本 攻擊。
要顯示純文本,先調(diào)用 yii\helpers\Html::encode() 進(jìn)行轉(zhuǎn)碼,例如如下代碼將用戶名在顯示前先轉(zhuǎn)碼:
<?php
use yii\helpers\Html;
?>
<div class="username">
<?= Html::encode($user->name) ?>
</div>
要顯示HTML內(nèi)容,先調(diào)用 yii\helpers\HtmlPurifier 過(guò)濾內(nèi)容,例如如下代碼將提交內(nèi)容在顯示前先過(guò)濾:
<?php
use yii\helpers\HtmlPurifier;
?>
<div class="post">
<?= HtmlPurifier::process($post->text) ?>
</div>
技巧:HTMLPurifier在保證輸出數(shù)據(jù)安全上做的不錯(cuò),但性能不佳,如果你的應(yīng)用需要高性能可考慮 緩存 過(guò)濾后的結(jié)果。
組織視圖
與 控制器 和 模型 類似,在組織視圖上有一些約定:
控制器渲染的視圖文件默認(rèn)放在 @app/views/ControllerID 目錄下, 其中 ControllerID 對(duì)應(yīng) 控制器 ID, 例如控制器類為PostController,視圖文件目錄應(yīng)為 @app/views/post, 控制器類 PostCommentController對(duì)應(yīng)的目錄為@app/views/post-comment, 如果是模塊中的控制器,目錄應(yīng)為 yii\base\Module::basePath 模塊目錄下的views/ControllerID 目錄;
對(duì)于 小部件 渲染的視圖文件默認(rèn)放在 WidgetPath/views 目錄, 其中 WidgetPath 代表小部件類文件所在的目錄;
對(duì)于其他對(duì)象渲染的視圖文件,建議遵循和小部件相似的規(guī)則。
可覆蓋控制器或小部件的 yii\base\ViewContextInterface::getViewPath() 方法來(lái)自定義視圖文件默認(rèn)目錄。
渲染視圖
可在 控制器, 小部件, 或其他地方調(diào)用渲染視圖方法來(lái)渲染視圖, 該方法類似以下格式:
/**
* @param string $view 視圖名或文件路徑,由實(shí)際的渲染方法決定
* @param array $params 傳遞給視圖的數(shù)據(jù)
* @return string 渲染結(jié)果
*/
methodName($view, $params = [])
控制器中渲染
在 控制器 中,可調(diào)用以下控制器方法來(lái)渲染視圖:
yii\base\Controller::render(): 渲染一個(gè) 視圖名 并使用一個(gè) 布局 返回到渲染結(jié)果。
yii\base\Controller::renderPartial(): 渲染一個(gè) 視圖名 并且不使用布局。
yii\web\Controller::renderAjax(): 渲染一個(gè) 視圖名 并且不使用布局, 并注入所有注冊(cè)的JS/CSS腳本和文件,通常使用在響應(yīng)AJAX網(wǎng)頁(yè)請(qǐng)求的情況下。
yii\base\Controller::renderFile(): 渲染一個(gè)視圖文件目錄或別名下的視圖文件。
例如:
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;
}
// 渲染一個(gè)名稱為"view"的視圖并使用布局
return $this->render('view', [
'model' => $model,
]);
}
}
小物件
小物件是 CWidget 或其子類的實(shí)例.它是一個(gè)主要用于表現(xiàn)數(shù)據(jù)的組件.小物件通常內(nèi)嵌于一個(gè)視圖來(lái)產(chǎn)生一些復(fù)雜而獨(dú)立的用戶界面.例如,一個(gè)日歷小物件可用于渲染一個(gè)復(fù)雜的日歷界面.小物件使用戶界面更加可復(fù)用.
我們可以按如下視圖腳本來(lái)使用一個(gè)小物件:
<?php $this->beginWidget('path.to.WidgetClass'); ?>
...可能會(huì)由小物件獲取的內(nèi)容主體...
<?php $this->endWidget(); ?>
或者
<?php $this->widget('path.to.WidgetClass'); ?>
后者用于不需要任何 body 內(nèi)容的組件.
小物件可通過(guò)配置來(lái)定制它的表現(xiàn).這是通過(guò)調(diào)用 CBaseController::beginWidget 或 CBaseController::widget 設(shè)置其初始化屬性值來(lái)完成的.例如,當(dāng)使用 CMaskedTextField 小物件時(shí),我們想指定被使用的 mask (可理解為一種輸出格式,譯者注).我們通過(guò)傳遞一個(gè)攜帶這些屬性初始化值的數(shù)組來(lái)實(shí)現(xiàn).這里的數(shù)組的鍵是屬性的名稱,而數(shù)組的值則是小物件屬性所對(duì)應(yīng)的值.正如以下所示 :
<?php
$this->widget('CMaskedTextField',array(
'mask'=>'99/99/9999'
));
?>
繼承 CWidget 并覆蓋其init() 和 run() 方法,可以定義一個(gè)新的小物件:
class MyWidget extends CWidget
{
public function init()
{
// 此方法會(huì)被 CController::beginWidget() 調(diào)用
}
public function run()
{
// 此方法會(huì)被 CController::endWidget() 調(diào)用
}
}
小物件可以像一個(gè)控制器一樣擁有它自己的視圖.默認(rèn)情況下,小物件的視圖文件位于包含了小物件類文件目錄的 views 子目錄之下.這些視圖可以通過(guò)調(diào)用 CWidget::render() 渲染,這一點(diǎn)和控制器很相似.唯一不同的是,小物件的視圖沒(méi)有布局文件支持。另外,小物件視圖中的$this指向小物件實(shí)例而不是控制器實(shí)例。
視圖中渲染
可以在視圖中渲染另一個(gè)視圖,可以調(diào)用yii\base\View視圖組件提供的以下方法:
yii\base\View::render(): 渲染一個(gè) 視圖名.
yii\web\View::renderAjax(): 渲染一個(gè) 視圖名 并注入所有注冊(cè)的JS/CSS腳本和文件,通常使用在響應(yīng)AJAX網(wǎng)頁(yè)請(qǐng)求的情況下。
yii\base\View::renderFile(): 渲染一個(gè)視圖文件目錄或別名下的視圖文件。
例如,視圖中的如下代碼會(huì)渲染該視圖所在目錄下的 _overview.php 視圖文件, 記住視圖中 $this 對(duì)應(yīng) yii\base\View 組件:
<?= $this->render('_overview') ?>
其他地方渲染
在任何地方都可以通過(guò)表達(dá)式 Yii::$app->view 訪問(wèn) yii\base\View 應(yīng)用組件, 調(diào)用它的如前所述的方法渲染視圖,例如:
// 顯示視圖文件 "@app/views/site/license.php"
echo \Yii::$app->view->renderFile('@app/views/site/license.php');