/***[ variables ]***********************************************************/
var $filecontents=""; /* raw contents of template file */
var $blocks=array(); /* unparsed blocks */
var $parsed_blocks=array(); /* parsed blocks */
var $block_parse_order=array(); /* block parsing order for recursive parsing (sometimes reverse:) */
var $sub_blocks=array(); /* store sub-block names for fast resetting */
var $VARS=array(); /* variables array */
var $file_delim="/{FILEs*"(.*?)"s*}/m"; /* regexp for file includes */
var $block_start_delim="<!-- "; /* block start delimiter */
var $block_end_delim="-->"; /* block end delimiter */
var $block_start_word="BEGIN:"; /* block start word */
var $block_end_word="END:"; /* block end word */
/* this makes the delimiters look like: <!-- BEGIN: block_name --> if you use my syntax. */
var $NULL_STRING=array(""=>""); /* null string for unassigned vars */
var $NULL_BLOCK=array(""=>""); /* null string for unassigned blocks */
var $mainblock="";
var $ERROR="";
var $AUTORESET=1; /* auto-reset sub blocks */
/***[ constructor ]*********************************************************/
function XTemplate ($file,$mainblock="main") {
$this->mainblock=$mainblock;
$this->filecontents=$this->r_getfile($file); /* read in template file */
$this->blocks=$this->maketree($this->filecontents,$mainblock); /* preprocess some stuff */
$this->scan_globals();
}
/***************************************************************************/
/***[ public stuff ]********************************************************/
/***************************************************************************/
/***[ assign ]**************************************************************/
/*
assign a variable
*/
function assign ($name,$val="") {
if (gettype($name)=="array") {
while (list($k,$v)=each($name)) {
$this->VARS[$k]=$v;
}
} else {
$this->VARS[$name]=$val;
}
}
/***[ parse ]***************************************************************/
/*
parse a block
*/
function parse ($bname) {
$copy=$this->blocks[$bname];
if (empty($this->blocks[$bname]))
$this->set_error ("parse: blockname [$bname] does not exist");
preg_match_all("/{([A-Za-z0-9._]+?)}/",$this->blocks[$bname],$var_array);
$var_array=$var_array[1];
while (list($k,$v)=each($var_array)) {
$sub=explode(".",$v);
if ($sub[0]=="_BLOCK_") {
unset($sub[0]);
$bname2=implode(".",$sub);
$var=$this->parsed_blocks[$bname2];
$nul=(empty($this->NULL_BLOCK[$bname2])) ? $this->NULL_BLOCK[""] : $this->NULL_BLOCK[$bname2];
$var=(empty($var))?$nul:$var;
$copy=ereg_replace("{".$v."}","$var",$copy);
} else {
$var=$this->VARS;
while(list($k1,$v1)=each($sub))
$var=$var[$v1];
$nul=(empty($this->NULL_STRING[$v])) ? ($this->NULL_STRING[""]) : ($this->NULL_STRING[$v]);
$var=(empty($var))?$nul:$var;
$copy=ereg_replace("{$v}","$var",$copy);
}
}
$this->parsed_blocks[$bname].=$copy;
// reset sub-blocks
if ($this->AUTORESET) {
if (!empty($this->sub_blocks[$bname])) {
reset($this->sub_blocks[$bname]);
while (list($k,$v)=each($this->sub_blocks[$bname]))
$this->reset($v);
}
}
}
/***[ rparse ]**************************************************************/
/*
returns the parsed text for a block, including all sub-blocks.
*/
function rparse($bname) {
if (!empty($this->sub_blocks[$bname])) {
reset($this->sub_blocks[$bname]);
while (list($k,$v)=each($this->sub_blocks[$bname])) {
if (!empty($v))
$this->rparse($v,$indent."t");
}
}
$this->parse($bname);
}
/***[ insert_loop ]*********************************************************/
/*
inserts a loop ( call assign & parse )
*/
function insert_loop($bname,$var,$value="") {
$this->assign($var,$value);
$this->parse($bname);
}
/***[ text ]****************************************************************/
/*
returns the parsed text for a block
*/
function text($bname) {
if (empty($bname))
$bname=$this->mainblock;
return $this->parsed_blocks[$bname];
}
/***[ out ]*****************************************************************/
/*
prints the parsed text
*/
function out ($bname) {
echo $this->text($bname);
}
/***[ reset ]***************************************************************/
/*
resets the parsed text
*/
function reset ($bname) {
$this->parsed_blocks[$bname]="";
}
/***[ parsed ]**************************************************************/
/*
returns true if block was parsed, false if not
*/
function parsed ($bname) {
return (!empty($this->parsed_blocks[$bname]));
}
/***[ SetNullString ]*******************************************************/
/*
sets the string to replace in case the var was not assigned
*/
function SetNullString($str,$varname="") {
$this->NULL_STRING[$varname]=$str;
}
/***[ SetNullBlock ]********************************************************/
/*
sets the string to replace in case the block was not parsed
*/
function SetNullBlock($str,$bname="") {
$this->NULL_BLOCK[$bname]=$str;
}
/***[ set_autoreset ]*******************************************************/
/*
sets AUTORESET to 1. (default is 1)
if set to 1, parse() automatically resets the parsed blocks' sub blocks
(for multiple level blocks)
*/
function set_autoreset() {
$this->AUTORESET=1;
}
/***[ clear_autoreset ]*****************************************************/
/*
sets AUTORESET to 0. (default is 1)
if set to 1, parse() automatically resets the parsed blocks' sub blocks
(for multiple level blocks)
*/
function clear_autoreset() {
$this->AUTORESET=0;
}
/***[ scan_globals ]********************************************************/
/*
scans global variables
*/
function scan_globals() {
reset($GLOBALS);
while (list($k,$v)=each($GLOBALS))
$GLOB[$k]=$v;
$this->assign("PHP",$GLOB); /* access global variables as {PHP.HTTP_HOST} in your template! */
}
/******
WARNING
PUBLIC FUNCTIONS BELOW THIS LINE DIDN'T GET TESTED
******/
/***************************************************************************/
/***[ private stuff ]*******************************************************/
/***************************************************************************/
/***[ maketree ]************************************************************/
/*
generates the array containing to-be-parsed stuff:
$blocks["main"],$blocks["main.table"],$blocks["main.table.row"], etc.
also builds the reverse parse order.
*/
function maketree($con,$block) {
$con2=explode($this->block_start_delim,$con);
$level=0;
$block_names=array();
$blocks=array();
reset($con2);
while(list($k,$v)=each($con2)) {
$patt="($this->block_start_word|$this->block_end_word)[[:blank:]]*([0-9a-zA-Z_]+)[[:blank:]]*$this->block_end_delim(.*)";
if (eregi($patt,$v,$res)) {
// $res[1] = BEGIN or END
// $res[2] = block name
// $res[3] = kinda content
if ($res[1]==$this->block_start_word) {
$parent_name=implode(".",$block_names);
$block_names[++$level]=$res[2]; /* add one level - array("main","table","row")*/
$cur_block_name=implode(".",$block_names); /* make block name (main.table.row) */
$this->block_parse_order[]=$cur_block_name; /* build block parsing order (reverse) */
$blocks[$cur_block_name].=$res[3]; /* add contents */
$blocks[$parent_name].="{_BLOCK_.$cur_block_name}"; /* add {_BLOCK_.blockname} string to parent block */
$this->sub_blocks[$parent_name][]=$cur_block_name; /* store sub block names for autoresetting and recursive parsing */
$this->sub_blocks[$cur_block_name][]=""; /* store sub block names for autoresetting */
} else if ($res[1]==$this->block_end_word) {
unset($block_names[$level--]);
$parent_name=implode(".",$block_names);
$blocks[$parent_name].=$res[3]; /* add rest of block to parent block */
}
} else { /* no block delimiters found */
$cur_block_name=implode(".",$block_names);
$blocks[$cur_block_name].=$this->block_start_delim.$v;
}
}
return $blocks;
}
/***[ error stuff ]*********************************************************/
/*
sets and gets error
*/
function get_error() {
return ($this->ERROR=="")?0:$this->ERROR;
}
function set_error($str) {
$this->ERROR=$str;
}
/***[ getfile ]*************************************************************/
/*
returns the contents of a file
*/
function getfile($file) {
if (empty($file)) {
$this->set_error("Empty file name!");
return "";
}
if (is_file($file)) {
if (!($fh=fopen($file,"r"))) {
$this->set_error("Cannot open file: $file");
return "";
}
$file_text=fread($fh,filesize($file));
fclose($fh);
} else {
$this->set_error("[$file] does not exist");
$file_text="<b>__XTemplate fatal error: file [$file] does not exist__</b>";
}
return $file_text;
}
/***[ r_getfile ]***********************************************************/
/*
recursively gets the content of a file with {FILE "filename.tpl"} directives
*/
function r_getfile($file) {
$text=$this->getfile($file);
while (preg_match($this->file_delim,$text,$res)) {
$text2=$this->getfile($res[1]);
$text=ereg_replace($res[0],$text2,$text);
}
return $text;
}
} /* end of XTemplate class. */
/****
TODO
-syntax checker function
-better error handling
-browser-dependent if-else stuff
*/
?>
|