切换到宽版
  • 43608阅读
  • 20回复

【PHP 模板引擎】Prototype 原型版发布! [复制链接]

上一主题 下一主题
离线tijing
 
发帖
82
只看楼主 倒序阅读 使用道具 楼主  发表于: 2015-01-05
API 手册与实例演示链接

【实例演示】:http://www.shibuyi.net/demo/php/template_engine/prototype
【官方 API 使用手册】:http://www.shibuyi.net/api/php/template_engine/prototype

下面为 PHP 模板引擎 Prototype 原型版使用教导,以下直接简称:模板引擎!

什么?不知道模板引擎是啥?可能会有 PHP 新手会问这样的问题,那我就简单的回答一下吧。模板引擎其实就是 PHP 的一个中间件技术,让传统的 Web 动态网站编程变得更加轻松,为什么这么说呢?以前不轻松吗?那是因为在模板引擎出现之前,几乎所有的 Web 服务端程序员都是通过混编代码完成工作的,所谓混编就是一张页面中既包含:PHP 也包含 HTML 甚至还有其他语言的代码,因此项目如果逐渐扩展,开发和维护的时间成本是极高的,还容易出错,美工与程序也不好配合,如果美工一点也不理解程序,那基本上没办法看混编文件。而模板引擎的诞生就很好的解决了这一难题。它采用模板技术将混编文件中的 PHP 业务逻辑层代码与 HTML 表现层代码进行了很好的切割分离,程序员则可以安心的设计程序,而美工则安心的设计界面,二者之间会使用一种模板标记的特殊符号进行关联,方便模板引擎读取模板文件之后可以顺利的进行编译操作。市面上 PHP 已经有很多相当成熟的模板引擎了,如:Smarty 模板引擎等等,其他 Web 服务端语言也有自己相应的模板引擎,或者与模板引擎类似的中间件技术。
关于模板引擎的详细介绍,推荐大家访问百度百科:http://baike.baidu.com/view/4258079.htm
在学习模板引擎之前大家要先保证自己已经了解了 PHP 的 OOP(面向对象编程)思想,因为模板技术是采用 OOP 思想描述的,如果不懂 OOP 那么这篇文章就不适合您阅读,因为门槛过高!

首先大家看到的图片是模板引擎的目录结构图(笔者使用的是 ZendStudio 7.2.1 集成开发环境):

1. caches 为模板缓存目录(若不存在模板引擎第一次执行会自动生成);
2. classes 为模板引擎核心类库;
3. compiles 为模板编译目录(若不存在模板引擎第一次执行会自动生成);
4. constants 为模板常量目录(若不存在模板引擎第一次执行会自动生成);
5. includes 为模板配置目录;
6. templates 为模板文件目录(若不存在模板引擎第一次执行会自动生成)。

在了解了模板引擎的目录后,接下来我们就来看看如何让他运作起来。在原型版中模板引擎的相关初始化和配置信息都是在 includes/template.inc.php 文件中完成的(大家可以打开实例演示的源码进行查阅)。
其实对模板引擎的配置又叫做初始化的过程,初始化的第一步就是配置相应的目录,让模板引擎能够正确的读取和写入该目录中的数据(配置步骤大家可以自由选择,不一定非要按照我的顺序来配置,但一定要在实例化模板引擎之前完成,否则将会失效),而我们则假设与模板引擎在同一目录下进行配置,并且创建 index.php 文件用来存储配置信息,如果非同一目录对于根目录的配置则需要注意调整。


1. 首先第一步是配置模板引擎的根目录,如果不设置则会自动生成根目录的绝对路径。
  1. Template :: $rootPath = dirname(__FILE__); // 相对与绝对路径均可,我们这里则采用绝对路径!如:"C:/wwwroot/prototype"


2. 配置模板文件目录,这个目录是用来存放模板文件的,如果不设置则默认为:templates 目录。
  1. // 这里则采用默认目录,大家根据自己的需求进行设置,建议不要写中文容易出错,目录名的前后加不加正反斜杠都无所谓,最终模板引擎内部会自动校正!
  2. Template :: $templateName = '/templates/';



3. 配置编译文件目录,这是用来存储模板文件被解析后生成的编译文件,如果不设置则默认为:compiles 目录。
  1. Template :: $compileName = '/compiles/'; // 和模板目录一样也采用默认目录。



4. 配置缓存文件目录,这是在模板引擎开启缓存功能后,用来存储编译文件生成的缓存文件,如果不设置默认为:caches 目录。
  1. [size=3][backcolor=#ffffff][font=宋体]Template :: $cacheName = '/caches/'; // 一样使用默认[/font][/backcolor][/size]

5. 配置模板常量目录,可能大家不太理解模板常量是用来干嘛的,和普通的 PHP 常量又有什么区别?关于模板常量的解释,在接下来的运用中我们在详细探讨,这里就先跟我进行配置即可,如果不设置则默认为:constants 目录。
  1. Template :: $constantName = '/constants/'; // 使用默认


6. 到第六步为止,目录的配置就全部完成了,大家不用担心目录不存在的问题,也无需手动去创建,模板引擎内部会自动帮我们完成。那么接下来就是设置模板常量的文件名称,如果不设置则默认为:default.xml 文件,和目录一样不存在模板引擎会自动创建。
  1. // 我们也采用默认,但大家要注意的是这里必须采用 .xml 为扩展名,因为常量文件是以 XML 标记描述的,如果不是 .xml 结尾,那么可能会导致模板引擎在处理常量时出现异常情况!
  2. Template :: $constantFile = 'default.xml';


7. 设置缓存开关,缓存默认情况下是被关闭的,只有我们去设置他,才会开启。
  1. // 大家注意,这里我写的是一个布尔值,其实这里可以填写任意值,最终都会被隐式转换为布尔值,写 0 或 1 都可以,我直接写布尔值是为了方便大家的理解!
  2. Template :: $cacheSwitch = true;


8. 至此模板引擎的配置基本上就已经全部完成了,还是很简单的。现在我们只需要实例化出模板引擎对象,就可以真正的运行模板引擎了。
  1. $tpl = new Template(); // 实例化出模板引擎,从这一步开始之前的所有配置全部生效,模板引擎实例化时不需要传递任何参数。


9. 在实例化出模板引擎对象以后,我们就可以开始对其进行操作,那么对谁进行操作呢?当然是模板文件了,首先我们要先创建模板文件。在模板文件目录中进行创建。模板文件其实是纯 HTML 代码文件,扩展名可以自定义,而我们约定俗成,都以 .tpl 为扩展名。假设我们已经创建了一个模板文件名为:index.tpl,因为和我们的 php 业务逻辑文件 index.php 同名,这也是按照惯例约定俗成,因为 index.php 文件调用 index.tpl 模板,见名知意。

10. 在创建了模板文件之后,我们就可以在业务文件(之前的配置也都是在 index.php 中执行的)中进行对模板文件的加载以及注入模板变量,关于模板变量和其他的模板标识符(又统称模板标记)将在接下来的步骤中逐一讲解。
  1. // 注入变量的格式有两种,大家注意看 API 手册的说明,数组格式与传统的键值对格式均可以,我们两种都使用一下。
  2. $tpl -> assign('title', '头衔'); // 首先是传统键值对格式
  3. $tpl -> assign(array('title' => '头衔', 'name' => '名称')); // 数组格式明显要更加好用一些,因为在注入多个变量时,就可以不用写多个注入语句,一句话就搞定了。
  4. // 如果出现了两个一模一样的变量名称,那么其后会将之前的给替换掉。以下代码,最终 language 变量的值为:英文。
  5. $tpl -> assign(array('language' => '中文', 'language' => '英文'));
  6. // 接下来是加载模板文件,直接写模板名称即可,模板引擎会自动锁定到模板文件目录。
  7. $tpl -> display('index.tpl');


11. 至此对模板引擎的操作就结束了,接下来我们将熟悉一下模板文件中的各个模板标记的使用方法,他们都是用来做什么的。在原型版中模板标记一共有 9 种,分别为:1. 模板变量、2. 模板常量、3. 单行模板注释、4. 多行模板注释、5. include 文件加载、6. template 模板文件加载、7. source 源模板文件加载(较为特殊)、8. if 分歧语句、9. foreach 循环语句。那么我们首先解释一下模板变量吧。
  1. <div id="main">
  2.     <!-- 刚刚我们注入了 title 变量,那么在模板文件中就可以对其进行调用了,调用方法就是保持同名,按照这样的格式抒写即可{$模板变量名称}-->
  3.     <!-- 模板变量的命名规范与 PHP 普通变量一模一样,首位不能为数字,且区分大小写,注意保证格式的正确性,如果错误模板引擎将不会对其进行解析 -->
  4.     <a href="###">{$title}</a> <!-- 正确的格式,被正确解析 -->
  5.     <a href="###">{$123}</a> <!-- 错误的格式,无法解析 -->
  6. </div>


12. 下面是模板常量的使用,模板常量和 PHP 常量虽然名字上都叫他常量,其实本质上并非一回事。模板常量其实可以看做是伪常量,而并非真正的常量,他是通过对 XML 标记的存储,来实现一种全局不变的特定值,这些值需要手动的添加到常量文件中。(手动添加其实不太方便,笔者会在其后的版本迭代中,加入自动添加的功能)
首先我们需要在模板常量文件中手动添加模板常量,代码如下:配置好常量后,接下来就是在模板文件中进行调用,代码如下:
Html代码:
  1. <?xml version="1.0" coding="utf-8" ?>
  2. <root>
  3.     <!-- 必须在 root 根标记中间进行添加,而且一个标记字母都不能出错,注意区分大小写,如果不慎写错,模板引擎将无法对其进行获取 -->
  4.     <constant>
  5.         <key>WEBNAME</key> <!-- 这里填写常量名称注意字母必须全部大写,第一位不能为数字,格式与 PHP 定义常量一样 -->
  6.         <value>网站标题</value> <!-- 常量值 -->
  7.     </constant>
  8.     
  9.     <constant>
  10.         <key>123abc</key> <!-- 错误的常量名 -->
  11.         <value></value> <!-- <span style="line-height: 1.5; font-size: 1em;">值可以为空</span><span style="line-height: 1.5; font-size: 1em;"> --></span>
  12.     </constant>
  13. </root>


13. 下面是模板的注释符,有两种:一种为单行,一种为多行。常用于对模板文件代码的注解,可以让美工配合设计界面的时候了解代码的实际含义。
Html代码
  1. <!-- 大家可以把模板注释放到 HTML 注释符号中,这样美工在设计模板页面的时候会更加一目了然。-->
  2. <!-- 单行注释的格式是:{@}内容可写可不写,但不写也就没有意义了 -->
  3. {@ 普通的单行注释} <!-- 正确的格式 -->
  4. <!-- {@ HTML 注释符号中的单行注释} --> <!-- 正确的格式 -->
  5. {@ 换行的
  6. 单行注释} <!-- 格式错误,单行注释无法换行,模板引擎无法解析 -->
  7. <!-- 多行注释的格式是:{#}...{/#}一头一尾要呼应,内容也可以不写 -->
  8. {#}这是多行注释,注意首位呼应!{/#} <!-- 正确的格式 -->
  9. {#}这是多行注释,
  10. 我换行了!{/#} <!-- 正确的格式 -->
  11. {#} 没有写结尾符号 <!-- 错误的格式,模板引擎无法解析 -->


14. 模板加载标识符,加载方式分为 3 类,别分为:include 对普通文件的直接加载;template 对模板文件进行编译后加载;source 对模板文件进行编译后直接输出编译文件的路径(此方法较为特殊且并不完美,需要在特定的场合中使用,比如:框架页面的调用)
首先是对普通文件的加载调用,代码如下:
Html代码
  1. <!-- 注意抒写格式,被直接加载的文件多半是 php 文件,且文件必须要存在,不存在的文件,模板引擎将会给出一个错误提示,并且终止代码的执行 -->
  2. <!-- 文件名前后的引号,单双引号都可以,但必须保持一致,不能一单一双,否则模板引擎将不会对其解析 -->
  3. {include path = "test.php"} <!-- 正确的格式,将被解析 -->
  4. {include path = 'abc.php"} <!-- 错误的格式,无法被解析 -->
  5. <!-- 如果出现了同一个文件被加载了两次,那么模板引擎只会对其加载第一次后,自动忽略其后的加载 -->
  6. {include path = "123.php"} <!-- 第一次被加载成功 -->
  7. {include path = "123.php"} <!-- 与上一个文件同属一个文件,将无法被再次加载,而被自动忽略 -->


下面是对模板文件的编译加载,代码如下:
Html代码
  1. <!-- 格式与 include 方式基本一样,就不重复阐述了,不一样的是 include 是需要给出具体的路径地址,而 template 则只需要给出模板名称即可,模板引擎会自动找到该模板文件 -->
  2. {template path = 'test.tpl'} <!-- 正确的格式,将会被编译后加载 -->

最后就是模板文件的编译地址的输出,该功能较特殊,即使不理解也没关系,该方法有严重的 BUG 尚未处理完毕,因此并不完美,且使用的概率也极低,这里只做简单的介绍。在其后的版本迭代中,是否会保留并完善,尚在定夺,代码如下:
Html代码
  1. <!-- 这里我们将使用 iframe 框架页面,来调用 source 加载方法,调用格式与前两种雷同,就不在阐述 -->
  2. <!-- 这样使用其实就可以了,但有严重的 BUG 出现,原因是所有在 frame.tpl 中注入的模板标记被解析后,将无法找到源头,也就是说 php 将无法对其正确处理,并且因为无法找到源头,而会报错,该 BUG 的解决方案还在研究中,这里仅提供给大家思考 -->
  3. <iframe src="{source path = 'frame.tpl'}"></iframe>


15. 接下来是经常会被用到的 if 分歧语句,他和 php 的 if 语句很类似,但功能上却很简单,且不支持多重判断以及嵌套判断,但我会在其后的版本迭代中让其功能逐步强大。

Html代码
  1. <!-- if 语句的格式其实和多行注释一样,一定要注意首位呼应,但大小写无所谓都能够支持和 PHP 原生的 if 语句是一样的。 -->
  2. {if $action} <!-- 只要被注入的 {$action} 变量的值为 true,或隐式转换后为 true,那么 if 语句中的代码将被显示 -->
  3. <p>界面1</p>
  4. {/if}
  5. {if !$action} <!-- 加入了逻辑非的判断,只要为 false 则被显示 -->
  6. <p>界面2</p>
  7. {/if}
  8. {if $action} <!-- 双层判断的时候,为 true 时显示界面1,为 false 时显示界面2 -->
  9. <p>界面1</p>
  10. {else}
  11. <p>界面2</p>
  12. {/if}
  13. {if $action} <!-- 错误的格式,没有结尾,不会被模板引擎解析 -->



16. 终于到了最后的也是最复杂的 foreach 循环语句的调用了,其功能和 PHP 一样,只是格式上稍有改动。
Html代码
  1. <!-- 注意在调用 foreach 和 if 语句一样要首尾呼应,而且如果变量不是数组格式,那么 php 将会自动报出一个错误 -->
  2. <!-- 其中 $array 就是被注入的模板变量,注意要是数组格式;而 key 和 value 则是对应数组中的键值对,必须写,否则格式不正确,将无法被模板引擎解析 -->
  3. {foreach $array(key, value)}
  4.     <p>{%key} ... {%value}</p> <!-- 注意键值对可以不是 key 和 value,但一定要和之前同名,否则无法被解析 -->
  5. {/foreach}
  6. {foreach $userList(id, username)}
  7. <p>{%id} ... {%username}</p> <!-- 自定义的 key 和 value,格式正确 -->
  8. <p>{%password}</p> <!-- 错误的格式,并没有被定义,因此无法被解析 -->
  9. {/foreach}
模板引擎原型版的教导到此就结束了。虽然教导文章已经很详细了,但建议大家配合 API 手册和实例代码进行参照阅读,这样效果会更好更便于理解和掌握。转自:石不易—博客园。

评价一下你浏览此帖子的感受

精彩

感动

搞笑

开心

愤怒

无聊

灌水
离线garyhonga
只看该作者 沙发  发表于: 2015-01-11
很详细,谢谢分享
逐历史www.zlishi.com
发帖
116
只看该作者 2楼 发表于: 2015-03-06
看一下
离线小菜一碟