ThinkPHP5的模板引擎

Published on 2016 - 12 - 20

模板定位

模板文件定义

每个模块的模板文件是独立的,为了对模板文件更加有效的管理,ThinkPHP对模板文件进行目录划分,默认的模板文件定义规则是:

视图目录/控制器名(小写)/操作名(小写)+模板后缀

默认的视图目录是模块的view目录,框架的默认视图文件后缀是.html。

模板渲染规则

模板渲染使用\think\View类的fetch方法,渲染规则为:

模块@控制器/操作

模板文件目录默认位于模块的view目录下面,视图类的fetch方法中的模板文件的定位规则如下:

如果调用没有任何参数的fetch方法:

return $view->fetch();

则按照系统的默认规则定位模板文件到:

[模板文件目录]/当前控制器名(小写+下划线)/当前操作名(小写).html

如果(指定操作)调用:

return $view->fetch('add');

则定位模板文件为:

[模板文件目录]/当前控制器名(小写+下划线)/add.html

如果调用控制器的某个模板文件使用:

return $view->fetch('user/add');

则定位模板文件为:

[模板文件目录]/user/add.html

跨模块调用模板

return $view->fetch('admin@user/add');

全路径模板调用:

return $view->fetch(APP_PATH.request()->module().'/view/public/header.html');

模板标签

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

普通标签

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

要更改普通标签的起始标签和结束标签,可以更改下面的配置参数:

'template'  => [
    // 模板引擎
    'type'   => 'think',
    // 普通标签开始标记 
    'tpl_begin' =>    '<{',
    // 普通标签结束标记
    'tpl_end'   =>    '}>'        
],

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

标签库标签

标签库标签可以用于模板变量输出、文件包含、条件控制、循环输出等功能,而且完全可以自己扩展功能。

5.0版本的标签库默认定界符和普通标签一样使用{和},是为了便于在编辑器里面编辑不至于报错,当然,你仍然可以更改标签库标签的起始和结束标签,修改下面的配置参数:

'template'      => [
    // 模板引擎
    'type'   => 'think',
    //标签库标签开始标签 
    'taglib_begin'  =>  '<',
    //标签库标签结束标记
    'taglib_end'    =>  '>',     
],

原来的

{eq name="name" value="value"}
相等
{else/}
不相等
{/eq}

就需要改成

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

变量输出

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

$view = new View();
$view->name = 'thinkphp';
return $view->fetch();

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

Hello,{$name}

模板编译后的结果就是:

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

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

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

Hello,{ $name}

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

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

$data['name'] = 'ThinkPHP';
$data['email'] = 'thinkphp@qq.com';
$view->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.APP_PATH}

或者直接使用

{$Think.APP_PATH}

配置输出

输出配置参数使用:

{$Think.config.default_module}
{$Think.config.default_controller}

语言变量

输出语言变量可以使用:

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

请求参数

模板支撑直接输出Request请求对象的方法参数,用法如下:

$Request.方法名.参数

例如:

{$Request.get.id}
{$Request.param.name}

以$Request.开头的变量输出会认为是系统Request请求对象的参数输出。

支持Request类的大部分方法,但只支持方法的第一个参数。

下面都是有效的输出:

// 调用Request对象的get方法 传入参数为id
{$Request.get.id}
// 调用Request对象的param方法 传入参数为name
{$Request.param.name}
// 调用Request对象的param方法 传入参数为user.nickname
{$Request.param.user.nickname}
// 调用Request对象的root方法
{$Request.root}
// 调用Request对象的root方法,并且传入参数true
{$Request.root.true}
// 调用Request对象的path方法
{$Request.path}
// 调用Request对象的module方法
{$Request.module}
// 调用Request对象的controller方法
{$Request.controller}
// 调用Request对象的action方法
{$Request.action}
// 调用Request对象的ext方法
{$Request.ext}
// 调用Request对象的host方法
{$Request.host}
// 调用Request对象的ip方法
{$Request.ip}
// 调用Request对象的header方法
{$Request.header.accept-encoding}

使用函数

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

{$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'])} //正确的

三元运算

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

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

5.0版本还支持如下的写法:

{$varname.aa ?? 'xxx'}

表示如果有设置$varname则输出$varname,否则输出'xxx'。 解析后的代码为:

<?php echo isset($varname['aa']) ? $varname['aa'] : '默认值'; ?>
{$varname?='xxx'} 

表示$varname为真时才输出xxx。 解析后的代码为:

<?php if(!empty($name)) echo 'xxx'; ?>
{$varname ?: 'no'}

表示如果$varname为真则输出$varname,否则输出no。解析后的代码为:

<?php echo $varname ? $varname : 'no'; ?>
{$a==$b ? 'yes' : 'no'}

前面的表达式为真输出yes,否则输出no, 条件可以是==、===、!=、!==、>=、<=

原样输出

可以使用literal标签来防止模板标签被解析,例如:

{literal}
    Hello,{$name}
{/literal}

上面的{$name}标签被literal标签包含,因此并不会被模板引擎解析,而是保持原样输出。

literal标签还可以用于页面的JS代码外层,确保JS代码中的某些用法和模板引擎不产生混淆。

总之,所有可能和内置模板引擎的解析规则冲突的地方都可以使用literal标签处理。

需要注意的是配置‘view_replace_str’替换参数,会替换掉literal标签内的内容,可以配置‘template.tpl_replace_string’避免替换掉literal标签内的内容。

模板注释

模板支持注释功能,该注释文字在最终页面不会显示,仅供模板制作人员参考和识别。

单行注释

格式:

{/* 注释内容 */ } 或 {// 注释内容 } 

例如:

{// 这是模板注释内容 }

注意{和注释标记之间不能有空格。

多行注释

支持多行注释,例如:

{/* 这是模板
注释内容*/ }

模板注释支持多行,模板注释在生成编译缓存文件后会自动删除,这一点和Html的注释不同。

模板布局

ThinkPHP的模板引擎内置了布局模板功能支持,可以方便的实现模板布局以及布局嵌套功能。

有三种布局模板的支持方式:

第一种方式:全局配置方式

这种方式仅需在项目配置文件中添加相关的布局模板配置,就可以简单实现模板布局功能,比较适用于全站使用相同布局的情况,需要配置开启layout_on 参数(默认不开启),并且设置布局入口文件名layout_name(默认为layout)。

'template'  =>  [
    'layout_on'     =>  true,
    'layout_name'   =>  'layout',
]

开启layout_on后,我们的模板渲染流程就有所变化,例如:

namespace app\index\controller;

use think\Controller;

Class User extends Controller
{
     public function add() 
     {
         return $this->fetch('add');
     }
}

在不开启layout_on布局模板之前,会直接渲染 application/index/view/user/add.html 模板文件,开启之后,首先会渲染application/index/view/layout.html 模板,布局模板的写法和其他模板的写法类似,本身也可以支持所有的模板标签以及包含文件,区别在于有一个特定的输出替换变量{CONTENT},例如,下面是一个典型的layout.html模板的写法:

{include file="public/header" /}
 {__CONTENT__}
{include file="public/footer" /}

读取layout模板之后,会再解析user/add.html 模板文件,并把解析后的内容替换到layout布局模板文件的{CONTENT} 特定字符串。

当然可以通过设置来改变这个特定的替换字符串,例如:

'template'  =>  [
    'layout_on'     =>  true,
    'layout_name'   =>  'layout',
    'layout_item'   =>  '{__REPLACE__}'
]

一个布局模板同时只能有一个特定替换字符串。

采用这种布局方式的情况下,一旦user/add.html 模板文件或者layout.html布局模板文件发生修改,都会导致模板重新编译。

如果需要指定其他位置的布局模板,可以使用:

'template'  =>  [
    'layout_on'     =>  true,
    'layout_name'   =>  'layout/layoutname',
    'layout_item'   =>  '{__REPLACE__}'
]

就表示采用application/index/view/layout/layoutname.html作为布局模板。

如果某些页面不需要使用布局模板功能,可以在模板文件开头加上 {NOLAYOUT} 字符串。

如果上面的user/add.html 模板文件里面包含有{NOLAYOUT},则即使当前开启布局模板,也不会进行布局模板解析。

第二种方式:模板标签方式

这种布局模板不需要在配置文件中设置任何参数,也不需要开启layout_on,直接在模板文件中指定布局模板即可,相关的布局模板调整也在模板中进行。

以前面的输出模板为例,这种方式的入口还是在user/add.html 模板,但是我们可以修改下add模板文件的内容,在头部增加下面的布局标签(记得首先关闭前面的layout_on设置,否则可能出现布局循环):

{layout name="layout" /}

表示当前模板文件需要使用layout.html 布局模板文件,而布局模板文件的写法和上面第一种方式是一样的。当渲染user/add.html 模板文件的时候,如果读取到layout标签,则会把当前模板的解析内容替换到layout布局模板的{CONTENT} 特定字符串。

一个模板文件中只能使用一个布局模板,如果模板文件中没有使用任何layout标签则表示当前模板不使用任何布局。

如果需要使用其他的布局模板,可以改变layout的name属性,例如:

{layout name="newlayout" /}

还可以在layout标签里面指定要替换的特定字符串:

{layout name="Layout/newlayout" replace="[__REPLACE__]" /}

第三种方式:使用layout控制模板布局

使用内置的layout方法可以更灵活的在程序中控制模板输出的布局功能,尤其适用于局部需要布局或者关闭布局的情况,这种方式也不需要在配置文件中开启layout_on。例如:

namespace app\index\controller;

use think\Controller;

class User extends Controller
{
     public function add() 
     {
         $this->view->engine->layout(true);
         return $this->fetch('add');
     }
}

表示当前的模板输出启用了布局模板,并且采用默认的layout布局模板。

如果当前输出需要使用不同的布局模板,可以动态的指定布局模板名称,例如:

namespace app\index\controller;

use think\Controller;

class User extends Controller
{
     public function add() 
     {
         $this->view->engine->layout('Layout/newlayout');
         return $this->display('add');
     }
}

或者使用layout方法动态关闭当前模板的布局功能(这种用法可以配合第一种布局方式,例如全局配置已经开启了布局,可以在某个页面单独关闭):

namespace app\index\controller;

use think\Controller;

class User extends Controller
{
     public function add() 
     {
        // 临时关闭当前模板的布局功能
         $this->view->engine->layout(false); 
         return $this->display('add');
     }
}

三种模板布局方式中,第一种和第三种是在程序中配置实现模板布局,第二种方式则是单纯通过模板标签在模板中使用布局。具体选择什么方式,需要根据项目的实际情况来了。

模板继承

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

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

每个区块由{block} {/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">
<title>{block name="title"}标题{/block}</title>
</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}{/block}
{block name="menu"}
<a href="/" >首页</a>
<a href="/info/" >资讯</a>
<a href="/bbs/" >论坛</a>
{/block}
{block name="left"}{/block}
{block name="main"}
{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"}
{__block__}
 @ThinkPHP 版权所有
{/block}

上例中,我们可以看到在子模板中使用了extend标签来继承了base模板。

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

{block name="footer"}
{__block__}@ThinkPHP 版权所有
{/block}

这一区块中有{block}这个标签,当区块中有这个标记时,就不只是直接重载这个区块,它表示引用所继承模板对应区块的内容到这个位置,最终这个区块是合并后的内容。所以这里footer区块最后的内容是: 底部@ThinkPHP 版权所有

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>

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

模板可以多级继承,比如B继承了A,而C又继承了B,最终C中的区块会覆盖B和A中的同名区块,但C和B中的区块必须是A中已定义过的。

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

包含文件

在当前模版文件中包含其他的模版文件使用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/view/default/public/header.html" /}

路径以 项目目录/public/ 路径下为起点

传入参数

无论你使用什么方式包含外部模板,Include标签支持在包含文件的同时传入参数,例如,下面的例子我们在包含header模板的时候传入了title和keywords参数:

{include file="Public/header" title="$title" keywords="开源WEB开发框架" /}

就可以在包含的header.html文件里面使用title和keywords变量,如下:

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>[title]</title>
<meta name="keywords" content="[keywords]" />
</head>

上面title参数传入的是个变量$title,模板内的[title]最终会替换成$title的值,当然$title这个变量必须要存在。

包含文件中可以再使用include标签包含别的文件,但注意不要形成A包含A,或者A包含B而B又包含A这样的死循环。

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

参考文档