在文章的開頭,首先要向一直關注我的人說聲抱歉!因為原本打算在前端框架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 檔案中完成的(大家可以打開原始碼進行查閱)。
其實對模板引擎的配置又叫做初始化過程,初始化的第一步就是配置對應的目錄,讓模板引擎能夠正確的讀取和寫入該目錄中的資料(配置步驟大家可以自由選擇,不一定非要按照我的順序來配置,但一定要在實例化模板引擎之前完成,否則將會失效),而我們則假設與模板引擎在同一目錄下進行配置,如果非同一目錄對於根目錄的配置需要注意調整。
1. 首先第一步是配置範本引擎的根目錄,如果不設定則會自動產生根目錄的絕對路徑。
Template :: <span>$rootPath</span> = <span>dirname</span>(<span>__FILE__</span>); <span>//</span><span> 相对与绝对路径均可,我们这里则采用绝对路径!如:"C:/wwwroot/prototype"</span>
2. 設定範本檔案目錄,這個目錄是用來存放範本檔案的,如果不設定則預設為:templates 目錄。
<span>//</span><span> 这里则采用默认目录,大家根据自己的需求进行设置,建议不要写中文容易出错,目录名的前后加不加正反斜杠都无所谓,最终模板引擎内部会自动校正!</span> Template :: <span>$templateName</span> = '/templates/';
3. 配置编译文件目录,这是用来存在模板文件被解析后生成的编译文件,如果不设置则默认为:compiles 目录。
Template :: <span>$compileName</span> = '/compiles/'; <span>//</span><span> 和模板目录一样也采用默认目录。</span>
4. 配置缓存文件目录,这是在模板引擎开启缓存功能后,用来存在编译文件生成的缓存文件,如果不设置默认为:caches 目录。
Template :: <span>$cacheName</span> = '/caches/'; <span>//</span><span> 一样使用默认</span>
5. 配置模板常量目录,可能大家不太理解模板常量是用来干嘛的,和普通的PHP常量有什么区别吗?关于模板常量的解释,在接下来的运用在我们在详细探讨,这里就先跟我进行配置即可,如果不设置默认为:constants 目录。
Template :: <span>$constantName</span> = '/constants/'; <span>//</span><span> 使用默认</span>
6. 到第六步为止,目录的配置就全部完成了,大家不用担心目录不存在的问题,也不用手动去创建,模板引擎内部会自动帮我们完成。那么接下来就是设置模板常量的文件名称,如果不设置则默认为:default.xml 文件。
<span>//</span><span> 我们也采用默认,但大家要注意的是这里必须采用 .xml 为扩展名,因为常量文件是以 XML 标记描述的,如果不是 .xml 结尾,那么可能会导致模板引擎在处理常量时出现异常情况!</span> Template :: <span>$constantFile</span> = 'default.xml';
7. 设置缓存开关,缓存默认情况下是被关闭的,只有我们去设置他,才会开启。
<span>//</span><span> 大家注意,这里我写的是一个布尔值,其实这里可以填写任意值,最终都会被隐式转换为布尔值,写 0 或 1 都可以,我直接写布尔值是为了方便大家的理解!</span> Template :: <span>$cacheSwitch</span> = <span>true</span>;
8. 至此模板引擎的配置基本上就已经全部完成了,还是很简单的。现在我们只需要实例化出模板引擎对象,就可以真正的运行模板引擎了。
<span>$tpl</span> = <span>new</span> Template(); <span>//</span><span> 实例化出模板引擎,从这一步开始之前的配置全部生效,模板引擎实例化时不需要传递任何参数。</span>
9. 在实例化出模板引擎对象以后,我们就可以开始对其进行操作,那么对谁进行操作呢?当然是模板文件了,首先我们要先创建模板文件。在模板文件目录中进行创建。模板文件其实是纯 HTML 代码文件,扩展名可以自定义,而我们约定俗成,都已 .tpl 为扩展名。假设我们已经创建了一个模板文件名为:index.tpl,因为和我们的 php 业务逻辑文件 index.php 同名,这也是按照惯例约定俗成,因为 index.php 文件调用 index.tpl 模板,见名知意。
10. 在创建了模板文件之后,我们就可以在业务文件(之前的配置也都是在 index.php 中执行的)中进行对模板文件的加载以及注入模板变量,关于模板变量和其他的模板标识符(又统称模板标记)将在接下来的步骤中逐一讲解。
<span>//</span><span> 注入变量的格式有两种,大家注意看 API 手册的说明,数组格式与传统的键值对格式均可以,我们两种都使用一下。</span> <span>$tpl</span> -> assign('title', '头衔'); <span>//</span><span> 首先是传统键值对格式</span> <span>$tpl</span> -> assign(<span>array</span>('title' => '头衔', 'name' => '名称')); <span>//</span><span> 数组格式明显要更加好用一些,因为在注入多个变量时,就可以不用写多个注入语句,一句话就搞定了。 // 如果出现了两个一模一样的变量名称,那么其后会将之前的给替换掉。以下代码,最终 language 变量的值为:英文。</span> <span>$tpl</span> -> assign(<span>array</span>('language' => '中文', 'language' => '英文'<span>)); </span><span>//</span><span> 接下来是加载模板文件,直接写模板名称即可,模板引擎会自动锁定到模板文件目录。</span> <span>$tpl</span> -> display('index.tpl');
11. 至此对模板引擎的操作就结束了,接下来我们将熟悉一下模板文件中的各个模板标记的使用方法,他们都是用来做什么的。在原型版中模板标记一共有 9 种,分别为:1. 模板变量、2. 模板常量、3. 单行模板注释、4. 多行模板注释、5. include 文件加载、6. template 模板文件加载、7. source 源模板文件加载(较为特殊)、8. if 分歧语句、9. foreach 循环语句。那么我们首先解释一下模板变量吧。
<span><</span><span>div </span><span>id</span><span>="main"</span><span>></span> <span><!--</span><span> 刚刚我们注入了 title 变量,那么模板在模板文件中就可以对其进行调用了,调用方法就是保持同名,按着这样的格式抒写即可{$模板变量名称}</span><span>--></span> <span><!--</span><span> 模板变量的命名规范与 PHP 普通变量一模一样,首位不能为数字,且区分大小写,注意保证格式的正确性,如果错误模板引擎将不会对其进行解析 </span><span>--></span> <span><</span><span>a </span><span>href</span><span>="###"</span><span>></span>{$title}<span></</span><span>a</span><span>></span> <span><!--</span><span> 正确的格式,被正确解析 </span><span>--></span> <span><</span><span>a </span><span>href</span><span>="###"</span><span>></span>{$123}<span></</span><span>a</span><span>></span> <span><!--</span><span> 错误的格式,无法解析 </span><span>--></span> <span></</span><span>div</span><span>></span>
12. 下面是模板常量的使用,模板常量和 PHP 常量虽然名字上都叫他常量,其实本质上并非一回事。模板常量其实看以看做是伪常量,而并非真正的常量,他是通过对 XML 标记的处理,来保持一组特定不变的值,这些值需要手动的添加到常量文件中。(手动添加其实不太方便,笔者会在其后的版本迭代中,加入自动添加的功能)
首先我们需要在模板常量文件中手动添加模板常量,代码如下:
<span><?</span><span>xml version="1.0" coding="utf-8" </span><span>?></span> <span><</span><span>root</span><span>></span> <span><!--</span><span> 必须在 root 根标记中间进行添加,而且一个标记字母都不能出错,注意区分大小写,如果不慎写错,模板引擎将无法对其进行获取 </span><span>--></span> <span><</span><span>constant</span><span>></span> <span><</span><span>key</span><span>></span>WEBNAME<span></</span><span>key</span><span>></span> <span><!--</span><span> 这里填写常量名称注意字母必须全部大写,第一位不能为数字,格式与 PHP 定义常量一样 </span><span>--></span> <span><</span><span>value</span><span>></span>网站标题<span></</span><span>value</span><span>></span> <span><!--</span><span> 值可以为空 </span><span>--></span> <span></</span><span>constant</span><span>></span> <span><</span><span>constant</span><span>></span> <span><</span><span>key</span><span>></span>123abc<span></</span><span>key</span><span>></span> <span><!--</span><span> 错误的常量名 </span><span>--></span> <span><</span><span>value</span><span>></</span><span>value</span><span>></span> <span><!--</span><span> 空值 </span><span>--></span> <span></</span><span>constant</span><span>></span> <span></</span><span>root</span><span>></span>
配置好常量后,接下来就是在模板文件中进行调用,代码如下:
<span><!--</span><span> 模板常量的调用和变量类似,只是取消了 $ 符号,另外常量名要保持一致 </span><span>--></span> <span><</span><span>title</span><span>></span>{WEBANME}<span></</span><span>title</span><span>></span> <span><!--</span><span> 正确的名称,将被正确解析 </span><span>--></span> <span><</span><span>p</span><span>></span>{NAME}<span></</span><span>p</span><span>></span> <span><!--</span><span> 虽然格式正确,但刚才没有进行 NAME 常量的配置,因此最终解析后会返回一个空值 </span><span>--></span> <span><</span><span>p</span><span>></span>{abc123}<span></</span><span>p</span><span>></span> <span><!--</span><span> 错误的名称,无法解析 </span><span>--></span>
13. 下面是模板的注释符,有两种:一种为单行,一种为多行。多用于对模板文件代码的注解,可以让美工配合设计界面的时候了解代码的实际含义。
<span><!--</span><span> 大家可以把模板注释放到 HTML 注释中,这样美工在设置模板页面的时候会更加一目了然。</span><span>--></span> <span><!--</span><span> 单行注释的格式是:{@}内容可写可不写,但不写也就没有意义了 </span><span>--></span><span> {@ 普通的单行注释} </span><span><!--</span><span> 正确的格式 </span><span>--></span> <span><!--</span><span> {@ HTML 代码中的单行注释} </span><span>--></span> <span><!--</span><span> 正确的格式 </span><span>--></span><span> {@ 换行的 单行注释} </span><span><!--</span><span> 格式错误,单行注释无法换行,模板引擎无法解析 </span><span>--></span> <span><!--</span><span> 多行注释的格式是:{#}...{/#}一头一尾要呼应,内容也可以不写 </span><span>--></span><span> {#}这是多行行注释,注意首位呼应!{/#} </span><span><!--</span><span> 正确的格式 </span><span>--></span><span> {#}这是多行行注释, 我换行了!{/#} </span><span><!--</span><span> 正确的格式 </span><span>--></span><span> {#} 没有写结尾符号 </span><span><!--</span><span> 错误的格式,模板引擎无法解析 </span><span>--></span>
14. 模板加载标识符,加载方式分为三类,别分为:include 对普通文件的直接加载;template 对模板文件进行编译后加载;source 对模板文件进行编译后直接输出编译文件的路径(此方法较为特殊且并不完美,需要在特定的场合中使用,比如:框架页面的调用)
首先是对普通文件的加载调用,代码如下:
<span><!--</span><span> 注意抒写格式,被直接加载的文件多半是 php 文件,且文件必须要存在,不存在的文件,模板引擎将会给出一个错误提示,并且终止代码的执行 </span><span>--></span> <span><!--</span><span> 文件名前后的引号,单双引号都可以,但必须保持一致,不能一单一双,否则模板引擎将不会对其解析 </span><span>--></span><span> {include path = "test.php"} </span><span><!--</span><span> 正确的格式,将被解析 </span><span>--></span><span> {include path = 'abc.php"} </span><span><!--</span><span> 错误的格式,无法被解析 </span><span>--></span> <span><!--</span><span> 如果出现了同一个文件被加载了两次,那么模板引擎只会对其加载第一次后,自动忽略其后的加载 </span><span>--></span><span> {include path = "123.php"} </span><span><!--</span><span> 第一次被加载成功 </span><span>--></span><span> {include path = "123.php"} </span><span><!--</span><span> 与上一个文件同属一个文件,将无法被再次加载,而被自动忽略 </span><span>--></span>
下面是对模板文件的编译加载,代码如下:
<span><!--</span><span> 格式与 include 方式基本一样,就不重复阐述了,不一样的是 include 是需要给出具体的路径地址,而 template 则只需要给出模板名称即可,模板引擎会自动找到该模板文件 </span><span>--></span><span> {template path = 'test.tpl'} </span><span><!--</span><span> 正确的格式,将会被编译后加载 </span><span>--></span>
最后就是模板文件的编译地址的输出,该功能较特殊,即使不理解也没关系,该方法有严重的 BUG 尚未处理完毕,因此并不完美,且使用的概率也极低,这里只做简单的介绍。在其后的版本迭代中,是否会保留并完善,尚在定夺,代码如下:
<span><!--</span><span> 这里我们将使用 iframe 框架页面,来调用 source 加载方法,调用格式与前两种雷同,就不在阐述 </span><span>--></span> <span><!--</span><span> 这样使用其实就可以了,但又严重的 BUG 出现,原因是所有在 frame.tpl 中注入的模板标记被解析后,将无法找到源头,也就是说 php 将无法对其正确处理,并且因为无法找到源头,而会报错,该 BUG 的解决方案还在研究中,这里仅提供给大家思考 </span><span>--></span> <span><</span><span>iframe </span><span>src</span><span>="{source path = 'frame.tpl'}"</span><span>></</span><span>iframe</span><span>></span>
15. 接下来是经常会被用到的 if 分歧语句,他和 php 的 if 语句很类似,但功能上却很简单,且不支持多重判断以及嵌套判断,但我会在其后的版本迭代中让其功能逐步强大。
<span><!--</span><span> if 语句的格式其实和多行注释一样,一定要注意首位呼应,但大小写无所谓都能够支持和 PHP 原生的 if 语句是一样的。 </span><span>--></span><span> {if $action} </span><span><!--</span><span> 只要被注入的 {$action} 变量的值为 true,或隐式转换后为 true,那么 if 语句中的代码将被显示 </span><span>--></span> <span><</span><span>p</span><span>></span>界面1<span></</span><span>p</span><span>></span><span> {/if} {if !$action} </span><span><!--</span><span> 加入了逻辑非的判断,只要为 false 则被显示 </span><span>--></span> <span><</span><span>p</span><span>></span>界面2<span></</span><span>p</span><span>></span><span> {/if} {if $action} </span><span><!--</span><span> 双层判断的时候,为 true 时显示界面1,为 false 时显示界面2 </span><span>--></span> <span><</span><span>p</span><span>></span>界面1<span></</span><span>p</span><span>></span><span> {else} </span><span><</span><span>p</span><span>></span>界面2<span></</span><span>p</span><span>></span><span> {/if} {if $action} </span><span><!--</span><span> 错误的格式,没有结尾,不会被模板引擎解析 </span><span>--></span>
16. 终于到了最后的也是复杂的 foreach 循环语句的调用了,其功能和 PHP 一样,只是格式上稍有改动。
<span><!--</span><span> 注意在调用 foreach 和 if 一样要收尾呼应,而且如果变量不是数组格式,那么 php 将会自动报出一个错误 </span><span>--></span> <span><!--</span><span> 其中 $array 就是被注入的模板变量,注意要是数组格式;而 key 和 value 则是对于的数组中的键值对,必须写,否则格式不正确,将无法被模板引擎解析 </span><span>--></span><span> {foreach $array(key, value)} </span><span><</span><span>p</span><span>></span>{%key} ... {%value}<span></</span><span>p</span><span>></span> <span><!--</span><span> 注意 key 和 value 可以自定义,但一定要同名调用,否则无法被解析 </span><span>--></span><span> {/foreach} {foreach $userList(id, username)} </span><span><</span><span>p</span><span>></span>{%id} ... {%username}<span></</span><span>p</span><span>></span> <span><!--</span><span> 自定义的 key 和 value,格式正确 </span><span>--></span> <span><</span><span>p</span><span>></span>{%password}<span></</span><span>p</span><span>></span> <span><!--</span><span> 错误的格式,并没有被定义,因此无法被解析 </span><span>--></span><span> {/foreach}</span>
好了,寫到這裡我也可以長長的舒口氣,模板引擎原型版的教導到此就結束了。雖然教導文章已經很詳細了,但建議大家配合 API 手冊和實例程式碼進行參考閱讀,這樣效果會更好更便於理解和掌握。當然因為是文章,所以即使你描述的再詳細,文字也是抽象的,需要大家多動手,而對於動手能力較差的新手們,這篇教導文章則起不到多大的作用,可能反而會被弄得一頭霧水,甚至最終對此厭惡,所以我有想過如果以後有可能,在版本迭代更新到一定程度後,我會針對性的出一套系列教導視頻,那樣的話就不會像文字這樣抽象,新手也能夠很快的學習。
如果你是從頭看到尾,那麼我真心感謝您的閱覽,我想你應該有什麼話要說,請一定要在下面留言告訴我,有問題也請及時留言,謝謝各位的支持~!
以上就介紹了【PHP 模板引擎】Prototype 原型版發布! ,包括了方面的內容,希望對PHP教程有興趣的朋友有所幫助。