一个简单的php模板引擎

模板引擎中最核心的思想是:将模板中的变量编译为php的变量进行输出。

例如:demo.tpl

 

[html][/html] view plaincopy

  1. {$data}
  2. {$title}

 

 

那么模板引擎就要将{$data} {$title} 编译为 <?php echo $data; ?> <?php echo $title; ?>

要实现这个功能使用正则替换就可以了:

 

[php][/php] view plaincopy

  1. $content = ‘{$data}{$title}’;
  2. $pattern = “/\{\\$([a-zA-Z_][a-zA-Z0-9_]*)\}/”;
  3. $content = preg_replace($pattern,'<?php echo \$this->tmpValue[“$1”]  ?>’,$content);
  4. echo $content; // <?php echo $data; ?><?php echo $title; ?>

这就是php模板引擎的核心功能了。下面是我写的一个简单的php模板引擎

 

首先是tempTool.class.php 它的作用的提供模板引擎需要用到的一些小工具

 

[php][/php] view plaincopy

  1. <?php
  2. /**
  3.  * 工具类
  4.  **/
  5. class tempTool
  6. {
  7.     protected $error = array();     //错误信息
  8.     function __construct()
  9.     {
  10.     }
  11.     /**
  12.          * 生成错误日志数组
  13.          **/
  14.         protected function error($k,$v)
  15.         {
  16.                 if(!empty($k) && !empty($v)) {
  17.                         $this->error[$k] = $v;
  18.                 }else {
  19.                         exit(‘tempTool.class.php的error方法收到了不确定的参数错误!’);
  20.                 }
  21.         }
  22.         /**
  23.          * 获取错误信息
  24.          **/
  25.         public function getError() {
  26.                 foreach($this->error as $k=>$v) {
  27.                         echo $k.$v.'<br />’;
  28.                 }
  29.         }
  30. }
  31. ?>

 

然后是template.class.php 它的作用是提供模板引擎应该有的功能

 

[php][/php] view plaincopy

  1. <?php
  2. /**
  3.  * 模板引擎类 用语提供模板引擎应该具有的方法
  4.  **/
  5. include_once “tempTool.class.php”;
  6. class template extends tempTool{
  7.     private $config = array(
  8.                 ‘tmpDir’=>’template/’,       // 模板文件目录
  9.                 ‘cmpDir’=>’compile/’,        // 编译文件目录
  10.                 ‘cacheDir’=>’cache/’,        // 缓存文件目录
  11.                 ‘tmpSuffix’ =>’.tpl’,        // 模板文件后缀
  12.                 ‘cacheSuffix’   =>’.html’,       // 缓存文件后缀
  13.                 ‘caching’   =>false          // 是否开启缓存
  14.             );
  15.     private $tmpFile;               // 模板文件
  16.     private $cmpFile;               // 编译文件
  17.     private $cacheFile;             // 缓存文件
  18.     private $tmpValue = array();            // 变量值栈
  19.     public function __construct($config = null)
  20.     {
  21.         // 同步配置
  22.         if(is_array($config)) {
  23.             $this->config = array_merge($this->config,$config);
  24.         }
  25.         // 检查模板编译缓存目录是否存在不存在创建
  26.         if( !$this->checkDir($this->config[‘tmpDir’]) || !$this->checkDir($this->config[‘cmpDir’]) || !$this->checkDir($this->config[‘cacheDir’]) ) {
  27.             exit;
  28.         }
  29.     }
  30.     /**
  31.      * 检查目录是否存在不存在自动创建
  32.      **/
  33.     private function checkDir($dir)
  34.     {
  35.         if(!is_dir($dir)) {
  36.             if(!mkdir($dir)) {
  37.                 $this->errorLog[] = array(‘创建文件夹失败:’=>$dir);
  38.                 return false;
  39.             }
  40.         }
  41.         return true;
  42.     }
  43.     /**
  44.      * 像模板中分配变量
  45.      *
  46.      **/
  47.     public function assign($k,$v)
  48.     {
  49.         if(!empty($k) && !empty($v)) {
  50.             $this->tmpValue[$k] = $v;
  51.         }else {
  52.             $this->error(‘分配变量失败:’,’分配到模板中变量的key或者value为空!’);
  53.         }
  54.     }
  55.     /**
  56.      * 编译文件
  57.      **/
  58.     public function display($tmpFile)
  59.     {
  60.         // 获取模板文件
  61.         $tmpFile = $this->config[‘tmpDir’].$tmpFile.$this->config[‘tmpSuffix’];
  62.         // 获取编译文件
  63.         $cmpFile = $this->config[‘cmpDir’].md5($tmpFile.’compile’).’.php’;
  64.         if(!file_exists($tmpFile)) {
  65.             $this->error(‘模板文件不存在:’,$tmpFile.’不存在’);
  66.         }
  67.         // 当编译文件不存在或者是模板文件被修改过了才重新编译
  68.         if(!file_exists($cmpFile) || filemtime($cmpFile) < filemtime($tmpFile)) {
  69.             include_once “compile.class.php”;
  70.             $cmp = new compile();
  71.             $cmp->cmp($tmpFile,$cmpFile);
  72.         }
  73.         // 是否开启缓存
  74.         if($this->config[‘caching’]) {
  75.             // 获取缓存文件
  76.             $cacheFile = $this->config[‘cacheDir’].md5($tmpFile.’cache’).$this->config[‘cacheSuffix’];
  77.             // 当缓存文件不存在或者是模板文件被修改过重新生成缓存文件
  78.             if(!file_exists($cacheFile) || filemtime($cacheFile) < filemtime($tmpFile)) {
  79.                 ob_start();
  80.                 include_once $cmpFile;
  81.                 $content = ob_get_clean();
  82.                 if(!file_put_contents($cacheFile,$content)){
  83.                     $this->error(‘编译文件生成失败:’,$cacheFile);
  84.                 }
  85.             }
  86.             //载入缓存文件
  87.                     include $cacheFile;
  88.         }else {
  89.             // 载入编译文件
  90.             include_once $cmpFile;
  91.         }
  92.     }
  93. }

 

compile.class.php  编译类将模板文件编译为php文件

 

[php][/php] view plaincopy

  1. <?php
  2. /**
  3.  * 编译类将模板文件编译为php文件
  4.  **/
  5. include_once “tempTool.class.php”;
  6. class compile extends tempTool
  7. {
  8.     private $content;           // 文件编译后的内容
  9.     /**
  10.      * 将模板文件编译php文件
  11.      **/
  12.     function cmp($tmpFile,$cmpFile)
  13.     {
  14.         if(!($content = file_get_contents($tmpFile))){
  15.             $this->error(“文件读取失败:”,$tmpFile);
  16.         }
  17.         $pattern = “/\{\\$([a-zA-Z_][a-zA-Z0-9_]*)\}/”;
  18.         $this->content = preg_replace($pattern,'<?php echo \$this->tmpValue[“$1”]  ?>’,$content);
  19.         $this->parse($cmpFile);
  20.     }
  21.     /**
  22.      * 将编译好的内容写入文件
  23.      **/
  24.     public function parse($cmpFile)
  25.     {
  26.         if(!file_put_contents($cmpFile,$this->content)){
  27.             $this->error(‘文件写入失败:’,$cmpFile);
  28.         }
  29.     }
  30. }
  31. ?>

下面进行一下测试:

 

1. 新建一个 template 文件夹 在里面写 一个模板 demo.tpl

 

[html][/html] view plaincopy

  1. {$data}
  2. {$title}

2.新建一个demo.php

 

 

[php][/php] view plaincopy

  1. <?php
  2. $config = array(‘caching’=>true);
  3. include_once “template.class.php”;
  4. $tmp = new template($config);
  5. $tmp->assign(‘data’,’ccc’);
  6. $tmp->assign(‘title’,’这时测试用例’);
  7. $tmp->display(‘demo’);

结果输出 ccc这时测试用例

 

可以看一下cache目录和 compile目录下  会生成一个缓存文件 和一个编译文件

这时就成功了

标签