ThinkPHP3.2的模板引擎

Published on 2016 - 11 - 28

ThinkPHP内置了一个基于XML的性能卓越的模板引擎 ThinkTemplate,这是一个专门为ThinkPHP服务的内置模板引擎。ThinkTemplate是一个使用了XML标签库技术的编译型模板引擎,支持两种类型的模板标签,使用了动态编译和缓存技术,而且支持自定义标签库。其特点包括:

  • 支持XML标签库和普通标签的混合定义;
  • 支持直接使用PHP代码书写;
  • 支持文件包含;
  • 支持多级标签嵌套;
  • 支持布局模板功能;
  • 一次编译多次运行,编译和运行效率非常高;
  • 模板文件和布局模板更新,自动更新模板缓存;
  • 系统变量无需赋值直接输出;
  • 支持多维数组的快速输出;
  • 支持模板变量的默认值;
  • 支持页面代码去除Html空白;
  • 支持变量组合调节器和格式化功能;
  • 允许定义模板禁用函数和禁用PHP语法;
  • 通过标签库方式扩展。

每个模板文件在执行过程中都会生成一个编译后的缓存文件,其实就是一个可以运行的PHP文件。模板缓存默认位于项目的Runtime/模块/Cache目录下面,以模板文件的md5编码作为缓存文件名保存的。如果在模板标签的使用过程中发现问题,可以尝试通过查看模板缓存文件找到问题所在。

内置的模板引擎支持普通标签和XML标签方式两种标签定义,分别用于不同的目的:

标签类型 描述
普通标签 主要用于输出变量和做一些基本的操作
XML标签 主要完成一些逻辑判断、控制和循环输出,并且可扩展

这种方式的结合保证了模板引擎的简洁和强大的有效融合。

变量输出

在模板中输出变量的方法很简单,例如,在控制器中我们给模板变量赋值:

$name = 'ThinkPHP';
$this->assign('name',$name);
$this->display();

然后就可以在模板中使用:

Hello,{$name}

模板编译后的结果就是:

Hello,<?php echo($name);?>!

这样,运行的时候就会在模板中显示: Hello,ThinkPHP!

注意模板标签的{和$之间不能有任何的空格,否则标签无效。所以,下面的标签

Hello,{ $name}

将不会正常输出name变量,而是直接保持不变输出: Hello,{ $name}!

普通标签默认开始标记是{,结束标记是 }。也可以通过设置TMPL_L_DELIM和TMPL_R_DELIM进行更改。例如,我们在项目配置文件中定义:

'TMPL_L_DELIM'=>'<{',
'TMPL_R_DELIM'=>'}>',

那么,上面的变量输出标签就应该改成:

Hello,<{$name}>!

后面的内容我们都以默认的标签定义来说明。

模板标签的变量输出根据变量类型有所区别,刚才我们输出的是字符串变量,如果是数组变量,

$data['name'] = 'ThinkPHP';
$data['email'] = 'thinkphp@qq.com';
$this->assign('data',$data);

那么,在模板中我们可以用下面的方式输出:

Name:{$data.name}
Email:{$data.email}

或者用下面的方式也是有效:

Name:{$data['name']}
Email:{$data['email']}

当我们要输出多维数组的时候,往往要采用后面一种方式。

如果data变量是一个对象(并且包含有name和email两个属性),那么可以用下面的方式输出:

Name:{$data:name}
Email:{$data:email}

或者

Name:{$data->name}
Email:{$data->email}

系统变量

普通的模板变量需要首先赋值后才能在模板中输出,但是系统变量则不需要,可以直接在模板中输出,系统变量的输出通常以{$Think 打头,例如:

{$Think.server.script_name} // 输出$_SERVER['SCRIPT_NAME']变量
{$Think.session.user_id} // 输出$_SESSION['user_id']变量
{$Think.get.pageNumber} // 输出$_GET['pageNumber']变量
{$Think.cookie.name}  // 输出$_COOKIE['name']变量

支持输出 $_SERVER、$_ENV、 $_POST、 $_GET、 $_REQUEST、$_SESSION和 $_COOKIE变量。

常量输出

还可以输出常量

{$Think.const.MODULE_NAME}

或者直接使用

{$Think.MODULE_NAME}

配置输出

输出配置参数使用:

{$Think.config.db_charset}
{$Think.config.url_model}

语言变量

输出语言变量可以使用:

{$Think.lang.page_error}
{$Think.lang.var_error}

使用函数

我们往往需要对模板输出变量使用函数,可以使用:

{$data.name|md5} 

编译后的结果是:

<?php echo (md5($data['name'])); ?>

如果函数有多个参数需要调用,则使用:

{$create_time|date="y-m-d",###}

表示date函数传入两个参数,每个参数用逗号分割,这里第一个参数是y-m-d,第二个参数是前面要输出的create_time变量,因为该变量是第二个参数,因此需要用###标识变量位置,编译后的结果是:

<?php echo (date("y-m-d",$create_time)); ?>

如果前面输出的变量在后面定义的函数的第一个参数,则可以直接使用:

{$data.name|substr=0,3}

表示输出

<?php echo (substr($data['name'],0,3)); ?>

虽然也可以使用:

{$data.name|substr=###,0,3}

但完全没用这个必要。

还可以支持多个函数过滤,多个函数之间用“|”分割即可,例如:

{$name|md5|strtoupper|substr=0,3}

编译后的结果是:

<?php echo (substr(strtoupper(md5($name)),0,3)); ?>

函数会按照从左到右的顺序依次调用。

如果你觉得这样写起来比较麻烦,也可以直接这样写:

{:substr(strtoupper(md5($name)),0,3)}

变量输出使用的函数可以支持内置的PHP函数或者用户自定义函数,甚至是静态方法。

默认值输出

我们可以给变量输出提供默认值,例如:

{$user.nickname|default="这家伙很懒,什么也没留下"}

对系统变量依然可以支持默认值输出,例如:

{$Think.get.name|default="名称为空"}

默认值和函数可以同时使用,例如:

{$Think.get.name|getName|default="名称为空"}

使用运算符

我们可以对模板输出使用运算符,包括对“+”“ ” “*” “/”和“%”的支持。

例如:

运算符 使用示例
+ {$a+$b}
- {$a-$b}
乘号 {$a*$b}
/ {$a/$b}
% {$a%$b}
++ {$a++} 或 {++$a}
-- {$a--} 或 {--$a}
综合运算 {$a+$b*10+$c}

在使用运算符的时候,不再支持点语法和常规的函数用法,例如:

{$user.score+10} //错误的
{$user['score']+10} //正确的
{$user['score']*$user['level']} //正确的
{$user['score']|myFun*10} //错误的
{$user['score']+myFun($user['level'])} //正确的

标签库

内置的模板引擎除了支持普通变量的输出之外,更强大的地方在于标签库功能。

标签库类似于Java的Struts中的JSP标签库,每一个标签库是一个独立的标签库文件,标签库中的每一个标签完成某个功能,采用XML标签方式(包括开放标签和闭合标签)。

标签库分为内置和扩展标签库,内置标签库是Cx标签库。

导入标签库

使用taglib标签导入当前模板中需要使用的标签库,例如:

<taglib name="html" />

如果没有定义html标签库的话,则导入无效。

也可以导入多个标签库,使用:

<taglib name="html,article" />

导入标签库后,就可以使用标签库中定义的标签了,假设article标签库中定义了read标签:

<article:read name="hello" id="data" >
{$data.id}:{$data.title}
</article:read>

在上面的标签中,<article:read>... </article:read> 就是闭合标签,起始和结束标签必须成对出现。

如果是 <article:read name="hello" /> 就是开放标签。

闭合和开放标签取决于标签库中的定义,一旦定义后就不能混淆使用,否则就会出现错误。

内置标签

内置标签库无需导入即可使用,并且不需要加XML中的标签库前缀,ThinkPHP内置的标签库是Cx标签库,所以,Cx标签库中的所有标签,我们可以在模板文件中直接使用,我们可以这样使用:

<eq name="status" value="1" >
正常
</eq>

如果Cx不是内置标签的话,可能就需要这么使用了:

<cx:eq name="status" value="1" >
正常
</cx:eq>

内置标签库可以简化模板中标签的使用,所以,我们还可以把其他的标签库定义为内置标签库(前提是多个标签库没有标签冲突的情况),例如:

'TAGLIB_BUILD_IN'    =>    'cx,article'

配置后,上面的标签用法就可以改为:

<read name="hello" id="data" >
{$data.id}:{$data.title}
</read>

标签库预加载

标签库预加载是指无需手动在模板文件中导入标签库即可使用标签库中的标签,通常用于某个标签库需要被大多数模板使用的情况。

在应用或者模块的配置文件中添加:

'TAGLIB_PRE_LOAD'    =>    'article,html'

设置后,模板文件就不再需要使用

<taglib name="html,article" />

但是仍然可以在模板中调用:

<article:read name="hello" id="data" >
{$data.id}:{$data.title}
</article:read>

模板继承

模板继承是一项更加灵活的模板布局方式,模板继承不同于模板布局,甚至来说,应该在模板布局的上层。模板继承其实并不难理解,就好比类的继承一样,模板也可以定义一个基础模板(或者是布局),并且其中定义相关的区块(block),然后继承(extend)该基础模板的子模板中就可以对基础模板中定义的区块进行重载。

因此,模板继承的优势其实是设计基础模板中的区块(block)和子模板中替换这些区块。

每个区块由标签组成。 下面就是基础模板中的一个典型的区块设计(用于设计网站标题):

<block name="title"><title>网站标题</title></block>

block标签必须指定name属性来标识当前区块的名称,这个标识在当前模板中应该是唯一的,block标签中可以包含任何模板内容,包括其他标签和变量,例如:

<block name="title"><title>{$web_title}</title></block>

你甚至还可以在区块中加载外部文件:

<block name="include"><include file="Public:header" /></block>

一个模板中可以定义任意多个名称标识不重复的区块,例如下面定义了一个base.html基础模板:

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<block name="title"><title>标题</title></block>
</head>
<body>
<block name="menu">菜单</block>
<block name="left">左边分栏</block>
<block name="main">主内容</block>
<block name="right">右边分栏</block>
<block name="footer">底部</block>
</body>
</html>

然后我们在子模板(其实是当前操作的入口模板)中使用继承:

<extend name="base" />
<block name="title"><title>{$title}</title></block>
<block name="menu">
<a href="/" >首页</a>
<a href="/info/" >资讯</a>
<a href="/bbs/" >论坛</a>
</block>
<block name="left"></block>
<block name="content">
<volist name="list" id="vo">
<a href="/new/{$vo.id}">{$vo.title}</a><br/>
{$vo.content}
</volist>
</block>
<block name="right">
 最新资讯:
<volist name="news" id="new">
<a href="/new/{$new.id}">{$new.title}</a><br/>
</volist>
</block>
<block name="footer">
 @ThinkPHP2012 版权所有
</block>

可以看到,子模板中使用了extend标签定义需要继承的模板,extend标签的用法和include标签一样,你也可以加载其他模板:

<extend name="Public:base" />

或者使用绝对文件路径加载

<extend name="./Template/Public/base.html" />

在当前子模板中,只能定义区块而不能定义其他的模板内容,否则将会直接忽略,并且只能定义基础模板中已经定义的区块。

例如,如果采用下面的定义:

<block name="title"><title>{$title}</title></block>
<a href="/" >首页</a>
<a href="/info/" >资讯</a>
<a href="/bbs/" >论坛</a>

导航部分将是无效的,不会显示在模板中。

在子模板中,可以对基础模板中的区块进行重载定义,如果没有重新定义的话,则表示沿用基础模板中的区块定义,如果定义了一个空的区块,则表示删除基础模板中的该区块内容。 上面的例子,我们就把left区块的内容删除了,其他的区块都进行了重载。

子模板中的区块定义顺序是随意的,模板继承的用法关键在于基础模板如何布局和设计规划了,如果结合原来的布局功能,则会更加灵活。

修改定界符

模板文件可以包含普通模板标签和XML模板标签,标签的定界符都可以重新配置。

普通标签

内置模板引擎的普通模板标签默认以{ 和 } 作为开始和结束标识,并且在开始标记紧跟标签的定义,如果之间有空格或者换行则被视为非模板标签直接输出。 例如:{$name} 、{$vo.name} 、{$vo['name']|strtoupper}都属于普通模板标签。

要更改普遍模板的起始标签和结束标签,请使用下面的配置参数:

TMPL_L_DELIM  //模板引擎普通标签开始标记 
TMPL_R_DELIM  //模板引擎普通标签结束标记

例如在项目配置文件中增加下面的配置:

'TMPL_L_DELIM'    =>    '<{',
'TMPL_R_DELIM'    =>    '}>'

普通标签的定界符就被修改了,原来的 {$name}{$vo.name} 必须使用 <{$name}><{$vo.name}> 才能生效了。

如果你定制了普通标签的定界符,记得修改下默认的系统模板。

XML标签

普通模板标签主要用于模板变量输出和模板注释。如果要使用其它功能,请使用XML模板标签。XML模板标签可以用于模板变量输出、文件包含、条件控制、循环输出等功能,而且完全可以自己扩展功能。如果你觉得XML标签无法在正在使用的编辑器里面无法编辑,还可以更改XML标签库的起始和结束标签,请修改下面的配置参数:

TAGLIB_BEGIN    //标签库标签开始标签 
TAGLIB_END    //标签库标签结束标记

例如在项目配置文件中增加下面的配置:

'TAGLIB_BEGIN'=>'[',
'TAGLIB_END'=>']',

原来的

<eq name="name" value="value">
相等
<else/>
不相等
</eq>

就必须改成

[eq name="name" value="value"]
相等
[else/]
不相等
[/eq]

注意:XML标签和普通标签的定界符不能冲突,否则会导致解析错误。

三元运算

模板可以支持三元运算符,例如:

{$status?'正常':'错误'}
{$info['status']?$info['msg']:$info['error']}

注意:三元运算符中暂时不支持点语法。

包含文件

在当前模版文件中包含其他的模版文件使用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>

注意:由于模板解析的特点,从入口模板开始解析,如果外部模板有所更改,模板引擎并不会重新编译模板,除非在调试模式下或者缓存已经过期。如果部署模式下修改了包含的外部模板文件后,需要把模块的缓存目录清空,否则无法生效。

参考文档