extern/egroupware
1
0
Fork 1
mirror of https://github.com/EGroupware/egroupware.git synced 2025-01-14 09:58:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

Formatting

Browse Source
This commit is contained in:
Miles Lott 2001-07-27 10:40:23 +00:00
parent e3fbe2fd7a
commit f0bd45dd45
1 changed files with 425 additions and 364 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

205
phpgwapi/inc/class.Template.inc.php
View File

@ -14,11 +14,12 @@
/* $Id$ */ /* $Id$ */
class Template { class Template
var $classname = "Template"; {
var $classname = 'Template';
/* if set, echo assignments */ /* if set, echo assignments */
var $debug = false; var $debug = False;
/* $file[handle] = "filename"; */ /* $file[handle] = "filename"; */
var $file = array(); var $file = array();
@ -34,21 +35,21 @@ class Template {
* "comment" => replace undefined variables with comments * "comment" => replace undefined variables with comments
* "keep" => keep undefined variables * "keep" => keep undefined variables
*/ */
var $unknowns = "remove"; var $unknowns = 'remove';
/* "yes" => halt, "report" => report error, continue, "no" => ignore error quietly */ /* "yes" => halt, "report" => report error, continue, "no" => ignore error quietly */
var $halt_on_error = "yes"; var $halt_on_error = 'yes';
/* last error message is retained here */ /* last error message is retained here */
var $last_error = ""; var $last_error = '';
/***************************************************************************/ /***************************************************************************/
/* public: Constructor. /* public: Constructor.
* root: template directory. * root: template directory.
* unknowns: how to handle unknown variables. * unknowns: how to handle unknown variables.
*/ */
function Template($root = ".", $unknowns = "remove") { function Template($root = '.', $unknowns = 'remove')
{
$this->set_root($root); $this->set_root($root);
$this->set_unknowns($unknowns); $this->set_unknowns($unknowns);
} }
@ -56,12 +57,13 @@ class Template {
/* public: setroot(pathname $root) /* public: setroot(pathname $root)
* root: new template directory. * root: new template directory.
*/ */
function set_root($root) { function set_root($root)
if (!is_dir($root)) { {
if (!is_dir($root))
{
$this->halt("set_root: $root is not a directory."); $this->halt("set_root: $root is not a directory.");
return false; return false;
} }
$this->root = $root; $this->root = $root;
return true; return true;
} }
@ -70,7 +72,8 @@ class Template {
* unknowns: "remove", "comment", "keep" * unknowns: "remove", "comment", "keep"
* *
*/ */
function set_unknowns($unknowns = "keep") { function set_unknowns($unknowns = 'keep')
{
$this->unknowns = $unknowns; $this->unknowns = $unknowns;
} }
@ -81,16 +84,22 @@ class Template {
* handle: handle for a filename, * handle: handle for a filename,
* filename: name of template file * filename: name of template file
*/ */
function set_file($handle, $filename = "") { function set_file($handle, $filename = '')
if (!is_array($handle)) { {
if ($filename == "") { if (!is_array($handle))
{
if ($filename == '')
{
$this->halt("set_file: For handle $handle filename is empty."); $this->halt("set_file: For handle $handle filename is empty.");
return false; return false;
} }
$this->file[$handle] = $this->filename($filename); $this->file[$handle] = $this->filename($filename);
} else { }
else
{
reset($handle); reset($handle);
while(list($h, $f) = each($handle)) { while(list($h, $f) = each($handle))
{
$this->file[$h] = $this->filename($f); $this->file[$h] = $this->filename($f);
} }
} }
@ -100,18 +109,21 @@ class Template {
* extract the template $handle from $parent, * extract the template $handle from $parent,
* place variable {$name} instead. * place variable {$name} instead.
*/ */
function set_block($parent, $handle, $name = "") { function set_block($parent, $handle, $name = '')
if (!$this->loadfile($parent)) { {
if (!$this->loadfile($parent))
{
$this->halt("subst: unable to load $parent."); $this->halt("subst: unable to load $parent.");
return false; return false;
} }
if ($name == "") if ($name == '')
{
$name = $handle; $name = $handle;
}
$str = $this->get_var($parent); $str = $this->get_var($parent);
$reg = "/<!--\s+BEGIN $handle\s+-->(.*)\n\s*<!--\s+END $handle\s+-->/sm"; $reg = "/<!--\s+BEGIN $handle\s+-->(.*)\n\s*<!--\s+END $handle\s+-->/sm";
preg_match_all($reg, $str, $m); preg_match_all($reg, $str, $m);
$str = preg_replace($reg, "{" . "$name}", $str); $str = preg_replace($reg, '{' . "$name}", $str);
$this->set_var($handle, $m[1][0]); $this->set_var($handle, $m[1][0]);
$this->set_var($parent, $str); $this->set_var($parent, $str);
} }
@ -123,28 +135,45 @@ class Template {
* varname: name of a variable that is to be defined * varname: name of a variable that is to be defined
* value: value of that variable * value: value of that variable
*/ */
function set_var($varname, $value = "") { function set_var($varname, $value = '')
if (!is_array($varname)) { {
if (!is_array($varname))
{
if (!empty($varname)) if (!empty($varname))
if ($this->debug) print "scalar: set *$varname* to *$value*<br>\n"; {
if ($this->debug)
{
print "scalar: set *$varname* to *$value*<br>\n";
}
$this->varkeys[$varname] = $this->varname($varname); $this->varkeys[$varname] = $this->varname($varname);
$this->varvals[$varname] = $value; $this->varvals[$varname] = $value;
} else { }
}
else
{
reset($varname); reset($varname);
while(list($k, $v) = each($varname)) { while(list($k, $v) = each($varname))
{
if (!empty($k)) if (!empty($k))
if ($this->debug) print "array: set *$k* to *$v*<br>\n"; {
if ($this->debug)
{
print "array: set *$k* to *$v*<br>\n";
}
$this->varkeys[$k] = $this->varname($k); $this->varkeys[$k] = $this->varname($k);
$this->varvals[$k] = $v; $this->varvals[$k] = $v;
} }
} }
} }
}
/* public: subst(string $handle) /* public: subst(string $handle)
* handle: handle of template where variables are to be substituted. * handle: handle of template where variables are to be substituted.
*/ */
function subst($handle) { function subst($handle)
if (!$this->loadfile($handle)) { {
if (!$this->loadfile($handle))
{
$this->halt("subst: unable to load $handle."); $this->halt("subst: unable to load $handle.");
return false; return false;
} }
@ -161,9 +190,9 @@ class Template {
/* public: psubst(string $handle) /* public: psubst(string $handle)
* handle: handle of template where variables are to be substituted. * handle: handle of template where variables are to be substituted.
*/ */
function psubst($handle) { function psubst($handle)
{
print $this->subst($handle); print $this->subst($handle);
return false; return false;
} }
@ -173,37 +202,45 @@ class Template {
* handle: handle of template to substitute * handle: handle of template to substitute
* append: append to target handle * append: append to target handle
*/ */
function parse($target, $handle, $append = false) { function parse($target, $handle, $append = false)
if (!is_array($handle)) { {
if (!is_array($handle))
{
$str = $this->subst($handle); $str = $this->subst($handle);
if ($append) { if ($append)
{
$this->set_var($target, $this->get_var($target) . $str); $this->set_var($target, $this->get_var($target) . $str);
} else { }
else
{
$this->set_var($target, $str); $this->set_var($target, $str);
} }
} else { }
else
{
reset($handle); reset($handle);
while(list($i, $h) = each($handle)) { while(list($i, $h) = each($handle))
{
$str = $this->subst($h); $str = $this->subst($h);
$this->set_var($target, $str); $this->set_var($target, $str);
} }
} }
return $str; return $str;
} }
function pparse($target, $handle, $append = false) { function pparse($target, $handle, $append = false)
{
print $this->parse($target, $handle, $append); print $this->parse($target, $handle, $append);
return false; return false;
} }
// This is short for finish parse /* This is short for finish parse */
function fp($target, $handle, $append = False) function fp($target, $handle, $append = False)
{ {
return $this->finish($this->parse($target, $handle, $append)); return $this->finish($this->parse($target, $handle, $append));
} }
// This is a short cut for print finish parse /* This is a short cut for print finish parse */
function pfp($target, $handle, $append = False) function pfp($target, $handle, $append = False)
{ {
echo $this->finish($this->parse($target, $handle, $append)); echo $this->finish($this->parse($target, $handle, $append));
@ -211,12 +248,13 @@ class Template {
/* public: get_vars() /* public: get_vars()
*/ */
function get_vars() { function get_vars()
{
reset($this->varkeys); reset($this->varkeys);
while(list($k, $v) = each($this->varkeys)) { while(list($k, $v) = each($this->varkeys))
{
$result[$k] = $this->varvals[$k]; $result[$k] = $this->varvals[$k];
} }
return $result; return $result;
} }
@ -226,15 +264,19 @@ class Template {
* public: get_var(array varname) * public: get_var(array varname)
* varname: array of variable names * varname: array of variable names
*/ */
function get_var($varname) { function get_var($varname)
if (!is_array($varname)) { {
if (!is_array($varname))
{
return $this->varvals[$varname]; return $this->varvals[$varname];
} else { }
else
{
reset($varname); reset($varname);
while(list($k, $v) = each($varname)) { while(list($k, $v) = each($varname))
{
$result[$k] = $this->varvals[$k]; $result[$k] = $this->varvals[$k];
} }
return $result; return $result;
} }
} }
@ -242,8 +284,10 @@ class Template {
/* public: get_undefined($handle) /* public: get_undefined($handle)
* handle: handle of a template. * handle: handle of a template.
*/ */
function get_undefined($handle) { function get_undefined($handle)
if (!$this->loadfile($handle)) { {
if (!$this->loadfile($handle))
{
$this->halt("get_undefined: unable to load $handle."); $this->halt("get_undefined: unable to load $handle.");
return false; return false;
} }
@ -251,32 +295,41 @@ class Template {
preg_match_all("/\{([^}]+)\}/", $this->get_var($handle), $m); preg_match_all("/\{([^}]+)\}/", $this->get_var($handle), $m);
$m = $m[1]; $m = $m[1];
if (!is_array($m)) if (!is_array($m))
{
return false; return false;
}
reset($m); reset($m);
while(list($k, $v) = each($m)) { while(list($k, $v) = each($m))
{
if (!isset($this->varkeys[$v])) if (!isset($this->varkeys[$v]))
{
$result[$v] = $v; $result[$v] = $v;
} }
}
if (count($result)) if (count($result))
{
return $result; return $result;
}
else else
{
return false; return false;
} }
}
/* public: finish(string $str) /* public: finish(string $str)
* str: string to finish. * str: string to finish.
*/ */
function finish($str) { function finish($str)
switch ($this->unknowns) { {
switch ($this->unknowns)
{
case "keep": case "keep":
break; break;
case "remove": case "remove":
$str = preg_replace('/{[^ \t\r\n}]+}/', "", $str); $str = preg_replace('/{[^ \t\r\n}]+}/', "", $str);
break; break;
case "comment": case "comment":
$str = preg_replace('/{([^ \t\r\n}]+)}/', "<!-- Template $handle: Variable \\1 undefined -->", $str); $str = preg_replace('/{([^ \t\r\n}]+)}/', "<!-- Template $handle: Variable \\1 undefined -->", $str);
break; break;
@ -288,11 +341,13 @@ class Template {
/* public: p(string $varname) /* public: p(string $varname)
* varname: name of variable to print. * varname: name of variable to print.
*/ */
function p($varname) { function p($varname)
{
print $this->finish($this->get_var($varname)); print $this->finish($this->get_var($varname));
} }
function get($varname) { function get($varname)
{
return $this->finish($this->get_var($varname)); return $this->finish($this->get_var($varname));
} }
@ -300,13 +355,15 @@ class Template {
/* private: filename($filename) /* private: filename($filename)
* filename: name to be completed. * filename: name to be completed.
*/ */
function filename($filename,$root='',$time=1) { function filename($filename,$root='',$time=1)
{
global $phpgw_info; global $phpgw_info;
if($root=='') if($root=='')
{ {
$root=$this->root; $root=$this->root;
} }
if (substr($filename, 0, 1) != "/") { if (substr($filename, 0, 1) != '/')
{
$new_filename = $root.'/'.$filename; $new_filename = $root.'/'.$filename;
} }
else else
@ -326,38 +383,41 @@ class Template {
$new_filename = $this->filename(str_replace($root.'/','',$new_filename),$new_root,2); $new_filename = $this->filename(str_replace($root.'/','',$new_filename),$new_root,2);
} }
} }
return $new_filename; return $new_filename;
} }
/* private: varname($varname) /* private: varname($varname)
* varname: name of a replacement variable to be protected. * varname: name of a replacement variable to be protected.
*/ */
function varname($varname) { function varname($varname)
return "{".$varname."}"; {
return '{'.$varname.'}';
} }
/* private: loadfile(string $handle) /* private: loadfile(string $handle)
* handle: load file defined by handle, if it is not loaded yet. * handle: load file defined by handle, if it is not loaded yet.
*/ */
function loadfile($handle) { function loadfile($handle)
{
if (isset($this->varkeys[$handle]) and !empty($this->varvals[$handle])) if (isset($this->varkeys[$handle]) and !empty($this->varvals[$handle]))
{
return true; return true;
}
if (!isset($this->file[$handle])) { if (!isset($this->file[$handle]))
{
$this->halt("loadfile: $handle is not a valid handle."); $this->halt("loadfile: $handle is not a valid handle.");
return false; return false;
} }
$filename = $this->file[$handle]; $filename = $this->file[$handle];
$str = implode("", @file($filename)); $str = implode('', @file($filename));
if (empty($str)) { if (empty($str))
{
$this->halt("loadfile: While loading $handle, $filename does not exist or is empty."); $this->halt("loadfile: While loading $handle, $filename does not exist or is empty.");
return false; return false;
} }
$this->set_var($handle, $str); $this->set_var($handle, $str);
return true; return true;
} }
@ -387,7 +447,8 @@ class Template {
/* public, override: haltmsg($msg) /* public, override: haltmsg($msg)
* msg: error message to show. * msg: error message to show.
*/ */
function haltmsg($msg) { function haltmsg($msg)
{
printf("<b>Template Error:</b> %s<br>\n", $msg); printf("<b>Template Error:</b> %s<br>\n", $msg);
} }
} }