DolrPHP模板引擎DolrViews分享

【分享】DolrPHP模板引擎DolrViews分享
核心文件：DolrViews.class.php:

2. /**
3. * DolrPHP模板引擎
4. * @author Joychao
5. * @version 1.0 beta
6. * @license http://www.Joychao.cc
7. */
8. defined('DOLRVIEWS') or define('DOLRVIEWS',true);
9. defined('DIR_SEP') or define('DIR_SEP',DIRECTORY_SEPARATOR);
10. class DolrViews
11. {
12. /**
13. * 单例对象
14. *
15. * @static var
16. * @var object DolrViews
17. */
18. protected static $_instance;
20. /**
21. * 模板变量
22. *
23. * @var array
24. */
25. protected $_tpl_vars=array();
27. /**
28. * 模板参数信息
29. *
30. * @var array
31. */
32. protected $_options=array(
33. 'template_dir'=>'templates',
34. 'compile_dir'=>'templates_c',
35. 'cache_dir'=>'cache',
36. 'caching'=>false,
37. 'cache_lifetime'=>3600,
38. 'plugins_dir'=>'plugins',
39. 'tpl_suffix'=>'html',
40. 'php_handing'=>false,
41. );
43. /**
44. * 包含的插件
45. * @var array
46. */
47. protected $includePlugins=array();
49. /**
50. * 主模板非包含模板
51. * @var string
52. */
53. protected $mainTplFileName;
55. /**
56. * 单件模式调用方法
57. *
58. * @static
59. * @return object DolrViews
60. */
61. public static function getInstance($options=array()) {
62. if (!self :: $_instance instanceof self)
63. self :: $_instance = new self($options);
64. return self :: $_instance;
65. }
67. /**
68. * 构造函数，初始化所有配置
69. *
70. * @param array $config=array(); 配置数组
71. * @example:
72. * $_options=array(
73. * 'template_dir'=>'templates',
74. * 'compile_dir'=>'templates_c',
75. * 'cache_dir'=>'cache',
76. * 'caching'=>false,
77. * 'cache_lifetime'=>3600,
78. * 'plugins_dir'=>'plugins',
79. * 'php_handing'=>false,
80. * );
81. * $tpl=new DolrViews($_options);
82. */
83. public function __construct($options=array())
84. {
85. if (!empty($options))
86. {
87. $this->setOptions($options);
88. }
89. }
91. /**
92. * 分配变量到模板
93. *
94. * @param string $varName 变量名
95. * @param mixed $varValue 变量值
96. */
97. public function assign($varName,$varValue)
98. {
99. $this->_tpl_vars[$varName]=&$varValue;
100. }
102. /**
103. * 显示输出到页面
104. *
105. * @param string $tplFileName 模板文件名
106. */
107. public function display($tplFileName,$cacheId=null)
108. {
109. $cacheId=is_null($cacheId)?$_SERVER['REQUEST_URI']:$cacheId;
110. $this->mainTplFileName=$tplFileName;
111. $tplFilePath=$this->_getTplPath($tplFileName);
112. extract($this->_tpl_vars);
113. //内置变量
114. extract($this->_getSystemVars($tplFileName));//系统变量
115. //是否缓存
116. if($this->_options['caching']){
117. if($this->isCached($tplFileName,$cacheId)){
118. include $this->_getCacheFile($tplFileName,$cacheId);
119. }else{//否则缓存文件
120. include $this->_writeCache($tplFileName,$this->_parseTpl($tplFileName,$cacheId),$cacheId);// 写入缓存
121. }
122. }else{//非缓存模式
123. include $this->_parseTpl($tplFileName,$cacheId);//解析写入编译文件并包含
124. }
125. }
127. /**
128. * 配置模板选项
129. *
130. * @param array $options 配置数组
131. */
132. public function setOptions($options)
133. {
134. foreach ($options as $optionName => $optionValue) {
135. $this->set($optionName,$optionValue);
136. }
137. }
139. /**
140. * 设置选项
141. *
142. * @param string $optionName 选项名称
143. * @param mixed $optionValue 选项值
144. */
145. public function __set($optionName,$optionValue)
146. {
147. $this->set($optionName,$optionValue);
148. }
150. /**
151. * 单独设置配置
152. *
153. * @param string $optionName 选项名称
154. * @param mixed $optionValue 选项值
155. */
156. public function set($optionName,$optionValue)
157. {
158. switch (strtolower($optionName)) {
159. case 'template_dir':
160. $optionValue=$this->_trimPath($optionValue).DIR_SEP;
161. if(!file_exists($optionValue))
162. $this->_throwException('未找到指定的模板目录"'.$optionValue.'"');
163. $this->_options['template_dir']=$optionValue;
164. break;
165. case 'compile_dir':
166. $optionValue=$this->_trimPath($optionValue).DIR_SEP;
167. if(!file_exists($optionValue))
168. $this->_throwException('未找到指定的编译目录"'.$optionValue.'"');
169. $this->_options['compile_dir']=$optionValue;
170. break;
171. case 'cache_dir':
172. $optionValue=$this->_trimPath($optionValue).DIR_SEP;
173. if(!file_exists($optionValue))
174. $this->_throwException('未找到指定的缓存目录"'.$optionValue.'"');
175. $this->_options['cache_dir']=$optionValue;
176. break;
177. case 'plugins_dir':
178. $optionValue=$this->_trimPath($optionValue).DIR_SEP;
179. if(!file_exists($optionValue))
180. $this->_throwException('未找到指定的缓存目录"'.$optionValue.'"');
181. $this->_options['plugins_dir']=$optionValue;
182. break;
183. case 'caching':
184. $this->_options['caching']=(boolean)$optionValue;
185. break;
186. case 'cache_lifetime':
187. $this->_options['cache_lifetime']=(float)$optionValue;
188. break;
189. case 'php_handing':
190. $this->_options['php_handing']=(boolean)$optionValue;
191. break;
192. case 'tpl_suffix':
193. $this->_options['tpl_suffix']=trim($optionValue);
194. break;
195. default:
196. $this -> _throwException("未知的模板配置选项 \"$optionName\"");
198. }
199. }
201. /**
202. * 清除模板缓存
203. *
204. * @param string $tplFileName='' 模板文件名，不传入则删除所有缓存
205. * @return boolean 成功或者失败
206. */
207. public function clearCache($tplFileName='',$cacheId=null)
208. {
209. $cacheId=is_null($cacheId)?$_SERVER['REQUEST_URI']:$cacheId;
210. if(!empty($tplFileName)){
211. $cacheFile=$this->_getCacheFile($tplFileName,$cacheId);
212. if(file_exists($cacheFile)){
213. chmod($cacheFile, 0777);
214. @unlink($cacheFile);
215. }
216. }else{//删除所有缓存文件
217. foreach (glob($this->_options['cache_dir'].'*') as $cacheFile) {
218. chmod($cacheFile, 0777);
219. @unlink($cacheFile);
220. }
221. }
222. }
224. /**
225. * 检测是否缓存了指定模板文件
226. *
227. * @param string $tplFileName 模板文件名
228. * @return boolean
229. */
230. public function isCached( $tplFileName,$cacheId=null)
231. {
232. $tplFilePath=$this->_getTplPath($tplFileName);
233. $cacheId=is_null($cacheId)?$_SERVER['REQUEST_URI']:$cacheId;
234. $cacheFile=$this->_getCacheFile($tplFileName,$cacheId);
235. if(file_exists($cacheFile) //存在
236. and filemtime($cacheFile)+$this->_options['cache_lifetime']>time()//未过期
237. and filemtime($cacheFile)>filemtime($tplFilePath) //模板没有改动
238. ){//存在并没过期
239. return true;
240. }else{
241. return false;
242. }
243. }
245. /**
246. * 获取内置变量
247. * @return array
248. */
249. protected function _getSystemVars($tplFileName){
250. //内置变量
251. $_sysVars=array();
252. $_sysVars['dolr_now']=time();
253. $_sysVars['dolr_get']=$_GET;
254. $_sysVars['dolr_post']=$_POST;
255. $_sysVars['dolr_request']=$_REQUEST;
256. $_sysVars['dolr_cookie']=isset($_COOKIE)?$_COOKIE:null;
257. $_sysVars['dolr_session']=isset($_SESSION)?$_SESSION:null;
258. $_sysVars['dolr_template']=basename($tplFileName);
259. $const=get_defined_constants(true);
260. $_sysVars['dolr_const']=$const['user'];
261. $_sysVars['dolr_url']="http://".$_SERVER ['HTTP_HOST'].$_SERVER['PHP_SELF'];
262. if(!empty($_SERVER['QUERY_STRING'])){
263. $_sysVars['dolr_url'].='?'.$_SERVER['QUERY_STRING'];
264. }
265. return $_sysVars;
266. }
268. /**
269. * 获取模板文件路径
270. *
271. * @param string $tplFileName 模板文件
272. * @return string 文件名
273. */
274. protected function _getTplPath($tplFileName)
275. {
276. return $this->_options['template_dir'].$this->_trimPath($tplFileName);
277. }
279. /**
280. * 获取缓存的文件
281. * @param string $tplFileName 模板文件
282. * @return string 文件名
283. */
284. protected function _getCacheFile($tplFileName, $cacheId)
285. {
286. return $this->_options['cache_dir'].$tplFileName.'.cache.'.md5($cacheId).'.php';
287. }
289. /**
290. * 获取编译的文件名
291. *
292. * @param string $tplFileName 模板文件
293. * @return string 文件名
294. */
295. protected function _getCompileFile( $tplFileName, $cacheId)
296. {
297. return $this->_options['compile_dir'].$tplFileName.'.compile.php';
298. }
300. /**
301. * 解析模板
302. *
303. * @param string $tplFileName 模板文件
304. * @return string 解析后的内容
305. */
306. protected function _parseTpl($tplFileName,$cacheId)
307. {
308. $tplFilePath=$this->_getTplPath($tplFileName);
309. if (!file_exists($tplFilePath) or !is_readable($tplFilePath)) {
310. $this->_throwException('不能打开指定的模板文件"'.$tplFileName.'"');
311. }
312. $content=file_get_contents($tplFilePath);
314. //检测包含,检测所有的include 'xxx.html'
315. preg_match_all('/[\n\r\t]*[\n\r\t]*/s', $content, $matches);
317. if(!empty($matches[1])){
318. foreach ($matches[1] as $key=>$fileName) {
319. $includeFilePath=$this->_getTplPath($fileName);
320. if (!file_exists($includeFilePath) or !is_readable($includeFilePath)) {
321. $this->_throwException('不能打开指定的模板文件"'.$includeFilePath.'"');
322. }
323. $includeCompilePath=$this->_getCompileFile($fileName,$cacheId);//得到编译文件名
324. $this->_parseTpl($fileName,$cacheId);
325. $content=str_replace($matches[0][$key], '', $content);
326. }
327. }
328. //规则
329. $pattern=array(
330. '/ \?\>[\n\r]*\
331. '/(]+)\s*>)/es',//直接输出变量内容
332. '//s',//包含模板
333. '/(.+?)/ies',//if /if
334. '//ies',//elseif
335. '//is',//else
336. '/(.+?)(.+?)/ies',//loop $array $v
337. '/(.+?)/ies',//loop $array $v
338. '/(.+?)(.+?)/ies',//loop $array $k $v loopelse
339. '/(.+?)/ies',//loop $array $k $v
340. '//',//
341. );
342. //PHP格式
343. $php=array(
344. ' ',
345. "\$this->_parseVar('\\1')",
346. '_options['template_dir']."\\1';?>",
347. "\$this->_stripvtags('','\\2');",
348. "\$this->_stripvtags('','');",
349. '',
350. "\$this->_stripvtags('','\\3\\4');",
351. "\$this->_stripvtags('','\\3\n');",
353. "\$this->_stripvtags(' \\3) { ?>','\\4\\5');",
354. "\$this->_stripvtags(' \\3) { ?>','\\4');",
356. "",
357. );
359. $content=preg_replace($pattern, $php, $content);
361. //包含插件
362. $pluginsString='';
363. if($tplFileName==$this->mainTplFileName){//如果为主模板则放入include文件
364. foreach ($this->includePlugins as $plugin) {
365. $pluginsString.="include \$this->_options['plugins_dir'].'{$plugin}';\n";
366. }
367. }
368. $header=
370. /**
371. * {$tplFileName}
372. * DolrViews 模板编译文件
373. * @package {$this->mainTplFileName}
374. */
375. defined('DOLRVIEWS') or exit('Access denied');
376. $pluginsString
377. ?>\n
378. DOLRVIEWS;
379. $content=$header.$content;
380. $compileFilePath=$this->_writeCompile($tplFileName,$content,$cacheId);//写入编译文件
381. return $compileFilePath;
382. }
384. /**
385. * 缓存模板文件
386. *
387. * @param string $tplFileName 模板文件
388. * @param string $cacheId 缓存ID
389. */
390. protected function _writeCache($tplFileName,$cacheId)
391. {
392. $tplFilePath=$this->_getTplPath($tplFileName);
393. $cacheFilePath=$this->_getCacheFile($tplFileName,$cacheId);//保存文件名
394. $compileFilePath=$this->_getCompileFile($tplFileName,$cacheId);
395. ini_set('error_reporting','off');//不缓存错误提示
396. extract($this->_tpl_vars);//模板变量
397. extract($this->_getSystemVars($tplFileName));//系统变量
398. ob_start();
399. if(file_exists($compileFilePath) and filemtime($compileFilePath)>filemtime($tplFilePath))//模板没有改动
400. {
401. include $compileFilePath;
402. }else{
403. include $this->_parseTpl($tplFileName,$cacheId);//解析并写入编译文件
404. }
405. $html=ob_get_contents();
406. ob_clean();
407. file_put_contents($cacheFilePath, $html);
408. return $cacheFilePath;
409. }
411. /**
412. * 写入编译文件
413. *
414. * @param string $tplFileName 模板文件
415. * @param string $cacheId 缓存ID
416. * @param string $content 网页
417. */
418. protected function _writeCompile($tplFileName,$content,$cacheId)
419. {
420. $compileFilePath=$this->_getCompileFile($tplFileName,$cacheId);//保存文件名
421. if(!file_exists(dirname($compileFilePath))){
422. $this->_makeDir(dirname($compileFilePath));
423. }
424. file_put_contents($compileFilePath,$content);
425. return $compileFilePath;
426. }
428. /**
429. * 将路径修正为适合操作系统的形式
430. *
431. * @param string $path 路径名称
432. * @return string
433. */
434. protected function _trimPath( $path)
435. {
436. return rtrim(str_replace(array('/', '\\', '//', '\\\\'),DIR_SEP, $path),DIR_SEP);
437. }
439. /**
440. * 根据指定的路径创建不存在的文件夹
441. *
442. * @param string $path 路径/文件夹名称
443. * @return string
444. */
445. protected function _makeDir( $path)
446. {
447. $dirs = explode(DIR_SEP, $this ->_trimPath($path));
448. $tmp = '';
449. foreach ($dirs as $dir)
450. {
451. $tmp .= $dir . DIR_SEP;
452. if (!file_exists($tmp) && !@mkdir($tmp, 0777))
453. return $tmp;
454. }
455. return true;
456. }
458. /**
459. * 变量处理
460. *
461. * @param string $string 目标字符串
462. * @return string
463. */
464. protected function _parseVar($string){
465. $pattern=array(
466. '/^',
467. '/>$/',
468. '/(\$\w+\|[^>\s]+)/e',//$title|striptags|html2text
469. '/(\$[\w]+\.[\w]+)/e',
470. );
471. $replacement=array(
472. "
473. ' ?>',
474. "\$this->_parseModifier('\\1');",
475. "\$this->_parsePoint('\\1');",
476. );
477. return stripslashes(preg_replace($pattern, $replacement, $string));
478. }
480. /**
481. * 变量调节器的处理
482. *
483. * @param string $string 模板中匹配到的变量
484. * @return string 处理后的字符串
485. */
486. protected function _parseModifier($string)
487. {
488. $arr=explode('|', trim($string,';'));
489. $tmp=array_shift($arr);
490. foreach($arr as $value)
491. {
492. $tmpArr=explode(':',$value);//html2text
493. $funcName=array_shift($tmpArr);//html2text
494. $args=count($tmpArr)>0?','.join(',',$tmpArr):'';//参数用,号链接 arg1,arg2,arg3
495. if(!function_exists($funcName)){//如果不是PHP内置函数则包含插件
496. if(!file_exists($this->_options['plugins_dir'].'modifier_'.$funcName.'.php')){
497. $this->_throwException('插件"'.$funcName.'"不存在');
498. }
499. $pluginFileName='modifier_'.$funcName.'.php';
500. if(!in_array($pluginFileName, $this->includePlugins)){
501. $this->includePlugins[]=$pluginFileName;//添加include插件
502. }
503. $tmp="dolr_modifier_{$funcName}($tmp{$args})";
504. }else{
505. $tmp="{$funcName}($tmp{$args})";
506. }
507. }
508. return stripslashes($tmp.';');
509. }
511. /**
512. * 数组操作的点支持
513. *
514. * @param string $string 目标字符串
515. * @return string
516. */
517. protected function _parsePoint($string)
518. {
519. $arr=explode('.',$string);//$a.b.c.f
520. $varName=array_shift($arr);//$a
521. return $varName.'[\''.join('\'][\'',$arr).'\']';//$a['b']['c']['f']
522. }
524. /**
525. * 去掉自定义标签
526. *
527. * @param string $expr 源文
528. * @param string $statement 替换目标
529. * @return string
530. */
531. protected function _stripvtags($expr, $statement)
532. {
533. $expr = str_replace("\\\"", "\"", preg_replace("/\/s", "\\1", $expr));
534. $statement = str_replace("\\\"", "\"", $statement);
535. return $expr . $statement;
536. }
538. /**
539. * 抛出一个错误信息
540. *
541. * @param string $message
542. * @return void
543. */
544. protected function _throwException($message)
545. {
546. trigger_error('DolrViews错误：'.$message);
547. exit;
548. }
550. }
551. /* vim: set expandtab: */

使用范例：
PHP:

2. include 'DolrViews.class.php';
3. $tpl=DolrViews::getInstance();//单例
4. $_options=array(
5. 'template_dir'=>'templates',//模板目录
6. 'compile_dir'=>'templates_c',//编译目录
7. 'cache_dir'=>'cache',//缓存目录
8. 'caching'=>false,//是否缓存
9. 'cache_lifetime'=>3600,//缓存有效期
10. 'plugins_dir'=>'plugins',//插件目录
11. 'tpl_suffix'=>'html',//模板后缀
12. );
14. $tpl->setOptions($_options);//保存如上设置
16. $title="标题测试啊";
17. $val=3;
18. $array=array(
19. array('username'=>'Joychao','password'=>'nowpass'),
20. array('username'=>'DolrPHP','password'=>'password'),
21. );
22. $var='这里是带标签的HTML';
24. //分配变量
25. $tpl->assign('val',$val);
26. $tpl->assign('title',$title);
27. $tpl->assign('array',$array);
29. //显示
30. $tpl->display('index.html');

模板index.html：

6. --包含文件----------------------------
   
8. ------if else------------------------
   
10. do anything
12. do another
14. Do not
16. ---------------------------------
    
18. ------loop------------------------
    

20. 循环内容

21. 交互式显示：
22. 循环中的变量：

23. 循环中的索引$dolr_index:ccc

25. 没有内容
27. ---------------------------------
    
28. --包含文件----------------------------
    
30. ------------------------------
    

目录范例：
DolrViews/
|--cache //缓存目录
|--plugins //插件目录
|--templates //模板目录
|--templates_c //编译文件目录
|--DolrViews.classs.php //引擎主文件
|--index.php //测试文件


目前插件只写了一个测试，插件规范是modifier_函数名.php 内容函数名：dolr_modifier_函数名($第一个参数必须[,其它参数])。范例：

1. function dolr_modifier_html2text($string)
2. {
3. return strip_tags($string);
4. }

今天刚写的，欢迎大家拍砖啊！ 另外欢迎 @安正超 ！