PHP的Yii框架中View視圖的使用進(jìn)階

更新時間：2016年03月29日 16:08:53 投稿：goldensun

這篇文章主要介紹了PHP的Yii框架中View視圖的使用進(jìn)階,包括布局和數(shù)據(jù)塊的創(chuàng)建使用等,需要的朋友可以參考下

視圖名

渲染視圖時，可指定一個視圖名或視圖文件路徑/別名，大多數(shù)情況下使用前者因為前者簡潔靈活，我們稱用名字的視圖為視圖名.

視圖名可以依據(jù)以下規(guī)則到對應(yīng)的視圖文件路徑：

視圖名可省略文件擴(kuò)展名，這種情況下使用 .php 作為擴(kuò)展，視圖名 about 對應(yīng)到 about.php 文件名；
視圖名以雙斜杠 // 開頭，對應(yīng)的視圖文件路徑為 @app/views/ViewName，也就是說視圖文件在 yii\base\Application::viewPath 路徑下找，例如 //site/about 對應(yīng)到 @app/views/site/about.php。
視圖名以單斜杠/開始，視圖文件路徑以當(dāng)前使用模塊的yii\base\Module::viewPath開始，如果不存在模塊，使用@app/views/ViewName開始，例如，如果當(dāng)前模塊為user， /user/create 對應(yīng)成@app/modules/user/views/user/create.php, 如果不在模塊中，/user/create對應(yīng)@app/views/user/create.php。
如果 yii\base\View::context 渲染視圖并且上下文實現(xiàn)了 yii\base\ViewContextInterface, 視圖文件路徑由上下文的 yii\base\ViewContextInterface::getViewPath() 開始，這種主要用在控制器和小部件中渲染視圖，例如如果上下文為控制器SiteController，site/about 對應(yīng)到 @app/views/site/about.php。
如果視圖渲染另一個視圖，包含另一個視圖文件的目錄以當(dāng)前視圖的文件路徑開始，例如被視圖@app/views/post/index.php 渲染的 item 對應(yīng)到 @app/views/post/item。
根據(jù)以上規(guī)則，在控制器中 app\controllers\PostController 調(diào)用 $this->render('view')，實際上渲染@app/views/post/view.php 視圖文件，當(dāng)在該視圖文件中調(diào)用 $this->render('_overview') 會渲染@app/views/post/_overview.php 視圖文件。

視圖中訪問數(shù)據(jù)

在視圖中有兩種方式訪問數(shù)據(jù)：推送和拉取。

推送方式是通過視圖渲染方法的第二個參數(shù)傳遞數(shù)據(jù)，數(shù)據(jù)格式應(yīng)為名稱-值的數(shù)組，視圖渲染時，調(diào)用PHP extract() 方法將該數(shù)組轉(zhuǎn)換為視圖可訪問的變量。例如，如下控制器的渲染視圖代碼推送2個變量到 report 視圖：$foo = 1 和 $bar = 2。

echo $this->render('report', [
  'foo' => 1,
  'bar' => 2,
]);

拉取方式可讓視圖從yii\base\View視圖組件或其他對象中主動獲得數(shù)據(jù)(如Yii::$app)，在視圖中使用如下表達(dá)式$this->context可獲取到控制器ID，可讓你在report視圖中獲取控制器的任意屬性或方法，如以下代碼獲取控制器ID。

The controller ID is: <?= $this->context->id ?>
?>

推送方式讓視圖更少依賴上下文對象，是視圖獲取數(shù)據(jù)優(yōu)先使用方式，缺點(diǎn)是需要手動構(gòu)建數(shù)組，有些繁瑣，在不同地方渲染時容易出錯。

視圖間共享數(shù)據(jù)

yii\base\View視圖組件提供yii\base\View::params參數(shù)屬性來讓不同視圖共享數(shù)據(jù)。

例如在about視圖中，可使用如下代碼指定當(dāng)前breadcrumbs的當(dāng)前部分。

$this->params['breadcrumbs'][] = 'About Us';

在布局文件（也是一個視圖）中，可使用依次加入到y(tǒng)ii\base\View::params數(shù)組的值來生成顯示breadcrumbs:

<?= yii\widgets\Breadcrumbs::widget([
  'links' => isset($this->params['breadcrumbs']) ? $this->params['breadcrumbs'] : [],
]) ?>

布局

布局是一種特殊的視圖，代表多個視圖的公共部分，例如，大多數(shù)Web應(yīng)用共享相同的頁頭和頁尾，在每個視圖中重復(fù)相同的頁頭和頁尾，更好的方式是將這些公共放到一個布局中，渲染內(nèi)容視圖后在合適的地方嵌入到布局中。

創(chuàng)建布局

由于布局也是視圖，它可像普通視圖一樣創(chuàng)建，布局默認(rèn)存儲在@app/views/layouts路徑下，模塊中使用的布局應(yīng)存儲在yii\base\Module::basePath模塊目錄下的views/layouts路徑下，可配置yii\base\Module::layoutPath來自定義應(yīng)用或模塊的布局默認(rèn)路徑。

如下示例為一個布局大致內(nèi)容，注意作為示例，簡化了很多代碼，在實際中，你可能想添加更多內(nèi)容，如頭部標(biāo)簽，主菜單等。

<?php
use yii\helpers\Html;

/* @var $this yii\web\View */
/* @var $content string 字符串 */
?>
<?php $this->beginPage() ?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8"/>
  <?= Html::csrfMetaTags() ?>
  <title><?= Html::encode($this->title) ?></title>
  <?php $this->head() ?>
</head>
<body>
<?php $this->beginBody() ?>
  <header>My Company</header>
  <?= $content ?>
  <footer>&copy; 2014 by My Company</footer>
<?php $this->endBody() ?>
</body>
</html>
<?php $this->endPage() ?>

如上所示，布局生成每個頁面通用的HTML標(biāo)簽，在<body>標(biāo)簽中，打印$content變量， $content變量代表當(dāng)yii\base\Controller::render()控制器渲染方法調(diào)用時傳遞到布局的內(nèi)容視圖渲染結(jié)果。

大多數(shù)視圖應(yīng)調(diào)用上述代碼中的如下方法，這些方法觸發(fā)關(guān)于渲染過程的事件，這樣其他地方注冊的腳本和標(biāo)簽會添加到這些方法調(diào)用的地方。

yii\base\View::beginPage(): 該方法應(yīng)在布局的開始處調(diào)用，它觸發(fā)表明頁面開始的 yii\base\View::EVENT_BEGIN_PAGE 事件。
yii\base\View::endPage(): 該方法應(yīng)在布局的結(jié)尾處調(diào)用，它觸發(fā)表明頁面結(jié)尾的 yii\base\View::EVENT_END_PAGE 時間。
yii\web\View::head(): 該方法應(yīng)在HTML頁面的<head>標(biāo)簽中調(diào)用，它生成一個占位符，在頁面渲染結(jié)束時會被注冊的頭部HTML代碼（如，link標(biāo)簽, meta標(biāo)簽）替換。
yii\web\View::beginBody(): 該方法應(yīng)在<body>標(biāo)簽的開始處調(diào)用，它觸發(fā) yii\web\View::EVENT_BEGIN_BODY 事件并生成一個占位符，會被注冊的HTML代碼（如JavaScript）在頁面主體開始處替換。
yii\web\View::endBody(): 該方法應(yīng)在<body>標(biāo)簽的結(jié)尾處調(diào)用，它觸發(fā) yii\web\View::EVENT_END_BODY 事件并生成一個占位符，會被注冊的HTML代碼（如JavaScript）在頁面主體結(jié)尾處替換。

布局中訪問數(shù)據(jù)

在布局中可訪問兩個預(yù)定義變量：$this 和 $content，前者對應(yīng)和普通視圖類似的yii\base\View 視圖組件后者包含調(diào)用yii\base\Controller::render()方法渲染內(nèi)容視圖的結(jié)果。

如果想在布局中訪問其他數(shù)據(jù)，必須使用視圖中訪問數(shù)據(jù)一節(jié)介紹的拉取方式，如果想從內(nèi)容視圖中傳遞數(shù)據(jù)到布局，可使用視圖間共享數(shù)據(jù)一節(jié)中的方法。

使用布局

如控制器中渲染一節(jié)描述，當(dāng)控制器調(diào)用yii\base\Controller::render() 方法渲染視圖時，會同時使用布局到渲染結(jié)果中，默認(rèn)會使用@app/views/layouts/main.php布局文件。

可配置yii\base\Application::layout 或 yii\base\Controller::layout 使用其他布局文件，前者管理所有控制器的布局，后者覆蓋前者來控制單個控制器布局。例如，如下代碼使 post 控制器渲染視圖時使用 @app/views/layouts/post.php 作為布局文件，假如layout 屬性沒改變，控制器默認(rèn)使用 @app/views/layouts/main.php 作為布局文件。

namespace app\controllers;

use yii\web\Controller;

class PostController extends Controller
{
  public $layout = 'post';

  // ...
}

對于模塊中的控制器，可配置模塊的 yii\base\Module::layout 屬性指定布局文件應(yīng)用到模塊的所有控制器。

由于layout 可在不同層級（控制器、模塊，應(yīng)用）配置，在幕后Yii使用兩步來決定控制器實際使用的布局。

第一步，它決定布局的值和上下文模塊：

如果控制器的 yii\base\Controller::layout 屬性不為空null，使用它作為布局的值，控制器的 yii\base\Controller::module模塊作為上下文模塊。
如果 yii\base\Controller::layout 為空，從控制器的祖先模塊（包括應(yīng)用）開始找第一個yii\base\Module::layout 屬性不為空的模塊，使用該模塊作為上下文模塊，并將它的yii\base\Module::layout 的值作為布局的值，如果都沒有找到，表示不使用布局。
第二步，它決定第一步中布局的值和上下文模塊對應(yīng)到實際的布局文件，布局的值可為：

路徑別名 (如 @app/views/layouts/main).
絕對路徑 (如 /main): 布局的值以斜杠開始，在應(yīng)用的[[yii\base\Application::layoutPath|layout path] 布局路徑中查找實際的布局文件，布局路徑默認(rèn)為 @app/views/layouts。
相對路徑 (如 main): 在上下文模塊的yii\base\Module::layoutPath布局路徑中查找實際的布局文件，布局路徑默認(rèn)為yii\base\Module::basePath模塊目錄下的views/layouts 目錄。
布爾值 false: 不使用布局。
布局的值沒有包含文件擴(kuò)展名，默認(rèn)使用 .php作為擴(kuò)展名。

嵌套布局

有時候你想嵌套一個布局到另一個，例如，在Web站點(diǎn)不同地方，想使用不同的布局，同時這些布局共享相同的生成全局HTML5頁面結(jié)構(gòu)的基本布局，可以在子布局中調(diào)用 yii\base\View::beginContent() 和yii\base\View::endContent() 方法，如下所示：

<?php $this->beginContent('@app/views/layouts/base.php'); ?>

...child layout content here...

<?php $this->endContent(); ?>

如上所示，子布局內(nèi)容應(yīng)在 yii\base\View::beginContent() 和 yii\base\View::endContent() 方法之間，傳給 yii\base\View::beginContent() 的參數(shù)指定父布局，父布局可為布局文件或別名。

使用以上方式可多層嵌套布局。

使用數(shù)據(jù)塊

數(shù)據(jù)塊可以在一個地方指定視圖內(nèi)容在另一個地方顯示，通常和布局一起使用，例如，可在內(nèi)容視圖中定義數(shù)據(jù)塊在布局中顯示它。

調(diào)用 yii\base\View::beginBlock() 和 yii\base\View::endBlock() 來定義數(shù)據(jù)塊，使用 $view->blocks[$blockID] 訪問該數(shù)據(jù)塊，其中 $blockID 為定義數(shù)據(jù)塊時指定的唯一標(biāo)識ID。

如下實例顯示如何在內(nèi)容視圖中使用數(shù)據(jù)塊讓布局使用。

首先，在內(nèi)容視圖中定一個或多個數(shù)據(jù)塊：

...

<?php $this->beginBlock('block1'); ?>

...content of block1...

<?php $this->endBlock(); ?>

...

<?php $this->beginBlock('block3'); ?>

...content of block3...

<?php $this->endBlock(); ?>

然后，在布局視圖中，數(shù)據(jù)塊可用的話會渲染數(shù)據(jù)塊，如果數(shù)據(jù)未定義則顯示一些默認(rèn)內(nèi)容。

...
<?php if (isset($this->blocks['block1'])): ?>
  <?= $this->blocks['block1'] ?>
<?php else: ?>
  ... default content for block1 ...
<?php endif; ?>

...

<?php if (isset($this->blocks['block2'])): ?>
  <?= $this->blocks['block2'] ?>
<?php else: ?>
  ... default content for block2 ...
<?php endif; ?>

...

<?php if (isset($this->blocks['block3'])): ?>
  <?= $this->blocks['block3'] ?>
<?php else: ?>
  ... default content for block3 ...
<?php endif; ?>
...

使用視圖組件

yii\base\View視圖組件提供許多視圖相關(guān)特性，可創(chuàng)建yii\base\View或它的子類實例來獲取視圖組件，大多數(shù)情況下主要使用 view應(yīng)用組件，可在應(yīng)用配置中配置該組件，如下所示：

[
  // ...
  'components' => [
    'view' => [
      'class' => 'app\components\View',
    ],
    // ...
  ],
]

視圖組件提供如下實用的視圖相關(guān)特性，每項詳情會在獨(dú)立章節(jié)中介紹：

主題: 允許為你的Web站點(diǎn)開發(fā)和修改主題；
片段緩存: 允許你在Web頁面中緩存片段；
客戶腳本處理: 支持CSS 和 JavaScript 注冊和渲染；
資源包處理: 支持資源包的注冊和渲染；
模板引擎: 允許你使用其他模板引擎，如 Twig, Smarty。

開發(fā)Web頁面時，也可能頻繁使用以下實用的小特性。

設(shè)置頁面標(biāo)題

每個Web頁面應(yīng)有一個標(biāo)題，正常情況下標(biāo)題的標(biāo)簽顯示在布局中，但是實際上標(biāo)題大多由內(nèi)容視圖而不是布局來決定，為解決這個問題， yii\web\View 提供 yii\web\View::title 標(biāo)題屬性可讓標(biāo)題信息從內(nèi)容視圖傳遞到布局中。

為利用這個特性，在每個內(nèi)容視圖中設(shè)置頁面標(biāo)題，如下所示：

<?php
$this->title = 'My page title';
?>
然后在視圖中，確保在 <head> 段中有如下代碼：

<title><?= Html::encode($this->title) ?></title>

注冊Meta元標(biāo)簽

Web頁面通常需要生成各種元標(biāo)簽提供給不同的瀏覽器，如<head>中的頁面標(biāo)題，元標(biāo)簽通常在布局中生成。

如果想在內(nèi)容視圖中生成元標(biāo)簽，可在內(nèi)容視圖中調(diào)用yii\web\View::registerMetaTag()方法，如下所示：

<?php
$this->registerMetaTag(['name' => 'keywords', 'content' => 'yii, framework, php']);
?>

以上代碼會在視圖組件中注冊一個 "keywords" 元標(biāo)簽，在布局渲染后會渲染該注冊的元標(biāo)簽，然后，如下HTML代碼會插入到布局中調(diào)用yii\web\View::head()方法處：

<meta name="keywords" content="yii, framework, php">

注意如果多次調(diào)用 yii\web\View::registerMetaTag() 方法，它會注冊多個元標(biāo)簽，注冊時不會檢查是否重復(fù)。

為確保每種元標(biāo)簽只有一個，可在調(diào)用方法時指定鍵作為第二個參數(shù)，例如，如下代碼注冊兩次 "description" 元標(biāo)簽，但是只會渲染第二個。

$this->registerMetaTag(['name' => 'description', 'content' => 'This is my cool website made with Yii!'], 'description');
$this->registerMetaTag(['name' => 'description', 'content' => 'This website is about funny raccoons.'], 'description');

注冊鏈接標(biāo)簽

和 Meta標(biāo)簽類似，鏈接標(biāo)簽有時很實用，如自定義網(wǎng)站圖標(biāo)，指定Rss訂閱，或授權(quán)OpenID到其他服務(wù)器。可以和元標(biāo)簽相似的方式調(diào)用yii\web\View::registerLinkTag()，例如，在內(nèi)容視圖中注冊鏈接標(biāo)簽如下所示：

$this->registerLinkTag([
  'title' => 'Live News for Yii',
  'rel' => 'alternate',
  'type' => 'application/rss+xml',
  'href' => 'http://www.yiiframework.com/rss.xml/',
]);

上述代碼會轉(zhuǎn)換成

復(fù)制代碼代碼如下:

和 yii\web\View::registerMetaTag() 類似，調(diào)用yii\web\View::registerLinkTag() 指定鍵來避免生成重復(fù)鏈接標(biāo)簽。

視圖事件

yii\base\View 視圖組件會在視圖渲染過程中觸發(fā)幾個事件，可以在內(nèi)容發(fā)送給終端用戶前，響應(yīng)這些事件來添加內(nèi)容到視圖中或調(diào)整渲染結(jié)果。

yii\base\View::EVENT_BEFORE_RENDER: 在控制器渲染文件開始時觸發(fā)，該事件可設(shè)置 yii\base\ViewEvent::isValid 為 false 取消視圖渲染。
yii\base\View::EVENT_AFTER_RENDER: 在布局中調(diào)用 yii\base\View::beginPage() 時觸發(fā)，該事件可獲取yii\base\ViewEvent::output的渲染結(jié)果，可修改該屬性來修改渲染結(jié)果。
yii\base\View::EVENT_BEGIN_PAGE: 在布局調(diào)用 yii\base\View::beginPage() 時觸發(fā)；
yii\base\View::EVENT_END_PAGE: 在布局調(diào)用 yii\base\View::endPage() 是觸發(fā)；
yii\web\View::EVENT_BEGIN_BODY: 在布局調(diào)用 yii\web\View::beginBody() 時觸發(fā)；
yii\web\View::EVENT_END_BODY: 在布局調(diào)用 yii\web\View::endBody() 時觸發(fā)。

例如，如下代碼將當(dāng)前日期添加到頁面結(jié)尾處：

\Yii::$app->view->on(View::EVENT_END_BODY, function () {
  echo date('Y-m-d');
});

渲染靜態(tài)頁面

靜態(tài)頁面指的是大部分內(nèi)容為靜態(tài)的不需要控制器傳遞動態(tài)數(shù)據(jù)的Web頁面。

可將HTML代碼放置在視圖中，在控制器中使用以下代碼輸出靜態(tài)頁面：

public function actionAbout()
{
  return $this->render('about');
}

如果Web站點(diǎn)包含很多靜態(tài)頁面，多次重復(fù)相似的代碼顯得很繁瑣，為解決這個問題，可以使用一個在控制器中稱為 yii\web\ViewAction 的獨(dú)立操作。例如：

namespace app\controllers;

use yii\web\Controller;

class SiteController extends Controller
{
  public function actions()
  {
    return [
      'page' => [
        'class' => 'yii\web\ViewAction',
      ],
    ];
  }
}

現(xiàn)在如果你在@app/views/site/pages目錄下創(chuàng)建名為 about 的視圖，可通過如下rul顯示該視圖：

http://localhost/index.php?r=site/page&view=about
GET 中 view 參數(shù)告知 yii\web\ViewAction 操作請求哪個視圖，然后操作在 @app/views/site/pages目錄下尋找該視圖，可配置 yii\web\ViewAction::viewPrefix 修改搜索視圖的目錄。

最佳實踐

視圖負(fù)責(zé)將模型的數(shù)據(jù)展示用戶想要的格式，總之，視圖

應(yīng)主要包含展示代碼，如HTML, 和簡單的PHP代碼來控制、格式化和渲染數(shù)據(jù)；
不應(yīng)包含執(zhí)行數(shù)據(jù)查詢代碼，這種代碼放在模型中；
應(yīng)避免直接訪問請求數(shù)據(jù)，如 $_GET, $_POST，這種應(yīng)在控制器中執(zhí)行，如果需要請求數(shù)據(jù)，應(yīng)由控制器推送到視圖。
可讀取模型屬性，但不應(yīng)修改它們。
為使模型更易于維護(hù)，避免創(chuàng)建太復(fù)雜或包含太多冗余代碼的視圖，可遵循以下方法達(dá)到這個目標(biāo)：
使用布局來展示公共代碼（如，頁面頭部、尾部）；
將復(fù)雜的視圖分成幾個小視圖，可使用上面描述的渲染方法將這些小視圖渲染并組裝成大視圖；
創(chuàng)建并使用小部件作為視圖的數(shù)據(jù)塊；
創(chuàng)建并使用助手類在視圖中轉(zhuǎn)換和格式化數(shù)據(jù)。

您可能感興趣的文章: