# 快速入門(十):公共模板和模板布局
我們學習了模板的輸出后,就會發現很多應用存在大量的模板文件,如何簡化模板文件的定義和公共調用就成了關鍵,ThinkPHP的模板引擎內置了公共模板和布局模板功能支持,可以方便的規劃和公用你的模板文件。
## 公共模板
在當前模版文件中包含其他公用的模版文件使用include標簽,標簽用法:
~~~
<include file='模版表達式或者模版文件1,模版表達式或者模版文件2,...' />
~~~
### 使用模版表達式
模版表達式的定義規則為:
~~~
模塊@主題/控制器/操作
~~~
例如:
~~~
<include file="Public/header" /> // 包含頭部模版header
<include file="Public/menu" /> // 包含菜單模版menu
<include file="Blue/Public/menu" /> // 包含blue主題下面的menu模版
~~~
可以一次包含多個模版,例如:
~~~
<include file="Public/header,Public/menu" />
~~~
> 注意,包含模版文件并不會自動調用控制器的方法,也就是說包含的其他模版文件中的變量賦值需要在當前操作中完成。
### 使用模版文件
可以直接包含一個模版文件名(包含完整路徑),例如:
~~~
<include file="./Application/Home/View/default/Public/header.html" />
~~~
### 傳入參數
無論你使用什么方式包含外部模板,Include標簽支持在包含文件的同時傳入參數,例如,下面的例子我們在包含header模板的時候傳入了title和keywords變量:
~~~
<include file="Public/header" title="ThinkPHP框架" keywords="開源WEB開發框架" />
~~~
就可以在包含的header.html文件里面使用title和keywords變量,如下:
~~~
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>[title]</title>
<meta name="keywords" content="[keywords]" />
</head>
~~~
注意:如果外部模板有所更改,模板引擎并不會重新編譯模板,除非在調試模式下或者緩存已經過期。如果部署模式下修改了包含的外部模板文件后,需要把模塊的緩存目錄清空,否則無法生效。
## 模板布局
有三種布局模板的支持方式:
### 第一種方式:全局配置方式
這種方式僅需在項目配置文件中添加相關的布局模板配置,就可以簡單實現模板布局功能,比較適用于全站使用相同布局的情況,需要配置開啟`LAYOUT_ON` 參數(默認不開啟),并且設置布局入口文件名`LAYOUT_NAME`(默認為layout)。
~~~
'LAYOUT_ON'=>true,
'LAYOUT_NAME'=>'layout',
~~~
開啟LAYOUT_ON后,我們的模板渲染流程就有所變化,例如:
~~~
<?php
namespace Home\Controller;
use Think\Controller;
Class UserController extends Controller {
Public function add() {
$this->display('add');
}
}
~~~
在不開啟`LAYOUT_ON`布局模板之前,會直接渲染`Home/View/User/add.html` 模板文件,開啟之后首先會渲染`Home/View/layout.html` 模板,布局模板的寫法和其他模板的寫法類似,本身也可以支持所有的模板標簽以及包含文件,區別在于有一個特定的輸出替換變量`{__CONTENT__}`,例如,下面是一個典型的layout.html模板的寫法:
~~~
<include file="Public:header" />
{__CONTENT__}
<include file="Public:footer" />
~~~
讀取layout模板之后,會再解析`Home/View/User/add.html` 模板文件,并把解析后的內容替換到layout布局模板文件的`{__CONTENT__}` 特定字符串。
采用這種布局方式的情況下,一旦`Home/View/User/add.html` 模板文件或者`Home/View/layout.html`布局模板文件發生修改,都會導致模板重新編譯。
如果需要指定其他位置的布局模板,可以使用:
~~~
'LAYOUT_NAME'=>'Layout/layoutname',
~~~
就表示采用`Home/View/Layout/layoutname.html`作為布局模板。
如果某些頁面不需要使用布局模板功能,可以在模板文件開頭加上 `{__NOLAYOUT__}` 字符串。
如果上面的`Home/View/User/add.html` 模板文件里面包含有`{__NOLAYOUT__}`,則即使當前開啟布局模板,也不會進行布局模板解析。
### 第二種方式:模板標簽方式
這種布局模板不需要在配置文件中設置任何參數,也不需要開啟**LAYOUT_ON**,直接在模板文件中指定布局模板即可,相關的布局模板調整也在模板中進行。
以前面的輸出模板為例,這種方式的入口還是在`Home/View/User/add.html` 模板,但是我們可以修改下add模板文件的內容,在頭部增加下面的布局標簽(記得首先關閉前面的LAYOUT_ON設置,否則可能出現布局循環):
~~~
<layout name="layout" />
~~~
表示當前模板文件需要使用`Home/View/layout.html` 布局模板文件,而布局模板文件的寫法和上面第一種方式是一樣的。當渲染`Home/View/User/add.html` 模板文件的時候,如果讀取到layout標簽,則會把當前模板的解析內容替換到layout布局模板的`{__CONTENT__}` 特定字符串。
一個模板文件中只能使用一個布局模板,如果模板文件中沒有使用任何layout標簽則表示當前模板不使用任何布局。
如果需要使用其他的布局模板,可以改變layout的name屬性,例如:
~~~
<layout name="newlayout" />
~~~
還可以在layout標簽里面指定要替換的特定字符串:
~~~
<layout name="Layout/newlayout" replace="{__REPLACE__}" />
~~~
由于所有include標簽引入的文件都支持layout標簽,所以,我們可以借助layout標簽和include標簽相結合的方式實現布局模板的嵌套。例如,上面的例子
~~~
<include file="Public:header" />
<div id="main" class="main" >
{__CONTENT__}
</div>
<include file="Public:footer" />
~~~
在引入的header和footer模板文件中也可以添加layout標簽,例如header模板文件的開頭添加如下標簽:
~~~
<layout name="menu" />
~~~
這樣就實現了在頭部模板中引用了menu布局模板。
也可以采用兩種布局方式的結合,可以實現更加復雜的模板布局以及嵌套功能。
### 第三種方式:使用layout控制模板布局
使用內置的layout方法可以更靈活的在程序中控制模板輸出的布局功能,尤其適用于局部需要布局或者關閉布局的情況,這種方式也不需要在配置文件中開啟LAYOUT_ON。例如:
~~~
<?php
namespace Home\Controller;
use Think\Controller;
Class UserController extends Controller {
Public function add() {
layout(true);
$this->display('add');
}
}
~~~
表示當前的模板輸出啟用了布局模板,并且采用默認的layout布局模板。
如果當前輸出需要使用不同的布局模板,可以動態的指定布局模板名稱,例如:
~~~
<?php
namespace Home\Controller;
use Think\Controller;
Class UserController extends Controller {
Public function add() {
layout('Layout/newlayout');
$this->display('add');
}
}
~~~
或者使用layout方法動態關閉當前模板的布局功能(這種用法可以配合第一種布局方式,例如全局配置已經開啟了布局,可以在某個頁面單獨關閉):
~~~
<?php
namespace Home\Controller;
use Think\Controller;
Class UserController extends Controller {
Public function add() {
layout(false); // 臨時關閉當前模板的布局功能
$this->display('add');
}
}
~~~
三種模板布局方式中,第一種和第三種是在程序中配置實現模板布局,第二種方式則是單純通過模板標簽在模板中使用布局。具體選擇什么方式,需要根據項目的實際情況來了。
## 總結
本章主要講述了如何在模板中調用外部公共模板和使用模板布局簡化模板定義,下一篇開始我們會講述控制器的一些高級特性。