diff --git a/README.md b/README.md index 0774038..da1e2f2 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,92 @@ # tplBlock +A very simple PHP template class + [![Build Status](https://travis-ci.org/gnieark/tplBlock.svg?branch=master)](https://travis-ci.org/gnieark/tplBlock) -It's a work in progress repo. Class is not usable for now. +# Sample + +This simple template file: + +```html + + +

{{pageTilte}}

+ + + + +``` + +Parsed with this code + +```php +add_vars(array("pageTilte" => "Poke @zigazou ;)")); + + +$data = array( + array( + "url" => "https://github.com/gnieark/tplBlock", + "name" => "tplBlock", + "author" => "Gnieark", + "quality" => "simple and perfect" + ), + array( + "url" => "https://github.com/Zigazou/TemplateEngine", + "name" => "TemplateEngine", + "author" => "Zigazou", + "quality" => "more complex than tplBlock" + + ) +); + +//add blocks +foreach ($data as $block){ + $tplTemplateSystem = new TplBlock("templatesystem"); + $tplTemplateSystem -> add_vars($block); + $tpl->add_sub_block($tplTemplateSystem); +} + +//parsing: +echo $tpl->apply_tpl_file("template.html"); +``` +will return: + +```html + + +

Poke @zigazou ;)

+ + + + +``` + +# Conception choices + +I wrote this class for use it on others personnals projects. It's really simple. I think logicals functions "OR" "IF", filtering, caching, are not the templating system matter. -I don't want to use templating class containing deprecated functions. +If a block ( <--BEGIN .... )is in the template, but is not called, it will be deleted. -I don't want to use one which is a gaz factory. +Methods apply_tpl_file and apply_tpl_str have for second (optional) parameters a bolean. (true if not given). +If true, the potentials carriage returns just after the BEGIN and just before the END are deleted. -So, I invent the wheel again, and i make mine. -Se the path test-TplBlock to have a sample. +For now, class is permissive. I'll improve it to manage templating errors. \ No newline at end of file