【PHP 模板引擎】Prototype 原型版发布！

在文章的开头，首先要向一直关注个人人说声抱歉！由于本来是打算在前端框架5.0发布以后，就立马完成 PHP 模板引擎的第一版。但我没能作到，并且一直拖到了15年元旦才完成，有很严重的拖延症我很惭愧，再次抱歉！

以前有说过之后的做品发布文章都会同步发表相应的 API 使用说明，但我以为这还不够好并且博客平台对表格的处理和显示不是很友好，致使 API 不能完美的呈现，所以打算只提供 API 连接，你们能够经过连接直接访问到个人官网去查阅手册，那样的阅读体验是最好的。而发布的文章之后则更新一些和 API 相关的使用教导，提供一些小例子，让你们在阅读 API 的同时，也可以经过实际例子去更加深入的体会到代码的各类用法与业务逻辑思想！

 

如下是 API 手册与实例演示连接

【实例演示】：http://www.shibuyi.net/demo/php/template_engine/prototype

【官方 API 使用手册】：http://www.shibuyi.net/api/php/template_engine/prototype

【笔者我的官网】：http://www.shibuyi.net

 

 

下面为 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. 首先第一步是配置模板引擎的根目录，若是不设置则会自动生成根目录的绝对路径。

Template :: $rootPath = dirname(__FILE__); // 相对与绝对路径都可，咱们这里则采用绝对路径！如："C:/wwwroot/prototype"

 

2. 配置模板文件目录，这个目录是用来存放模板文件的，若是不设置则默认为：templates 目录。

// 这里则采用默认目录，你们根据本身的需求进行设置，建议不要写中文容易出错，目录名的先后加不加正反斜杠都无所谓，最终模板引擎内部会自动校订！
Template :: $templateName = '/templates/';

 

3. 配置编译文件目录，这是用来存储模板文件被解析后生成的编译文件，若是不设置则默认为：compiles 目录。

Template :: $compileName = '/compiles/'; // 和模板目录同样也采用默认目录。

 

4. 配置缓存文件目录，这是在模板引擎开启缓存功能后，用来存储编译文件生成的缓存文件，若是不设置默认为：caches 目录。

Template :: $cacheName = '/caches/'; // 同样使用默认

 

5. 配置模板常量目录，可能你们不太理解模板常量是用来干吗的，和普通的 PHP 常量又有什么区别？关于模板常量的解释，在接下来的运用中咱们在详细探讨，这里就先跟我进行配置便可，若是不设置则默认为：constants 目录。

Template :: $constantName = '/constants/'; // 使用默认

 

6. 到第六步为止，目录的配置就所有完成了，你们不用担忧目录不存在的问题，也无需手动去建立，模板引擎内部会自动帮咱们完成。那么接下来就是设置模板常量的文件名称，若是不设置则默认为：default.xml 文件，和目录同样不存在模板引擎会自动建立。

// 咱们也采用默认，但你们要注意的是这里必须采用 .xml 为扩展名，由于常量文件是以 XML 标记描述的，若是不是 .xml 结尾，那么可能会致使模板引擎在处理常量时出现异常状况！
Template :: $constantFile = 'default.xml';

 

7. 设置缓存开关，缓存默认状况下是被关闭的，只有咱们去设置他，才会开启。

// 你们注意，这里我写的是一个布尔值，其实这里能够填写任意值，最终都会被隐式转换为布尔值，写 0 或 1 均可以，我直接写布尔值是为了方便你们的理解！
Template :: $cacheSwitch = true;

 

8. 至此模板引擎的配置基本上就已经所有完成了，仍是很简单的。如今咱们只须要实例化出模板引擎对象，就能够真正的运行模板引擎了。

$tpl = new Template(); // 实例化出模板引擎，从这一步开始以前的全部配置所有生效，模板引擎实例化时不须要传递任何参数。

 

9. 在实例化出模板引擎对象之后，咱们就能够开始对其进行操做，那么对谁进行操做呢？固然是模板文件了，首先咱们要先建立模板文件。在模板文件目录中进行建立。模板文件实际上是纯 HTML 代码文件，扩展名能够自定义，而咱们约定俗成，都以 .tpl 为扩展名。假设咱们已经建立了一个模板文件名为：index.tpl，由于和咱们的 php 业务逻辑文件 index.php 同名，这也是按照惯例约定俗成，由于 index.php 文件调用 index.tpl 模板，见名知意。

 

10. 在建立了模板文件以后，咱们就能够在业务文件（以前的配置也都是在 index.php 中执行的）中进行对模板文件的加载以及注入模板变量，关于模板变量和其余的模板标识符（又统称模板标记）将在接下来的步骤中逐一讲解。

// 注入变量的格式有两种，你们注意看 API 手册的说明，数组格式与传统的键值对格式都可以，咱们两种都使用一下。
$tpl -> assign('title', '头衔'); // 首先是传统键值对格式
$tpl -> assign(array('title' => '头衔', 'name' => '名称')); // 数组格式明显要更加好用一些，由于在注入多个变量时，就能够不用写多个注入语句，一句话就搞定了。

// 若是出现了两个如出一辙的变量名称，那么其后会将以前的给替换掉。如下代码，最终 language 变量的值为：英文。
$tpl -> assign(array('language' => '中文', 'language' => '英文'));// 接下来是加载模板文件，直接写模板名称便可，模板引擎会自动锁定到模板文件目录。
$tpl -> display('index.tpl');

 

11. 至此对模板引擎的操做就结束了，接下来咱们将熟悉一下模板文件中的各个模板标记的使用方法，他们都是用来作什么的。在原型版中模板标记一共有 9 种，分别为：1. 模板变量、2. 模板常量、3. 单行模板注释、4. 多行模板注释、5. include 文件加载、6. template 模板文件加载、7. source 源模板文件加载（较为特殊）、8. if 分歧语句、9. foreach 循环语句。那么咱们首先解释一下模板变量吧。

<div id="main">
    <!-- 刚刚咱们注入了 title 变量，那么在模板文件中就能够对其进行调用了，调用方法就是保持同名，按照这样的格式抒写便可{$模板变量名称}-->
    <!-- 模板变量的命名规范与 PHP 普通变量如出一辙，首位不能为数字，且区分大小写，注意保证格式的正确性，若是错误模板引擎将不会对其进行解析 -->
    <a href="###">{$title}</a> <!-- 正确的格式，被正确解析 -->
    <a href="###">{$123}</a> <!-- 错误的格式，没法解析 -->
</div>

 

12. 下面是模板常量的使用，模板常量和 PHP 常量虽然名字上都叫他常量，其实本质上并不是一回事。模板常量其实能够看作是伪常量，而并不是真正的常量，他是经过对 XML 标记的存储，来实现一种全局不变的特定值，这些值须要手动的添加到常量文件中。（手动添加其实不太方便，笔者会在其后的版本迭代中，加入自动添加的功能）

首先咱们须要在模板常量文件中手动添加模板常量，代码以下：

<?xml version="1.0" coding="utf-8" ?>
<root>
    <!-- 必须在 root 根标记中间进行添加，并且一个标记字母都不能出错，注意区分大小写，若是不慎写错，模板引擎将没法对其进行获取 -->
    <constant>
        <key>WEBNAME</key> <!-- 这里填写常量名称注意字母必须所有大写，第一位不能为数字，格式与 PHP 定义常量同样 -->
        <value>网站标题</value> <!-- 常量值 -->
    </constant>
    
    <constant>
        <key>123abc</key> <!-- 错误的常量名 -->
        <value></value> <!-- 值能够为空 -->
    </constant>
</root>

 配置好常量后，接下来就是在模板文件中进行调用，代码以下：

<!-- 模板常量的调用和变量相似，只是取消了 $ 符号，另外和配置的常量名要保持一致 -->
<title>{WEBANME}</title> <!-- 正确的名称，将被正确解析 -->
<p>{NAME}</p> <!-- 虽然格式正确，但刚才没有进行 NAME 常量的配置，所以最终解析后会返回一个空值 -->
<p>{abc123}</p> <!-- 错误的名称，没法解析 -->

 

13. 下面是模板的注释符，有两种：一种为单行，一种为多行。经常使用于对模板文件代码的注解，可让美工配合设计界面的时候了解代码的实际含义。

<!-- 你们能够把模板注释放到 HTML 注释符号中，这样美工在设计模板页面的时候会更加一目了然。-->
<!-- 单行注释的格式是：{@}内容可写可不写，但不写也就没有意义了 -->
{@ 普通的单行注释} <!-- 正确的格式 -->
<!-- {@ HTML 注释符号中的单行注释} --> <!-- 正确的格式 -->
{@ 换行的
单行注释} <!-- 格式错误，单行注释没法换行，模板引擎没法解析 -->
<!-- 多行注释的格式是：{#}...{/#}一头一尾要呼应，内容也能够不写 -->
{#}这是多行注释，注意首位呼应！{/#} <!-- 正确的格式 -->
{#}这是多行注释，
我换行了！{/#} <!-- 正确的格式 -->
{#}没有写结尾符号 <!-- 错误的格式，模板引擎没法解析 -->

 

14. 模板加载标识符，加载方式分为 3 类，别分为：include 对普通文件的直接加载；template 对模板文件进行编译后加载；source 对模板文件进行编译后直接输出编译文件的路径（此方法较为特殊且并不完美，须要在特定的场合中使用，好比：框架页面的调用）

首先是对普通文件的加载调用，代码以下：

<!-- 注意抒写格式，被直接加载的文件多半是 php 文件，且文件必需要存在，不存在的文件，模板引擎将会给出一个错误提示，而且终止代码的执行 -->
<!-- 文件名先后的引号，单双引号均可以，但必须保持一致，不能一单一双，不然模板引擎将不会对其解析 -->
{include path = "test.php"} <!-- 正确的格式，将被解析 -->
{include path = 'abc.php"} <!-- 错误的格式，没法被解析 -->
<!-- 若是出现了同一个文件被加载了两次，那么模板引擎只会对其加载第一次后，自动忽略其后的加载 -->
{include path = "123.php"} <!-- 第一次被加载成功 -->
{include path = "123.php"} <!-- 与上一个文件同属一个文件，将没法被再次加载，而被自动忽略 -->

下面是对模板文件的编译加载，代码以下：

<!-- 格式与 include 方式基本同样，就不重复阐述了，不同的是 include 是须要给出具体的路径地址，而 template 则只须要给出模板名称便可，模板引擎会自动找到该模板文件 -->
{template path = 'test.tpl'} <!-- 正确的格式，将会被编译后加载 -->

最后就是模板文件的编译地址的输出，该功能较特殊，即便不理解也不要紧，该方法有严重的 BUG 还没有处理完毕，所以并不完美，且使用的几率也极低，这里只作简单的介绍。在其后的版本迭代中，是否会保留并完善，尚在定夺，代码以下：

<!-- 这里咱们将使用 iframe 框架页面，来调用 source 加载方法，调用格式与前两种雷同，就不在阐述 -->
<!-- 这样使用其实就能够了，但有严重的 BUG 出现，缘由是全部在 frame.tpl 中注入的模板标记被解析后，将没法找到源头，也就是说 php 将没法对其正确处理，而且由于没法找到源头，而会报错，该 BUG 的解决方案还在研究中，这里仅提供给你们思考 -->
<iframe src="{source path = 'frame.tpl'}"></iframe>

 

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

<!-- if 语句的格式其实和多行注释同样，必定要注意首位呼应，但大小写无所谓都可以支持和 PHP 原生的 if 语句是同样的。 -->
{if $action} <!-- 只要被注入的 {$action} 变量的值为 true，或隐式转换后为 true，那么 if 语句中的代码将被显示 -->
<p>界面1</p>
{/if}

{if !$action} <!-- 加入了逻辑非的判断，只要为 false 则被显示 -->
<p>界面2</p>
{/if}

{if $action} <!-- 双层判断的时候，为 true 时显示界面1，为 false 时显示界面2 -->
<p>界面1</p>
{else}
<p>界面2</p>
{/if}

{if $action} <!-- 错误的格式，没有结尾，不会被模板引擎解析 -->

 

16. 终于到了最后的也是最复杂的 foreach 循环语句的调用了，其功能和 PHP 同样，只是格式上稍有改动。

<!-- 注意在调用 foreach 和 if 语句同样要首尾呼应，并且若是变量不是数组格式，那么 php 将会自动报出一个错误 -->
<!-- 其中 $array 就是被注入的模板变量，注意要是数组格式；而 key 和 value 则是对应数组中的键值对，必须写，不然格式不正确，将没法被模板引擎解析 -->
{foreach $array(key, value)}
    <p>{%key} ... {%value}</p> <!-- 注意键值对能够不是 key 和 value，但必定要和以前同名，不然没法被解析 -->
{/foreach}

{foreach $userList(id, username)}
   <p>{%id} ... {%username}</p> <!-- 自定义的键值对，格式正确 -->
   <p>{%password}</p> <!-- 错误的格式，并无被定义，所以没法被解析 -->
{/foreach}

 

好了，写到这里我也能够长长的舒口气，模板引擎原型版的教导到此就结束了。虽然教导文章已经很详细了，但建议你们配合 API 手册和实例代码进行参照阅读，这样效果会更好更便于理解和掌握。固然由于是文章，因此即便你描述的再详细，文字也是抽象的，须要你们多动手，而对于动手能力较差的新手们，这篇教导文章则起不到多大的做用，可能反而会被弄得一头雾水，甚至最终对此厌恶，因此我有想过若是之后有可能，在版本迭代更新到必定程度后，我会针对性的出一套系列教导视频，那样的话就不会像文字这样抽象，新手也可以很快的学习。

 

若是你是从头看到尾，那么我真心感谢您的阅览，我想你应该有什么话想说，请必定要在下面留言告诉我，有问题也请及时留言，感谢各位的支持~！