<?php
class Template
{
var $classname = "Template";
var $debug = false;
//包含所有的模板文件名和模板名的數組
var $file = array();
//$root爲模板文件存放的目錄
var $root = "";
//$varkeys[key] = "key"; //存放文本元素的鍵名
//$varvals[key] = "value"; //存放文本元素的值
var $varkeys = array();
var $varvals = array();
//屬性$unknowns設定了對未知內容的處理方法
var $unknowns = "remove";
//設定是否在發生錯誤的時候停止
var $halt_on_error = "yes";
//記錄最後一個錯誤信息
var $last_error = "";
//構造函數默認將模板文件目錄設置爲相同的目錄
//$unknowns默認設置爲"remove"
function Template($root = " ",$unknowns = "remove"){
$this->set_root($root);
$this->set_unknowns($unknowns);
}
//該方法設定$root的值,也就是模板文件的存放目錄
function set_root($root){
if(!is_dir($root)){
$this->halt("set_root:$root is not a directory.");
return false;
}
$this->root = $root;
return true;
}
//該方法設定unknowns的值
function set_unknowns($unknowns = "keep"){
$this->unknowns = $unknowns;
}
//該方法在數組file中根據$handle提供的鍵名加入值
function set_file($handle,$filename = ""){
if(!is_array($handle)){ //如果$handle不是數組
if($filename==""){ //文件名爲空則返回錯誤並停止
$this->halt("set_file:For handle $handle filename is empty.");
return false;
}
//否則用$handle爲鍵名添加新值到file數組
$this->file[$handle] = $this->filename($filename);
}
else{ //如果$handle是數組
reset($handle);
while(list($h,$f) = each($handle)){ //將$handle的鍵名作爲file數組的鍵名,將鍵名對應的值作爲file數組的值
$this->file[$h] = $this->filename($f);
}
}
}
//該方法取出某個父模板文件中的一個子模板,將其作爲“塊”來加載,並用另外一個模板變量取代之
function set_block($parent,$handle,$name=" "){
if(!$this->loadfile($parent)){
$this->halt("subst:unable to load $parent.");
return false;
}
//沒有指定模板變量的值就用子模板名作爲模板變量名
if($name=="")
$name = $handle;
$str = $this->get_var($parent);
$reg = "/(.*)/n/s*/sm";
$ename = "{".$name."}";
//進行抽取和替換
preg_match_all($reg,$str,$m);
$str = preg_replace($reg,"{" . "$name}",$str); //替換父模板中的子模板
$this->set_var($handle,$m[1][0]); //子模板內容放在$handle爲鍵值的數組元素中
$this->set_var($parent,$str);
}
//該方法向$varkeys和$varvals數組中添加新的鍵——值對
function set_var($varname,$value=""){
if(!is_array($varname)){ //如果$varname不是數組
if(!empty($varname))
if($this->debug) print "scalar:set *$varname to *$value*
/n";
$this->varkeys[$varname] = "/".$this->varname($varname)."/";
$this->varvals[$varname] = $value;
}
else{
reset($varname);
while(list($k,$v) = each($varname)){
if(!empty($k))
if($this->debug) print "array:set *$k* to *$v*
/n";
$this->varkeys[$k] = "/".$this->varname($k)."/";
$this->varvals[$k] = $v;
}
}
}
//該方法完成將模板文件中的變化內容替換成確定內容的操作,實現了數據和顯示的分離
function subst($handle){
if(!$this->loadfile($handle)){ //加載模板文件,如果失敗返回錯誤並停止
$this->halt("subst:unable to load $handle.");
return false;
}
$str = $this->get_var($handle); //讀入文件內容到字符串$str,對所有的已知鍵值進行替換並返回結果
$str = preg_replace($this->varkeys,$this->varvals,$str);
return $str;
}
//該方法功能和subst相同,只是直接輸出替換結果
function psubst($handle){
print $this->subst($handle);
return false;
}
//該方法將$handle代表的一個或多個文件中的內容完成替換,存放在$target爲鍵值的varvals數組元素中或追加到其後,返回值和方法subst相同
function parse($target,$handle,$append = false){
if(!is_array($handle)){
$str = $this->subst($handle);
if($append){
$this->set_var($target,$this->get_var($target) . $str);
}
else{
$this->set_var($target,$str);
}
}
else{
reset($handle);
while(list($i,$h) = each($handle)){
$str = $this->subst($h);
$this->set_var($target,$str);
}
}
return $str;
}
//該方法的功能和方法parse相同,只是該方法將結果輸出
function pparse($target,$handle,$append = false){
print $this->parse($target,$handle,$append);
return false;
}
//該方法返回所有的鍵——值對中的值所組成的數組
function get_vars(){
reset($this->varkeys);
while(list($k,$v) = each($this->varkeys)){
$result[$k] = $this->varvals[$k];
}
return $result;
}
//該方法根據鍵名返回對應的鍵——值對的值
function get_var($varname){
if(!is_array($varname)){ //如果$varname不是數組,直接返回其對應的varvals數組中的值
return $this->varvals[$varname];
}
else{ //如果$varname是數組,返回其所有鍵值對應的varvals數組中的值所組成的數組
reset($varname);
while(list($k,$v) = each($varname)){
$result[$k] = $this->varvals[$k];
}
return $result;
}
}
/********************************************************************/
function get_undefined($handle){
if(!$this->loadfile($handle)){ //如果加載文件失敗,返回錯誤並停止
$this->halt("get_undefined:unable to load $handle.");
return false;
}
preg_match_all("//{([^}]+)/}/",$this->get_var($handle),$m);
$m = $m[1];
//如果無法找到匹配的文本,返回錯誤
if(!is_array($m))
return false;
//如果能夠找到大括號中的非空字符,則將其值作爲鍵值,組成一個數組
reset($m);
while(list($k,$v) = each($m)){
if(!isset($this->varkeys[$v]))
$result[$v] = $v;
}
//該數組不爲空就返回該數組,否則返回錯誤
if(count($result))
return $result;
else
return false;
}
//該方法的作用是完成對$str的最後的處理工作,利用類的屬性$unknowns來確定對模板中無法處理的動態部分的處理方法
function finish($str){
switch($this->unknowns){
case "keep": //keep保持不變
break;
case "remove": //remove刪除所有的非控制字符
$str = preg_replace('/{[^/t/r/n}]+}/',"",$str);
break;
case "comment": //comment將大括號中的動態部分替換爲HTML註釋
$str = preg_replace('/{([^/t/r/1])+})/',"",$str);
break;
}
return $str;
}
//該方法將參數變量對應的varvals數組中的值處理後輸出
function p($varname){
print $this->finish($this->get_var($varname));
}
//該方法將參數變量對應的varvals數組中的值處理後返回
function get($varname){
return $this->finish($this->get_var($varname));
}
//該方法的作用是檢查並補充給定的文件名
function filename($filename){
if(substr($filename,0,1)!="/"){ //如果文件名不是以/開頭,則表示是相對路徑,將其補充爲完整的絕對路徑
$filename = $this->root."/".$filename;
}
//如果該文件不存在,停止並輸出錯誤信息
if(!file_exists($filename))
$this->halt("filename:file $filename does not exist.");
//返回的值爲有效的文件名
return $filename;
}
//該方法對變量名進行處理,將正則表達式中的敏感字符變爲轉義字符,並且在變量名兩端加上大括號
function varname($varname){
return preg_quote("{".$varname."}");
}
//該方法根據$handle加載文件到鍵——值對中
function loadfile($handle){
//如果已經加載了$handle爲句柄的文件,直接返回真值
if(isset($this->varkeys[$handle]) and !empty($this->varvals[$handle]))
return true;
if(!isset($this->file[$handle])){ //如果句柄沒有設定,返回錯誤並停止
$this->halt("loadfile:$handle is not a valid handle.");
return false;
}
$filename = $this->file[$handle]; //句柄有效則取出對應的文件名
//將文件的每一行連接成一個字符串
$str = implode("",file($filename));
if(empty($str)){ //字符串爲空說明文件空或者不存在,返回錯誤並停止
$this->halt("loadfile:while loading $handle, $filename does not exist or is empty.");
return false;
}
//如果文件不爲空,用$handle作爲句柄,$str爲變量名,向鍵——值對中添加新的鍵——值
$this->set_var($handle,$str);
return true;
}
//該方法停止程序運行並給出錯誤信息
function halt($msg){
$this->last_error = $msg;
if($this->halt_on_error != "no")
$this->haltmsg($msg);
if($this->halt_on_error == "yes")
die ("Halted.");
return false;
}
//該方法給出錯誤信息
function haltmsg($msg){
printf("Template Error:%s/r/n",$msg);
}
}
?>