ThinkPHP3.2视图的模板定义

Published on 2016 - 11 - 28

模板定义

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

视图目录/[模板主题/]控制器名/操作名+模板后缀

默认的视图目录是模块的View目录(模块可以有多个视图文件目录,这取决于你的应用需要),框架的默认视图文件后缀是.html。 新版模板主题默认是空(表示不启用模板主题功能)。

在每个模板主题下面,是以模块下面的控制器名为目录,然后是每个控制器的具体操作模板文件,例如:

User控制器的add操作 对应的模板文件就应该是:./Application/Home/View/User/add.html

如果你的默认视图层不是View,例如:

'DEFAULT_V_LAYER'       =>  'Template', // 设置默认的视图层名称

那么,对应的模板文件就变成了:./Application/Home/Template/User/add.html。

模板文件的默认后缀的情况是.html,也可以通过 TMPL_TEMPLATE_SUFFIX 来配置成其他的。例如,我们可以配置:

'TMPL_TEMPLATE_SUFFIX'=>'.tpl'

定义后,User控制器的add操作 对应的模板文件就变成是: ./Application/Home/View/User/add.tpl

如果觉得目录结构太深,可以通过设置 TMPL_FILE_DEPR 参数来配置简化模板的目录层次,例如设置:

'TMPL_FILE_DEPR'=>'_'

默认的模板文件就变成了:./Application/Home/View/User_add.html

支持把模板目录设置到模块目录之外,有两种方式:

改变所有模块的模板文件目录

可以通过设置TMPL_PATH常量来改变所有模块的模板目录所在,例如:

define('TMPL_PATH','./Template/');

原来的./Application/Home/View/User/add.html变成了./Template/Home/User/add.html。

改变某个模块的模板文件目录

我们可以在模块配置文件中设置VIEW_PATH参数单独定义某个模块的视图目录,例如:

'VIEW_PATH'=>'./Theme/'

把当前模块的视图目录指定到最外层的Theme目录下面,而不是放到当前模块的View目录下面。 原来的./Application/Home/View/User/add.html变成了./Theme/User/add.html。

如果同时定义了TMPL_PATH常量和VIEW_PATH设置参数,那么以当前模块的VIEW_PATH参数设置优先。

模板主题

一个模块如果需要支持多套模板文件的话,就可以使用模板主题功能。 默认情况下,没有开启模板主题功能,如果需要开启,设置 DEFAULT_THEME 参数即可:

// 设置默认的模板主题
'DEFAULT_THEME'    =>    'default'

采用模板主题后,需要在视图目录下面创建对应的主题目录,和不启用模板主题的情况相比,模板文件只是多了一层目录:

View/User/add.html // 没有启用模板主题之前
View/default/User/add.html // 启用模板主题之后

在视图渲染输出之前,我们可以通过动态设置来改变需要使用的模板主题。

// 在控制器中动态改变模板主题
$this->theme('blue')->display('add');

模板复制

如果要在模板中输出变量,必须在控制器中把变量传递给模板,系统提供了assign方法对模板变量赋值,无论何种变量类型都统一使用assign赋值。

$this->assign('name',$value);
// 下面的写法是等效的
$this->name = $value;

assign方法必须在display和show方法之前调用,并且系统只会输出设定的变量,其它变量不会输出(系统变量例外),一定程度上保证了变量的安全性。

系统变量可以通过特殊的标签输出,无需赋值模板变量
赋值后,就可以在模板文件中输出变量了,如果使用的是内置模板的话,就可以这样输出: {$name}

如果要同时输出多个模板变量,可以使用下面的方式:

$array['name']    =    'thinkphp';
$array['email']   =    'liu21st@gmail.com';
$array['phone']   =    '12335678';
$this->assign($array);

这样,就可以在模板文件中同时输出name、email和phone三个变量。

模板变量的输出根据不同的模板引擎有不同的方法,我们在后面会专门讲解内置模板引擎的用法。如果你使用的是PHP本身作为模板引擎的话 ,就可以直接在模板文件里面输出了: <?php echo $name.'['.$email.''.$phone.']';?>

如果采用内置的模板引擎,可以使用: {$name} [ {$email} {$phone} ] 输出同样的内容。

模板渲染

渲染模板输出最常用的是使用display方法,调用格式:

display('[模板文件]'[,'字符编码'][,'输出类型'])模板文件的写法支持下面几种:
用法 描述
不带任何参数 自动定位当前操作的模板文件
[模块@][控制器:][操作] 常用写法,支持跨模块 模板主题可以和theme方法配合
完整的模板文件名 直接使用完整的模板文件名(包括模板后缀)

下面是一个最典型的用法,不带任何参数:

// 不带任何参数 自动定位当前操作的模板文件
$this->display();

表示系统会按照默认规则自动定位模板文件,其规则是:

如果当前没有启用模板主题则定位到:当前模块/默认视图目录/当前控制器/当前操作.html 如果有启用模板主题则定位到:当前模块/默认视图目录/当前主题/当前控制器/当前操作.html

如果有更改TMPL_FILE_DEPR设置(假设 'TMPL_FILE_DEPR'=>'')的话,则上面的自动定位规则变成: 当前模块/默认视图目录/当前控制器当前操作.html 和 当前模块/默认视图目录/当前主题/当前控制器_当前操作.html。

所以通常display方法无需带任何参数即可输出对应的模板,这是模板输出的最简单的用法。

通常默认的视图目录是View

如果没有按照模板定义规则来定义模板文件(或者需要调用其他控制器下面的某个模板),可以使用:

// 指定模板输出
$this->display('edit'); 

表示调用当前控制器下面的edit模板

$this->display('Member:read');

表示调用Member控制器下面的read模板。

如果我们使用了模板主题功能,那么也可以支持跨主题调用,使用:

$this->theme('blue')->display('User:edit'); 

表示调用blue主题下面的User控制器的edit模板。

如果你不希望每个主题都重复定义一些相同的模版文件的话,还可以启用差异主题定义方式,设置:

'TMPL_LOAD_DEFAULTTHEME'=>true

设置后,如果blue主题下面不存在edit模板的话,就会自动定位到默认主题中的edit模板。

渲染输出不需要写模板文件的路径和后缀,确切地说,这里面的控制器和操作并不一定需要有实际对应的控制器和操作,只是一个目录名称和文件名称而已,例如,你的项目里面可能根本没有Public控制器,更没有Public控制器的menu操作,但是一样可以使用

$this->display('Public:menu');

输出这个模板文件。理解了这个,模板输出就清晰了。

display方法支持在渲染输出的时候指定输出编码和类型,例如,可以指定编码和类型:

$this->display('read', 'utf-8', 'text/xml');

表示输出XML页面类型(配合你的应用需求可以输出很多类型)。

事情总有特例,如果的模板目录是自定义的,或者根本不需要按模块进行分目录存放,那么默认的display渲染规则就不能处理,这个时候,我们就需要使用另外一种方式来应对,直接传入模板文件名即可,例如:

$this->display('./Template/Public/menu.html');

这种方式需要指定模板路径和后缀,这里的Template/Public目录是位于当前项目入口文件位置下面。如果是其他的后缀文件,也支持直接输出,例如:$this->display('./Template/Public/menu.tpl');

只要./Template/Public/menu.tpl是一个实际存在的模板文件。

要注意模板文件位置是相对于项目的入口文件,而不是模板目录。

获取模板地址

为了更方便的输出模板文件,新版封装了一个T函数用于生成模板文件名。

用法:

T([资源://][模块@][主题/][控制器/]操作,[视图分层])

T函数的返回值是一个完整的模板文件名,可以直接用于display和fetch方法进行渲染输出。

例如:

T('Public/menu');
// 返回 当前模块/View/Public/menu.html
T('blue/Public/menu');
// 返回 当前模块/View/blue/Public/menu.html
T('Public/menu','Tpl');
// 返回 当前模块/Tpl/Public/menu.html
T('Public/menu');
// 如果TMPL_FILE_DEPR 为 _ 返回 当前模块/Tpl/Public_menu.html
T('Public/menu');
// 如果TMPL_TEMPLATE_SUFFIX 为.tpl 返回 当前模块/Tpl/Public/menu.tpl
T('Admin@Public/menu');
// 返回 Admin/View/Public/menu.html
T('Extend://Admin@Public/menu');
// 返回 Extend/Admin/View/Public/menu.html (Extend目录取决于AUTOLOAD_NAMESPACE中的配置)

在display方法中直接使用T函数:

// 使用T函数输出模板
$this->display(T('Admin@Public/menu'));

T函数可以输出不同的视图分层模板。

获取内容

如果需要获取渲染模板的输出内容而不是直接输出,可以使用fetch方法。

fetch方法的用法和display基本一致(只是不需要指定输出编码和输出类型):

fetch('模板文件')模板文件的调用方法和display方法完全一样,区别就在于fetch方法渲染后不是直接输出,而是返回渲染后的内容,例如:

$content = $this->fetch('Member:edit');

使用fetch方法获取渲染内容后,你可以进行过滤和替换等操作,或者用于对输出的复杂需求。

渲染内容

如果你没有定义任何模板文件,或者把模板内容存储到数据库中的话,你就需要使用show方法来渲染输出了,show方法的调用格式:

show('渲染内容'[,'字符编码'][,'输出类型'])例如,$this->show($content);

也可以指定编码和类型:

$this->show($content, 'utf-8', 'text/xml');

show方法中的内容也可以支持模板解析。

参考文档