PHPOOT is a template engine for PHP. With this, you can separate HTML from programming code, and presentation stracture from presentation logic.
I have got the concept of this engine thanks to Amrita template library that is for Ruby.
Presentation is the part where your application presents information for your user. Here I classify the Presentation into three part, which are 'stracture', 'design' and 'logic'. HTML has charge of presentation stracture, CSS does of design, and PHP itself should take charge of logic. So I claim that PHPOOT should not have complicated control stracuture like 'if ... then ...'.
And the separation make it possible for designers and programmer to work on their own file. But the three part depends on each other, so plenty of communication between them is necessary.
the GNU Lesser General Public License version 2.1, or any later version.
PHPOOT has sourceforge.jp project page. Download latest PHPOOT from there.
I show you quick start guide to use PHPOOT version 0.4 or later.
This is a simple template file, that is written with HTML.
<html>
<body>
<h1 var="{title}">title will be inserted here</h1>
<p var="{body}">body text will be inserted here</p>
</body>
</html>
PHPOOT treats elements with "var" attribute as variable and gets the data for them from model data by the value of "var" attribute as key. The variable name of model data that is described in "var" attribute have to be enclosed with brace like {foo}.
PHP code to use the template is below.
require_once 'phpoot.php';
$tmpl = new phpoot;
$tmpl->setTemplateFile('./helloworld.html');
$model_data = array(
'title' => 'Hello World',
'body' => 'PHPOOT is a template engine for PHP'
);
$tmpl->display($model_data);
The output of this code is ...
<html>
<body>
<h1>Hello World;/h1>
<p>PHPOOT is a template engine for PHP</p>
</body>
</html>
<h1 var="title">...</h1>
was replaced with
<h1>$model_data['title']</h1>.
And <p var="body">...</p> was modified in the same way.
template
<ul>
<li var="{list1}"></li>
</ul>
code
require_once 'phpoot.php';
$tmpl = new phpoot;
$tmpl->setTemplateFile('./list.html');
$model_data = array(
'list1' => array(1, 2, 3)
);
$tmpl->display($model_data);
When the element of data model to use is array, PHPOOT display them one by one.
PHP do not distinguish array and hash, but normaly array(0 => 'foo', 1 => 'bar') is called array and array('a' => 'foo', 'b' => 'bar') is called hash. So PHPOOT look on PHP array with key 0 as array.
output
<ul> <li>1</li> <li>2</li> <li>3</li> </ul>
template
<table border="1">
<tr><th>name</th><th>author</th></tr>
<tr var="{table1}">
<td var="{name}"></td><td var="{author}"></td>
</tr>
</table>
code
require_once 'phpoot.php';
$tmpl = new phpoot;
$tmpl->setTemplateFile('./table.html');
$model_data = array(
'table1' => array(
array( 'name' => 'PHP', 'author' => 'Rasmus Lerdorf' ),
array( 'name' => 'Ruby', 'author' => 'matz' ),
array( 'name' => 'python', 'author' => 'Guido van Rossum' )
)
);
$tmpl->display($model_data);
PHPOOT accepts nestd hash.
output
<table border="1">
<tr><th>name</th><th>author</th></tr>
<tr>
<td>PHP</td><td>Rasmus Lerdorf</td>
</tr>
<tr>
<td>Ruby</td><td>matz</td>
</tr>
<tr>
<td>python</td><td>Guido van Rossum</td>
</tr>
</table>
If a element of model data is null or false, the tag with the element, its content and its close tag will be deleted. Using this, you can select the part of template to be displayed.
If true was given as model data for some element, the content of the tag will be displayed un-modified.
template
<html>
<body>
<div var="{groups}">
<h1 var="{title}"></h1>
<div var="{no_data}">
<em>This group has no data.</em>
</div>
<div var="{one_data}">
This group has only one data: "<span var="{data}"></span>".
</div>
<div var="{many_data}">
Here's the list of this group's data.
<ul>
<li var="{list}"></li>
</ul>
</div>
</div>
</body>
</html>
code
require_once 'phpoot.php';
$tmpl = new phpoot;
$tmpl->setTemplateFile('./conditional.html');
$data = array(
array('Group A', array('only_one')),
array('Group B', array('one', 'two', 'three')),
array('Group C', array())
);
$model_data = array();
foreach ($data as $datum) {
$model_datum = array();
$model_datum['title'] = $datum[0];
switch(count($datum[1])){
case 0:
$model_datum['no_data'] = true;
break;
case 1:
$model_datum['one_data'] = array(
'data' => $datum[1][0]
);
break;
default:
$model_datum['many_data'] = array(
'list' => $datum[1]
);
}
$model_data[] = $model_datum;
}
$tmpl->display(array('groups' => $model_data));
output
<html>
<body>
<div>
<h1>Group A</h1>
<div>
This group has only one data: "only_one".
</div>
</div>
<div>
<h1>Group B</h1>
<div>
Here's the list of this group's data.
<ul>
<li>one</li>
<li>two</li>
<li>three</li>
</ul>
</div>
</div>
<div>
<h1>Group C</h1>
<div>
<em>This group has no data.</em>
</div>
</div>
</body>
</html>
Use {data} style value to embed data in HTML attribute.
template
<table border="1">
<tr><th>name</th><th>webpage</tr>
<tr var="{table}">
<td var="{name}"></td>
<td><a href="{url}" var="{webpage}"></a></td>
</tr>
</table>
code
require_once 'phpoot.php';
$tmpl = new phpoot;
$tmpl->setTemplateFile('./attribute.html');
$model_data = array(
'table' => array(
array(
'name' => 'PHP',
'url' => 'http://www.php.net/',
'webpage' => 'PHP: Hypertext Preprocessor'
),
array(
'name' => 'Ruby',
'url' => 'http://www.ruby-lang.org/',
'webpage' => 'Ruby Home Page'
),
array(
'name' => 'python',
'url' => 'http://www.python.org/',
'webpage' => 'Python Language Website'
)
)
);
$tmpl->display($model_data);
output
<table border="1">
<tr><th>name</th><th>webpage</th></tr>
<tr>
<td>PHP</td>
<td><a href="http://www.php.net/">PHP: Hypertext Preprocessor</a></td>
</tr>
<tr>
<td>Ruby</td>
<td><a href="http://www.ruby-lang.org/">Ruby Home Page</a></td>
</tr>
<tr>
<td>python</td>
<td><a href="http://www.python.org/">Python Language Website</a></td>
</tr>
</table>
Note: Order of embeded attribute against var one is important.
see "sample" directory in release of PHPOOT library.
The sample of this guide is based on the guide of Amrita template library.
Revision: $Revision: 1.3 $
phpoot.0.4.1/phpoot.compiler.php 0100700 0001753 0001001 00000007536 10021615326 016177 0 ustar haruki なし
* @copyright Copyright © 2003-2004, Haruki SETOYAMA body text will be inserted here body text will be inserted here body html will be inserted here - body text will be inserted here
* 'escape''remove' when true, remove all the
* 'pi''remove' when true, remove all the
* 'jasp''remove' when true, remove all the <% ... %>
* 'tag''empty' names of empty tag which should be < /> style
* 'tag''raw' extention of model data with HTML.
* 'tag''allow_no_brace' variable name is normaly "{foo}" style. when true, allow just "foo"
*
* @var array
*/
var $option = array(
'tag' => array(
'empty' => array(
'br' => 1,
'param' => 1,
'hr' => 1,
'input' => 1,
'col' => 1,
'img' => 1,
'area' => 1,
'frame' => 1,
'meta' => 1,
'link' => 1,
'base' => 1,
'basefont' => 1,
'isindex' => 1
),
'raw' => array(
'_raw',
'_html'
),
'allow_no_brace' => false
),
'data' => array(),
'escape' => array(
'remove' => false
),
'pi' => array(
'remove' => true
),
'jasp' => array(
'remove' => true
)
);
/**
* template text
* @var string
* @access private
*/
var $_template = '';
/**
* blanck phpoot_parser_tag object
* @var array of phpoot_parser_tag
* @access private
*/
var $_tag_parsers = array();
/**
* @access private
*/
var $_level = 0;
/**
* @access private
*/
var $_stack = array();
/**
* constructor
* @access public
*/
function phpoot_handler($parsers = array('num', 'variable'))
{
$this->_tag_parsers = array();
foreach ($parsers as $parser) {
$class = 'phpoot_parser_tag_' . $parser;
$this->_tag_parsers[] = new $class($this->option['tag']);
}
$this->_tag_parsers[] = new phpoot_parser_tag_static($this->option['tag']);
}
/**
* set option by array
* @access public
*/
function setOption($option)
{
$this->option = array_merge($this->option, $option);
}
/**
* initialize before HTMLSax parse
* @access public
*/
function init(&$template)
{
$this->_level = 0;
$this->_error = array();
$template = str_replace(array("\r\n", "\r"), array("\n", "\n"), $template);
$this->_template =& $template;
$this->_stack = array();
$this->_stack[0] = new phpoot_parser_root;
}
/**
* set handler on HTMLSax parser
* @access public
*/
function configParser(&$parser)
{
$parser->set_element_handler('openHandler', 'closeHandler');
$parser->set_data_handler('dataHandler');
$parser->set_escape_handler('escapeHandler');
$parser->set_pi_handler('piHandler');
$parser->set_jasp_handler('jaspHandler');
$parser->set_option('XML_OPTION_FULL_ESCAPES');
}
/**
* get parsed template, that is PHP script
* @access public
*/
function getParsed()
{
while($this->_level > 0) {
$this->_stack[$this->_level]->close(strlen($this->_template));
$this->_level--;
}
return $this->_stack[$this->_level]->parse();
}
/**
* handler method for tag open
* @access public
*/
function openHandler(&$parser, $name, $attrs)
{
$name = strtolower($name);
$attrs = array_change_key_case($attrs, CASE_LOWER);
$this->open_position = $parser->get_current_position();
$i=0;
while($this->_tag_parsers[$i]->accept($name, $attrs) === false){
$i++;
}
$this->_level++;
unset($this->_stack[$this->_level]);
$this->_stack[$this->_level] = $this->_tag_parsers[$i]; // copy
$this->_stack[$this->_level]->open(
$parser->get_current_position()
, $name
, $attrs
, $this->_stack[$this->_level -1]->info
);
$this->_stack[$this->_level -1]->data[] =& $this->_stack[$this->_level];
}
/**
* handler method for tag close
* @access public
*/
function closeHandler(&$parser, $close_tag)
{
$close_tag = strtolower($close_tag);
$this->_stack[$this->_level]->close($parser->get_current_position());
if ($this->_level > 0) {
$this->_level--;
if ($this->_stack[$this->_level +1]->open_tag() != $close_tag) {
$this->closeHandler($parser, $close_tag);
}
}
}
/**
* handler method for data
* @access public
*/
function dataHandler(&$parser, $data)
{
$this->_stack[$this->_level]->data[]
= new phpoot_parser_data($data, $this->option['data']);
}
/**
* handler method for escape
* @access public
*/
function escapeHandler(&$parser, $data)
{
$this->_stack[$this->_level]->data[]
= new phpoot_parser_escape($data, $this->option['escape']);
}
/**
* handler method for pi
* @access public
*/
function piHandler(&$parser, $target, $data)
{
$this->_stack[$this->_level]->data[]
= new phpoot_parser_pi($target, $data, $this->option['pi']);
}
/**
* handler method for jasp
* @access public
*/
function jaspHandler(&$parser, $data)
{
$this->_stack[$this->_level]->data[]
= new phpoot_parser_jasp($data, $this->option['jasp']);
}
}
/**
* base class of template parser classes
* This class and its sub classes are accessed only by phpoot_handler class
* This class is also used as null object.
* @see phpoot_handler
* @package phpoot
* @subpackage _parser
*/
class phpoot_parser {
/**
* indent string at the beginning
* @var string
*/
var $indent = '';
/**
* line feed at the end
* @var string
*/
var $linefeed = '';
/**
* @access private
*/
var $_data = '';
/**
* parse into PHP script
* @return string
*/
function parse()
{
return '';
}
/**
* returns if this content needs indent and linefeed
* @return string
*/
function need_indent()
{
return false;
}
/**
* returns indent for next contents
* @return string
*/
function indent_for_next()
{
return '';
}
/**
* returns linefeed "\n" for previous contents
* @return string
*/
function linefeed_for_prev()
{
return '';
}
/**
* returns if this content is empty ''
* @return string
*/
function is_empty()
{
return false;
}
/**
* returns if this class can have alternative content(s)
* @return string
*/
function is_alternative()
{
return false;
}
}
/**
* parser for data
* @package phpoot
*/
class phpoot_parser_data extends phpoot_parser {
function phpoot_parser_data($data, $option) {
$this->_data = $data;
}
function parse() {
return $this->_data;
}
function indent_for_next() {
if (preg_match('/^(.*\n)([\040\011]*)$/sD', $this->_data, $match)) {
$this->_data = $match[1];
return $match[2];
} else {
return '';
}
}
function linefeed_for_prev() {
if (substr($this->_data, 0, 1) == "\n") {
$this->_data = substr($this->_data, 1);
return "\n";
} else {
return '';
}
}
function is_empty() {
return ($this->_data == '');
}
}
/**
* parser for escape
* @package phpoot
*/
class phpoot_parser_escape extends phpoot_parser {
/**
* @access private
*/
var $_remove = false;
function phpoot_parser_escape($data, $option) {
$this->_data = $data;
$this->_remove = (bool)$option['remove'];
}
function parse() {
if (! $this->_remove) {
return '_data . '>';
} else {
return
"\n"
. $this->indent
. ''
. $this->linefeed
. "\n";;
}
}
function need_indent() {
return $this->_remove;
}
}
/**
* parser for pi
* @package phpoot
*/
class phpoot_parser_pi extends phpoot_parser {
/**
* @access private
*/
var $_remove = false;
/**
* @access private
*/
var $_target;
function phpoot_parser_pi($target, $data, $option) {
$this->_target = $target;
$this->_data = $data;
$this->_remove = (bool)$option['remove'];
}
function parse() {
if (! $this->_remove) {
return '_target . ' ' . $this->_data . '?>';
} else {
return
"\n"
. $this->indent
. ''
. $this->linefeed
. "\n";
}
}
function need_indent() {
return $this->_remove;
}
}
/**
* parser for jasp
* @package phpoot
*/
class phpoot_parser_jasp extends phpoot_parser {
/**
* @access private
*/
var $_remove = false;
function phpoot_parser_jasp($data, $option) {
$this->_data = $data;
$this->_remove = (bool)$option['remove'];
}
function parse() {
if (! $this->_remove) {
return '<%' . $this->_data . '%>';
} else {
return
"\n"
. $this->indent
. ''
. $this->linefeed
. "\n";
}
}
function need_indent() {
return $this->_remove;
}
}
/**
* Base of parser for tag
* @package phpoot
* @abstract
*/
class phpoot_parser_tag extends phpoot_parser {
/**
* data in the tag
* @var phpoot_parser
*/
var $data = '';
/**
* information about variable tag
* @var array
*/
var $info;
/**
* name of open tag
* @access private
*/
var $_open_tag;
/**
* attribute in the open tag
* @var array
* @access private
*/
var $_attrs;
/**
* options
* @var array
* @access private
*/
var $_option;
/**
* if this tag can have data or not
* @var bool
* @access private
*/
var $_empty_tag = false;
/**
* position when tag is opend
* @access private
*/
var $_position;
/**
* tags that will be deleted when no attribute
* @var array
*/
var $_delete = array('span' => 1);
function phpoot_parser_tag($option)
{
$this->_option = $option;
}
/**
* judge if this class accept the tag
* @abstract
* @access public
* @return bool
*/
function accept($open_tag, $attrs)
{
return false;
}
/**
* initialize when the tag is opened
* @abstract
*/
function open($position, $name, $attrs, &$info) {}
/**
* initialize
* @access private
*/
function _open($position, $name, $attrs) {
$this->_position = $position;
$this->_open_tag = $name;
$this->_attrs = $attrs;
if (isset($option['empty'][$name])) {
$this->_empty_tag = true;
}
$this->_init();
}
/**
* initialize data stack
* @access private
*/
function _init() {
$this->data = array();
$this->data[] = new phpoot_parser;
}
/**
* parse all the data in $this->data stack and add the results on $this->_data
* @access public
*/
function close($position) {
if ($this->_position == $position) {
$this->_empty_tag = true;
}
$this->data[] = new phpoot_parser;
$num = count($this->data) -1;
// get indent and linefeed for pritty print
for ($i = $num-1; $i > 0; $i--) {
if ($this->data[$i]->need_indent()) {
$this->data[$i]->indent = $this->data[$i -1]->indent_for_next();
$this->data[$i]->linefeed = $this->data[$i +1]->linefeed_for_prev();
}
}
// altarnative & parse
for ($i=1; $i < $num; $i++) {
if ($this->data[$i]->is_alternative() == true
&& $this->data[$i+1]->is_empty()) {
$alts = $this->_get_alternative($i, $num, $this->data[$i]);
if ($alts > 0) {
$this->_data .= $this->_parse_alternative($i, $alts);
$i += $alts*2;
continue;
}
}
$this->_data .= $this->data[$i]->parse();
}
$this->_init();
}
/**
* get alternative tags
* @access private
* @return int number of the alternatives
*/
function _get_alternative($i, $num, &$phpoot_parser) {
$open_tag = $phpoot_parser->open_tag();
$variable = $phpoot_parser->info['name'];
$alts = 0;
$i += 2;
while($i < $num){
if ($this->data[$i]->is_alternative() == true
&& $this->data[$i]->open_tag() == $open_tag
&& $this->data[$i]->info['name'] == $variable) {
$alts += 1;
if (! $this->data[$i+1]->is_empty()) {
return $alts;
}
$i += 2;
} else {
return $alts;
}
} // while
return $alts;
}
/**
* parse the tag with alternative
* @access private
* @return string
*/
function _parse_alternative($i, $alts)
{
$alts += 1;
$level = $this->data[$i]->info['level'];
$_var = $this->data[$i]->info['name'];
$_each = '$_each' . $level;
$_valprev = '$_val' . ($level -1);
$_valcurr = '$_val' . $level;
$_num = '$_num' . $level;
$parsed
= 'data[$i+$j*2]->parse_in_loop()
. "continue; } ";
}
$parsed
.= "} ?>\n";
return $parsed;
}
/**
* returns name of open tag
* @return string
*/
function open_tag()
{
return $this->_open_tag;
}
/**
* parse tag and set $this->_parsed_close_tag and $this->_parsed_open_tag
* @access private
*/
function _parse_tag()
{
// open tag
$open_tag = '<' . $this->_open_tag;
$attr_variables = array();
$attr_statics = 0;
$_val = '$_val' . ($this->info['level'] -1);
foreach ($this->_attrs as $key => $value) {
if ($key == PHPOOT_VAR && !is_string($value)) {
$_val = '$_val' . $this->info['level'];
continue;
}
if (preg_match('/^\{([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)\}$/D', $value, $match)) {
// variable attribute, bar="{foo}" style
$_varibale = $match[1];
$open_tag .= "\n";
$attr_variables[] = "phpoot_attr('$key', $_val, '$_varibale')";
}
else {
// static attribute
$open_tag .= ' ' . $key . '=' . $this->_double_quote_html($value);
$attr_statics++;
}
}
if ($this->_empty_tag == true) {
$open_tag .= ' />';
} else {
$open_tag .= '>';
}
// close tag
$close_tag = $this->_indent_close_tag();
if ($this->_empty_tag == true) {
$close_tag = '';
} else {
$close_tag .= '_open_tag . '>';
}
// deletable tag?
if ($attr_statics == 0 && isset($this->_delete[$this->_open_tag])) {
if (empty($attr_variables)) {
$open_tag = '';
$close_tag = '';
} else {
$_condition = implode(" != '' || ", $attr_variables) . " != ''";
$open_tag = "\n" . $open_tag . "\n";
if ($close_tag != '') {
$close_tag = "\n" . $close_tag . "\n";
}
}
}
return array($this->indent . $open_tag, $close_tag . $this->linefeed);
}
/**
* get indent for close tag
* @access private
* @return string
*/
function _indent_close_tag() {
// for static tag
return '';
}
/**
* double quote for html attribute
* @access private
* @return string
*/
function _double_quote_html($str)
{
return '"' . str_replace(array('"', '<', '>'), array('"', '<', '>'), $str) . '"';
}
}
/**
* Parser for root level of the stack
*
* @package phpoot
*/
class phpoot_parser_root extends phpoot_parser_tag {
var $info = array('level' => 0, 'nests' => false);
function phpoot_parser_root() {
$this->_init();
}
function close($position)
{
// todo: error
return;
}
function parse()
{
parent::close(0);
return $this->_data;
}
}
/**
* Parser for tags without variable attribute
*
* @package phpoot
*/
class phpoot_parser_tag_static extends phpoot_parser_tag {
function accept($open_tag, $attrs)
{
return true;
}
function open($position, $name, $attrs, &$info)
{
$this->_open($position, $name, $attrs);
$this->info =& $info;
}
function parse()
{
list($opentag, $closetag) = $this->_parse_tag();
return $opentag . $this->_data . $closetag;
}
}
/**
* Parser for variable tag
* variable tag means the one with var attribute.
*
* @package phpoot
*/
class phpoot_parser_tag_variable extends phpoot_parser_tag {
function accept($open_tag, $attrs)
{
if (! isset($attrs[PHPOOT_VAR])) {
return false;
}
if (preg_match('/^\{[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*\}$/D', $attrs[PHPOOT_VAR])) {
return true;
}
if ($this->_option['allow_no_brace'] == true
&& preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/D', $attrs[PHPOOT_VAR])) {
return true;
}
return false;
}
function open($position, $name, $attrs, &$info)
{
$this->info['level'] = (int)$info['level'] +1;
$this->info['nests'] = false;
$info['nests'] = true;
if (preg_match('/^\{([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)\}$/D', $attrs[PHPOOT_VAR], $match)) {
$this->info['name'] = $match[1];
} else {
$this->info['name'] = $attrs[PHPOOT_VAR];
}
$this->_open($position, $name, $attrs);
$this->_attrs[PHPOOT_VAR] = true;
}
function parse()
{
$_var = $this->info['name'];
$_each = '$_each' . $this->info['level'];
$_valprev = '$_val' . ($this->info['level'] -1);
$_valcurr = '$_val' . $this->info['level'];
$_num = '$_num' . $this->info['level'];
$parsed
= 'parse_in_loop()
. "} ?>\n";
return $parsed;
}
function parse_in_loop() {
list($open_tag, $close_tag) = $this->_parse_tag();
$_var = $this->info['name'];
$_each = '$_each' . $this->info['level'];
$_valcurr = '$_val' . $this->info['level'];
$_num = '$_num' . $this->info['level'];
$parsed
= "if ($_valcurr === null || $_valcurr === false) { "
. "if (\$_error) { ?>\n"
. $this->indent
. ""
. $this->linefeed
. "info['nests']) {
$parsed
.= "?>\n"
. $open_tag;
$_func = 'phpoot_string';
foreach ($this->_option['raw'] as $ext) {
if (substr($_var, -strlen($ext)) == $ext) {
$_func = 'phpoot_raw';
}
}
$parsed
.= "\n"
. $this->_data
. "\n"
. $close_tag;
} else {
$parsed
.= "phpoot_to_array($_valcurr, '$_var'); ?>\n"
. $open_tag
. $this->_data
. $close_tag;
}
$parsed
.= '_data, $match)
&& substr($match[1], -3) != ' ?>') {
$this->_data = $match[1];
return $match[2];
} else {
return '';
}
}
function need_indent()
{
return true;
}
function is_alternative()
{
return true;
}
}
/**
* Parser for tags with '#num' id attribute
*
* @package phpoot
*/
class phpoot_parser_tag_num extends phpoot_parser_tag_static {
function accept($open_tag, $attrs)
{
if (@$attrs[PHPOOT_VAR] == '{#num}') {
return true;
}
if ($this->_option['allow_no_brace'] == true
&& @$attrs[PHPOOT_VAR] == '#num') {
return true;
}
return false;
}
function open($position, $name, $attrs, &$info)
{
parent::open($position, $name, $attrs, $info);
unset($this->_attrs[PHPOOT_VAR]);
}
function parse()
{
list($open_tag, $close_tag) = $this->_parse_tag();
$_num = '$_num' . $this->info['level'];
return $open_tag . "\n" . $close_tag;
}
}
?> phpoot.0.4.1/phpoot.php 0100700 0001753 0001001 00000031517 10027550475 014373 0 ustar haruki なし
* @copyright Copyright © 2003-2004, Haruki SETOYAMA
* Key Meaning
* 'force_compile' when true, template will be compiled everytime
* 'check_timestamp' when true, modified time of template will be checked
* 'debug' ehwn true, display debug information in escape form
* 'pear_error' when false, false is returned insted of pearError
* 'mkdir_mode' mode for mkdir()
*
* @var array
*/
var $option = array(
'force_compile' => false,
'check_timestamp' => true,
'debug' => false,
'pear_error' => true,
'mkdir_mode' => 0777
);
/**
* path to directory where compiled files will be stored
* @var string
* @access private
*/
var $_compiled_dir;
/**
* @access private
*/
var $_compiled_dir_use = false;
/**
* path to template file
* @var string
* @access private
*/
var $_template_file;
/**
* XML_HTMLSax parser object
* @access private
*/
var $_parser;
/**
* handler object for XML_HTMLSax parser
* @access private
*/
var $_handler;
/**
* set a path for directory where compiled files will be stored
*
* @param stirng $dirname
* @return void
*/
function setCompileDir($dirname)
{
if ($dirname === null || $dirname === false) {
$this->_compiled_dir_use = false;
} else {
$this->_compiled_dir = $dirname;
$this->_compiled_dir_use = true;
}
}
/**
* set a path for template file
*
* @param stirng $template
* @return void
*/
function setTemplateFile($template)
{
$this->_template_file = $template;
if (! $this->_compiled_dir_use) {
$this->_compiled_dir = dirname($template);
}
}
/**
* set option
* for option for phpoot_handler, see phpoot_handler class in phpoot.parser.php
* @param stirng $key key of option
* @param mixed $val value of option
* @return void
*/
function setOption($key, $val)
{
$this->option[$key] = $val;
}
/**
* displays the template results
*
* @param array $data model data
* @return bool|PEARError
*/
function display($data)
{
$compiled_file = $this->_compiled_dir . '/' . basename($this->_template_file) . PHPOOT_EXT;
if ($this->option['force_compile'] != false
|| file_exists($compiled_file) != true) {
$err = $this->_compile($compiled_file);
if ($err !== true) {
return $this->raiseError($err);
}
}
elseif ($this->option['check_timestamp'] != false
&& $this->_template_readable() == true
&& $this->_template_update_time() > filemtime($compiled_file)) {
$err = $this->_compile($compiled_file);
if ($err !== true) {
return $this->raiseError($err);
}
}
if (! phpoot_display_compiled($compiled_file, $data, $this->option['debug'])) {
return $this->raiseError("Error(s) in compiled file '$compiled_file' or in template file '$this->_template_file'. ");
}
return true;
}
/**
* gets the template results
*
* @param sting $output variable for output
* @param array $data model data
* @return bool|PEARError
*/
function expand(&$output, $data)
{
ob_start();
$ret = $this->display($data);
$output = ob_get_contents();
ob_end_clean();
return $ret;
}
/**
* compiles template
*
* @access public
* @return bool|PEARError
*/
function compile()
{
$compiled_file = $this->_compiled_dir . '/' . basename($this->_template_file) . PHPOOT_EXT;
$err = $this->_compile($compiled_file);
if ($err !== true) {
return $this->raiseError($err);
}
return true;
}
/**
* compile template file
*
* @param stirng $compiled_file
* @access private
* @return bool
*/
function _compile($compiled_file)
{
if (! $this->_template_readable()) {
return "Template file '$this->_template_file' does not exists or is not readable. ";
}
if (! file_exists($compiled_file)) {
$dir = dirname($compiled_file);
if (! $this->_mkdirs($dir)) {
return "Fail to create the directory '$dir' for compiled files.";
}
if (! is_writable($dir)) {
return "Directory '$dir' is not writable for compiled file.";
}
} else {
if (! is_writable($compiled_file)) {
return "File '$compiled_file' for compiled template file is not rewritable.";
}
}
$template = $this->_get_template();
if (! $template) return "Fail to get template file '$this->_template_file'. ";
$parsed = $this->_parse($template);
$parsed = "\n" . $parsed . "\n"; // _parser) || !isset($this->_handler)) {
include_once PHPOOT_DIR . '/phpoot.parser.php';
$this->_parser = &new XML_HTMLSax();
$this->_handler = new phpoot_handler;
$this->_handler->setOption($this->option);
$this->_parser->set_object($this->_handler);
$this->_handler->configParser($this->_parser);
}
$this->_handler->init($template);
$this->_parser->parse($template);
if (! empty($this->_handler->error)) {
$this->raiseError("Template has some error. ");
}
return $this->_handler->getParsed();
}
/**
* make directory
*
* @param stirng $path
* @access private
* @return bool
*/
function _mkdirs($path)
{
if (strlen($path) == 0) return false;
if (is_dir($path)) return true;
if (is_file($path)) return false;
if (! $this->_mkdirs(dirname($path))) return false;
return mkdir($path, $this->option['mkdir_mode']);
}
/**
* get update time of the template file
*
* @access private
* @return int
*/
function _template_update_time()
{
return filemtime($this->_template_file);
}
/**
* check whether the template file is readable
*
* @access private
* @return bool
*/
function _template_readable()
{
return is_readable($this->_template_file);
}
/**
* get text of the template file
*
* @access private
* @return string|false
*/
function _get_template()
{
$fd = fopen($this->_template_file, 'rb');
if (! $fd) {
$this->raiseError("Fail to open the template file '$this->_template_file'.");
return false;
}
$contents = fread ($fd, filesize($this->_template_file));
fclose ($fd);
return $contents;
}
/**
* if $this->option['pear_error'] is true, false is returned by raiseError()
*
* @access private
* @return false|PEARError
*/
function raiseError($msg)
{
if ($this->option['pear_error']) {
return parent::raiseError('PHPOOT Error: '.htmlspecialchars($msg));
} else {
parent::raiseError('PHPOOT Error: '.htmlspecialchars($msg));
return false;
}
}
}
/**
* displays the template results with compiled template
*
* @param stirng $compiled_file path of compiled template file
* @param array $_val0 model data
* @param bool $_error if this displayes error or not
* @access private
* @return bool
*/
function phpoot_display_compiled($compiled_file, $_val0, $_error =false)
{
$_check = false; // flag for parse error check
$_no_error = true;
include $compiled_file;
return ($_check && $_no_error);
}
// functions below used in compiled template file.
/**
* get array of data for nested variabe tag
*
* @return array
* @access private
*/
function phpoot_each($val, $var)
{
$target = phpoot_val($val, $var);
if (is_array($target) && isset($target[0])) {
return $target;
}
return array($target);
}
/**
* make scalar data to array
* @access private
*/
function phpoot_to_array(&$scalar, $var)
{
if (is_scalar($scalar)) {
$arr[$var] = $scalar;
$scalar = $arr;
}
}
/**
* returns string data for display
* @return string
* @access private
*/
function phpoot_string($val, $var, $error)
{
if (is_string($val) || is_numeric($val)) {
echo phpoot_htmlspecialchars($val);
}
elseif (is_array($val) && is_string($val[$var])) {
echo phpoot_htmlspecialchars($val[$var]);
}
else {
echo ($error) ? "" : '';
}
}
/**
* htmlspecialchars() for phpoot
* @return string
* @access private
*/
function phpoot_htmlspecialchars($val)
{
return str_replace(' ', ' ', htmlspecialchars($val));
}
/**
* returns string data for display
* @return string
* @access private
*/
function phpoot_raw($val, $var, $error)
{
if (is_string($val) || is_numeric($val)) {
echo $val;
}
elseif (is_array($val) && is_string($val[$var])) {
echo $val[$var];
}
else {
echo ($error) ? "" : '';
}
}
/**
* makes string from data for attribute
* @return string
* @access private
*/
function phpoot_attr($attr, $val, $var)
{
$target = phpoot_val($val, $var);
if ($target === null || $target === false) {
return '';
} elseif ($target === true) {
return " $attr=\"$attr\"";
} elseif (is_string($target) || is_numeric($target)) {
return ' ' . $attr . '="' . phpoot_htmlspecialchars($target) . '"';
} else {
return '';
}
}
/**
* get value from $val with variable name
* @return mixed
* @access private
*/
function phpoot_val($val, $var)
{
if (is_object($val)) {
if (is_callable(array($val, $var))) {
return $val->$var();
} else {
return $val->$var;
}
} elseif (is_array($val) && isset($val[$var])) {
return $val[$var];
} else {
return false;
}
}
?> phpoot.0.4.1/sample/ 0040700 0001753 0001001 00000000000 10027550615 013617 5 ustar haruki なし phpoot.0.4.1/sample/attribute.html 0100700 0001753 0001001 00000000251 10021613720 016475 0 ustar haruki なし
phpoot.0.4.1/sample/attribute.php 0100700 0001753 0001001 00000001053 10017365022 016325 0 ustar haruki なし setTemplateFile('./attribute.html');
$model_data = array(
'table' => array(
array(
'name' => 'PHP',
'url' => 'http://www.php.net/',
'webpage' => 'PHP: Hypertext Preprocessor'
),
array(
'name' => 'Ruby',
'url' => 'http://www.ruby-lang.org/',
'webpage' => 'Ruby Home Page'
),
array(
'name' => 'python',
'url' => 'http://www.python.org/',
'webpage' => 'Python Language Website'
)
)
);
$tmpl->display($model_data);
?> phpoot.0.4.1/sample/compile.php 0100700 0001753 0001001 00000000412 10017355322 015752 0 ustar haruki なし setErrorHandling(PEAR_ERROR_PRINT);
$compiler->setTemplateDir('.');
$compiled = $compiler->compileAll('html');
foreach ($compiled as $file) {
echo $file.'name webpage
';
}
?> phpoot.0.4.1/sample/conditional.html 0100700 0001753 0001001 00000000670 10021613735 017010 0 ustar haruki なし
Test for select box
phpoot.0.4.1/sample/form1.php 0100700 0001753 0001001 00000000711 10025527405 015352 0 ustar haruki なし setErrorHandling(PEAR_ERROR_PRINT);
$tmpl->setTemplateFile('./form1.html');
$model_data = array(
'lang' => array(
array(
'name' => 'english',
'iso' => 'en'
),
array(
'name' => 'japanese',
'iso' => 'ja',
'selected' => true
),
array(
'name' => 'french',
'iso' => 'fr'
)
)
);
$tmpl->display($model_data);
?> phpoot.0.4.1/sample/helloworld.expand.php 0100700 0001753 0001001 00000000577 10021621174 017763 0 ustar haruki なし setErrorHandling(PEAR_ERROR_PRINT);
$tmpl->setTemplateFile('./helloworld.html');
$model_data = array(
'title' => 'Hello World',
'body' => 'PHPOOT is a template engine for PHP'
);
$output = '';
$tmpl->expand($output, $model_data);
echo "\n";
echo htmlspecialchars($output);
echo "\n
\n";
?> phpoot.0.4.1/sample/helloworld.html 0100700 0001753 0001001 00000000221 10021613251 016641 0 ustar haruki なし
title will be inserted here
title will be inserted here
phpoot.0.4.1/sample/list.php 0100700 0001753 0001001 00000000272 10016661562 015306 0 ustar haruki なし setTemplateFile('./list.html');
$model_data = array(
'list1' => array(1, 2, 3)
);
$tmpl->display($model_data);
?> phpoot.0.4.1/sample/list_num.html 0100700 0001753 0001001 00000000160 10021614035 016323 0 ustar haruki なし
phpoot.0.4.1/sample/list_num.php 0100700 0001753 0001001 00000000304 10020224116 016142 0 ustar haruki なし setTemplateFile('./list_num.html');
$model_data = array(
'list1' => array('a', 'b', 'c')
);
$tmpl->display($model_data);
?> phpoot.0.4.1/sample/remove.html 0100700 0001753 0001001 00000000272 10021613527 015777 0 ustar haruki なし
<% foo(); %>
title will be inserted here
';
}
?> phpoot.0.4.1/sample/table.html 0100700 0001753 0001001 00000000231 10021613556 015566 0 ustar haruki なし
phpoot.0.4.1/sample/table.php 0100700 0001753 0001001 00000000555 10016663233 015423 0 ustar haruki なし setTemplateFile('./table.html');
$model_data = array(
'table1' => array(
array( 'name' => 'PHP', 'author' => 'Rasmus Lerdorf' ),
array( 'name' => 'Ruby', 'author' => 'matz' ),
array( 'name' => 'python', 'author' => 'Guido van Rossum' )
)
);
$tmpl->display($model_data);
?> phpoot.0.4.1/sample/table_alt.html 0100700 0001753 0001001 00000000450 10021613620 016421 0 ustar haruki なし name author
phpoot.0.4.1/sample/table_alt.php 0100700 0001753 0001001 00000000561 10020224116 016244 0 ustar haruki なし setTemplateFile('./table_alt.html');
$model_data = array(
'table1' => array(
array( 'name' => 'PHP', 'author' => 'Rasmus Lerdorf' ),
array( 'name' => 'Ruby', 'author' => 'matz' ),
array( 'name' => 'python', 'author' => 'Guido van Rossum' )
)
);
$tmpl->display($model_data);
?> phpoot.0.4.1/sample/table_no_alt.html 0100700 0001753 0001001 00000000454 10021613655 017131 0 ustar haruki なし name author
*
+
phpoot.0.4.1/sample/table_no_alt.php 0100700 0001753 0001001 00000000564 10021104017 016741 0 ustar haruki なし setTemplateFile('./table_no_alt.html');
$model_data = array(
'table1' => array(
array( 'name' => 'PHP', 'author' => 'Rasmus Lerdorf' ),
array( 'name' => 'Ruby', 'author' => 'matz' ),
array( 'name' => 'python', 'author' => 'Guido van Rossum' )
)
);
$tmpl->display($model_data);
?> name author
*
+