ThinkPHP--模版引擎和模板常用参数设置
1.1 模版引擎,模版定义
为了对模板文件更加有效的管理,ThinkPHP对模板文件进行目录划分,默认的模板文件定义规则是:
模板目录/[分组名/][模板主题/]模块名/操作名+模板后缀
模板目录默认是项目下面的Tpl, 当定义分组的情况下,会按照分组名分开子目录,新版模板主题默认是空(表示不启用模板主题功能),模板主题功能是为了多模板切换而设计的,如果有多个模板主题的话,可以用DEFAULT_THEME参数设置默认的模板主题名。
在每个模板主题下面,是以项目的模块名为目录,然后是每个模块的具体操作模板文件,例如:
User模块的add操作 对应的模板文件就应该是:
Tpl/User/add.html
模板文件的默认后缀的情况是.html,也可以通过TMPL_TEMPLATE_SUFFIX来配置成其他的。当然,分组功能也提供了TMPL_FILE_DEPR参数来配置简化模板的目录层次。
例如 TMPL_FILE_DEPR如果配置成“_”的话,默认的模板文件就变成了:
Tpl/Home/User_add.html
1.2 模版引擎,模版赋值
要在模板中输出变量,必须在在Action类中把变量传递给模板,视图类提供了assign方法对模板变量赋值,无论何种变量类型都统一使用assign赋值。
$this->assign('name',$value);
//下面的写法是等效的
$this->name = $value;
如果要同时输出多个模板变量,可以使用下面的方式:
$array['name'] = 'thinkphp'; $array['email'] = 'liu21st@gmail.com'; $array['phone'] = '12335678'; $this->assign($array);
这样,就可以在模板文件中同时输出name、email和phone三个变量。
1.3 模版引擎,模版输出
模板变量赋值后就需要调用模板文件来输出相关的变量,模板调用通过display方法来实现。我们在操作方法的最后使用:
$this->display();
就可以输出模板,根据前面的模板定义规则,因为系统会按照默认规则自动定位模板文件,所以通常display方法无需带任何参数即可输出对应的模板,这是模板输出的最简单的用法。
事情总有特例,或者根本不需要按模块进行分目录存放,不过display方法总是能够帮你解决问题。
Display方法提供了几种规则让你可以随心所欲的输出需要的模板,无论你的模板文件在什么位置。
下面来看具体的用法:
一、调用当前模块的其他操作模板
格式:display('操作名')
例如,假设当前操作是User模块下面的read操作,我们需要调用User模块的edit操作模版,使用:
$this->display('edit');
不需要写模板文件的路径和后缀。
二、调用其他模块的操作模板
格式:display('模块名:操作名')
例如,当前是User模块,我们需要调用Member模块的read操作模版,使用:
$this->display('Member:read');
这种方式也不需要写模板文件的路径和后缀,严格来说,这里面的模块名和操作名并不一定需要有对应的模块或者操作,只是一个目录名称和文件名称而已,例如,你的项目里面可能根本没有Public模块,更没有Public模块的menu操作,但是一样可以使用
$this->display('Public:menu');
输出这个模板文件。理解了这个,模板输出就清晰了。
三、调用其他主题的操作模板
格式:display('主题名:模块名:操作名')
例如我们需要调用Xp主题的User模块的edit操作模版,使用:
$this->display('Xp:User:edit');
这种方式需要指定模块和操作名
四、直接全路径输出模板
格式:display('模板文件名')
例如,我们直接输出当前的Public目录下面的menu.html模板文件,使用:
$this->display('./Public/menu.html');
这种方式需要指定模板路径和后缀,这里的Public目录是位于当前项目入口文件位置下面。如果是其他的后缀文件,也支持直接输出,例如:
$this->display('./Public/menu.tpl');
只要./Public/menu.tpl是一个实际存在的模板文件。如果使用的是相对路径的话,要注意当前位置是相对于项目的入口文件,而不是模板目录。
五、直接解析内容
Action类的display方法如果传入第四个参数,表示不读取模板文件而是直接解析内容。例如:
$this->assign('foo','ThinkPHP'); $this->show('Hello, {$foo}!');
会在页面输出: Hello,ThinkPHP!
直接输出的内容仍然支持模板布局功能。
show方法也可以支持指定编码和输出格式,例如:
$this->show($content, 'utf-8', 'text/xml');
事实上,display方法还有其他的参数和用法。
有时候某个模板页面我们需要输出指定的编码,而不是默认的编码,可以使用:
$this->display('Member:read', 'gbk');
或者输出的模板文件不是text/html格式的,而是XML格式的,可以用:
$this->display('Member:read', 'utf-8', 'text/xml');
如果你的网站输出编码不是默认的编码,可以使用:
'DEFAULT_CHARSET'=> 'gbk'
如果要输出XML格式的,可以用:
'TMPL_CONTENT_TYPE'=> 'text/xml'
1.4 模板替换
在进行模板输出之前,系统还会对渲染的模板结果进行一些模板的特殊字符串替换操作,也就是实现了模板输出的替换和过滤。模板替换适用于所有的模板引擎,包括原生的PHP模板。这个机制可以使得模板文件的定义更加方便,默认的替换规则有:
!-Public-!: 会被替换成当前项目的公共模板目录 通常是 /项目目录/Tpl/当前主题/Public/
!-TMPL-!: 会替换成项目的模板目录 通常是 /项目目录/Tpl/当前主题/
(注:为了部署安全考虑,!-Public-!和!-TMPL-!不再建议使用)
!-PUBLIC-!:会被替换成当前网站的公共目录 通常是 /Public/
!-ROOT-!: 会替换成当前网站的地址(不含域名)
!-APP-!: 会替换成当前项目的URL地址 (不含域名)
!-GROUP-!:会替换成当前分组的URL地址 (不含域名)
!-URL-!: 会替换成当前模块的URL地址(不含域名)
!-ACTION-!:会替换成当前操作的URL地址 (不含域名)
!-SELF-!: 会替换成当前的页面URL
注意这些特殊的字符串是严格区别大小写的,并且这些特殊字符串的替换规则是可以更改或者增加的,我们只需要在项目配置文件中配置TMPL_PARSE_STRING就可以完成。如果有相同的数组索引,就会更改系统的默认规则。例如:
'TMPL_PARSE_STRING' =>array( '!-PUBLIC-!' => '/Common', // 更改默认的__PUBLIC__ 替换规则 '__JS__' => '/Public/JS/', // 增加新的JS类库路径替换规则 '__UPLOAD__' => '/Uploads', // 增加新的上传路径替换规则 )
有了模板替换规则后,页面上所有的!-PUBLIC-! 字符串都会被替换,那如果确实需要输出!-PUBLIC-! 字符串到模板呢,我们可以通过增加替换规则的方式,例如:
'TMPL_PARSE_STRING' =>array( '--PUBLIC--' => '!-PUBLIC-!', // 采用新规则输出__PUBLIC__字符串 )
这样增加替换规则后,如果我们要输出!-PUBLIC-! 字符串,只需要在模板中添加--PUBLIC--,其他替换字符串的输出方式类似。
2 模版常用参数
模板引擎设置
配置名 说明 默认值
TMPL_CONTENT_TYPE 默认模板输出类型 text/html
TMPL_ACTION_ERROR 默认错误跳转对应的模板文件 系统模板目录下的dispatch_jump.tpl
TMPL_ACTION_SUCCESS 默认成功跳转对应的模板文件 同上
TMPL_EXCEPTION_FILE 异常页面的模板文件 系统模板目录下的think_exception.tpl
TMPL_DETECT_THEME 自动侦测模板主题 false
TMPL_TEMPLATE_SUFFIX 默认模板文件后缀 .html
TMPL_FILE_DEPR 模板文件模块与操作之间的分割符,只对项目分组部署有效 /
'TMPL_ENGINE_TYPE' 更改模版引擎
TMPL_PARSE_STRING' 修改定义模版替换规则
3 变量输出
我们已经知道了在Action中使用assign方法可以给模板变量赋值,赋值后怎么在模板文件中输出变量的值呢?
如果我们在Action中赋值了一个name模板变量:
$name = 'ThinkPHP'; $this->assign('name',$name);
使用内置的模板引擎输出变量,只需要在模版文件使用:
{$name}
模板编译后的结果就是
<?php echo($name);?>
最后运行的时候就可以在标签位置显示ThinkPHP的输出结果。
注意模板标签的{和$之间不能有任何的空格,否则标签无效。普通标签默认开始标记是
{,结束标记是 }。也可以通过设置TMPL_L_DELIM和TMPL_R_DELIM进行更改。例如,我们在项目配置文件中定义:
'TMPL_L_DELIM'=>'<{', 'TMPL_R_DELIM'=>'}>',
那么,上面的变量输出标签就应该改成:
<{$name}>
后面的内容我们都以默认的标签定义来说明。assign方法里面的第一个参数才是模板文件中使用的变量名称。如果改成下面的代码:
$name = 'ThinkPHP'; $this->assign('name2',$name);
再使用{$name} 输出就无效了,必须使用 {$name2}才能输出模板变量的值了。
如果我们需要把一个用户数据对象赋值给模板变量:
$User = M('name'); $user = $User->find(1); $this->assign('user',$user);
也就是说$user其实是一个数组变量,我们可以使用下面的方式来输出相关的值:
{$user['name']}//输出用户的名称 {$user['email']} //输出用户的email地址
如果$user是一个对象而不是数组的话,
$User = M('name'); $User->find(1); $this->assign('user',$User);
可以使用下面的方式输出相关的属性值:
{$user:name}// 输出用户的名称 {$user:email} // 输出用户的email地址
3.1版本以后,类的属性输出方式有所调整,支持原生的PHP对象写法,所以上面的标签需要改成:
{$user->name}// 输出用户的名称 {$user->email} // 输出用户的email地址
为了方便模板定义,还可以支持点语法,例如,上面的
{$user['name']}// 输出用户的名称 {$user['email']} // 输出用户的email地址
可以改成
{$user.name} {$user.email}
因为点语法默认的输出是数组方式,所以上面两种方式是在没有配置的情况下是等效的。我们可以通过配置TMPL_VAR_IDENTIFY参数来决定点语法的输出效果,以下面的输出为例:
{$user.name}
如果TMPL_VAR_IDENTIFY设置为array,那么
{$user.name}和{$user['name']}等效,也就是输出数组变量。
如果TMPL_VAR_IDENTIFY设置为obj,那么
{$user.name}和{$user:name}等效,也就是输出对象的属性。
如果TMPL_VAR_IDENTIFY留空的话,系统会自动判断要输出的变量是数组还是对象,这种方式会一定程度上影响效率,而且只支持二维数组和两级对象属性。
如果是多维数组或者多层对象属性的输出,可以使用下面的定义方式:
{$user.sub.name}// 使用点语法输出
或者使用
{$user['sub']['name']}// 输出三维数组的值 {$user:sub:name}// 输出对象的多级属性