Blitz Templates

bash> tar zxvf blitz.tar.gz
bash> cd blitz
bash> phpize
bash> make
bash> ./configure
bash> make install

Начиная с версии 0.4 в дистрибутив входит несколько тестов:

bash>./run-tests.sh
=====================================================================
CWD         : /home/fisher/prj/blitz/tests
PHP         : /usr/local/bin/php
PHP_SAPI    : cli
PHP_VERSION : 4.3.10
ZEND_VERSION: 1.3.0
PHP_OS      : Linux - Linux fisher 2.6.8-24.19-smp #1 SMP Tue Nov 29 14:32:45 UTC 2005 i686
INI actual  : /usr/local/lib/php.ini
More .INIs  :
Extra dirs  :
=====================================================================
Running selected tests.
PASS contexts [context.phpt]
PASS errors and warnings [errors.phpt]
PASS fetch [fetch.phpt]
PASS complex fetch [fetch_cmplx.phpt]
PASS predefined methods: if [if.phpt]
PASS predefined methods: include [include.phpt]
PASS user-defined methods [method.phpt]
PASS method call from inner include [mfi.phpt]
PASS variables [var.phpt]

Переменные. Следующий код демонстрирует работу с переменными:

Ex. 1, file ex1A.tpl:
Это некоторый тест для двух переменных: {{ $a }} и {{ $b }}, номер итерации: {{ $i }}

Ex. 1, file ex1B.php
<?

$T = new Blitz('ex1A.tpl');
$i = 0;
$i_max = 10;
for ($i = 0; $i<$i_max; $i++) {
    echo $T->parse(
        array(
            'a' => 'var_'.(2*$i),
            'b' => 'var_'.(2*$i+1),
            'i' => $i
        )
    );
}

?>
Ex.1 Output:
Это некоторый тест для двух переменных: var_0 и var_1, номер итерации: 0
Это некоторый тест для двух переменных: var_2 и var_3, номер итерации: 1
Это некоторый тест для двух переменных: var_4 и var_5, номер итерации: 2
Это некоторый тест для двух переменных: var_6 и var_7, номер итерации: 3
Это некоторый тест для двух переменных: var_8 и var_9, номер итерации: 4
Это некоторый тест для двух переменных: var_10 и var_11, номер итерации: 5
Это некоторый тест для двух переменных: var_12 и var_13, номер итерации: 6
Это некоторый тест для двух переменных: var_14 и var_15, номер итерации: 7
Это некоторый тест для двух переменных: var_16 и var_17, номер итерации: 8
Это некоторый тест для двух переменных: var_18 и var_19, номер итерации: 9

Спец-методы. Следующий код демонстрирует использование include:

Ex. 2, file ex2A.tpl:
Мама {{ include('ex2B.tpl') }} раму

Ex. 2, file ex2B.tpl:
мыла

Ex. 2, file ex2С.php:
<?

$T = new Blitz('ex2A.tpl');
echo $T->parse();
echo "\n";

?>
Ex.2 Output:
Мама мыла раму

Ex. 3, file ex3A.tpl:
переменная a = {{ $a }}
внутренний шаблон: {{ include('ex3B.tpl') }}
переменная b = {{ $b }}

Ex. 3, file ex3B.tpl:
/* переменная a = {{ $a }}, переменная b = {{ $b }} */

Ex. 3, file ex3С.php:
<?

$T = new Blitz('ex3A.tpl');
$T->set(array('a' => 'a_value', 'b' => 'b_value'));
echo $T->parse();
echo "\n";

?>
Ex.3 Output:
переменная a = a_value
внутренний шаблон: /* переменная a = a_value, переменная b = b_value */
переменная b = b_value

Ex. 4, file ex4A.tpl:
{{ $num }}. {{ $name }} {{ if($rip,'[R.I.P.]') }}

Ex. 4, file ex4B.php:
<?

T = new Blitz('ex4A.tpl');
$character = array(
    array(1,'The Dude',0),
    array(2,'Walter Sobchak',0),
    array(3,'Donny',1),
    array(4,'Maude Lebowski',0),
    array(5,'The Big Lebowski',0),
    array(6,'Brandt',0),
    array(7,'Jesus Quintana',0),
);

foreach ($character as $i => $data) {
   echo $T->parse(
       array(
           'num' => $data[0],
           'name' => $data[1],
           'rip' => $data[2]
       )
   );
}

?>
Ex.4 Output:
1. The Dude
2. Walter Sobchak
3. Donny [R.I.P.]
4. Maude Lebowski
5. The Big Lebowski
6. Brandt
7. Jesus Quintana

Пользовательские методы. Возможность включать в шаблон пользовательские методы - самая интересная с точки зрения организации хорошего и удобно читаемого кода. До сих пор в примерах использовался стандартный класс Blitz, никакими новыми методами не обладающий. Однако, если создать объект класса-наследника Blitz, который предоставляет некоторый метод my_test, в шаблоне можно использовать вызов этого метода ровно с таким же названием:

Ex 5, file ex5a.tpl:
пример вызова пользовательского метода: {{ my_test }}

Ex 5, file ex5B.php:
<?

class BlitzTemplate extends Blitz {

    function BlitzTemplate($t) {
        parent::Blitz($t);
    }

    function my_test() {
        return 'user method called ('.__CLASS__.','.__LINE__.')';
    }
}

$T = new BlitzTemplate('ex5A.tpl');
echo $T->parse();

?>

Ex 5, Output:
пример вызова пользовательского метода: user method called (blitztemplate,10)

Все, что возвращает пользовательский метод будет сконвертировано в строку и подставлено вместо вызова. Если вызов метода в шаблоне есть, но самого метода нет - будет подставлена пустая строка. Вообще, действует обычное правило: никаких исходных вызовов никогда не присутсвует в конечном результате, независимо от существования переменной, метода и проч.

Внутри пользовательского метода также можно включать другие шаблоны. Конечно, никто не запрещает вам написать что-нибудь вроде:

class BlitzTemplate extends Blitz {
    var $data;
    var $TItem;
    function BlitzTemplate($t,$titem) {
        parent::Blitz($t);
        $TItem = new Blitz($titem);
    }

    function set_data() {
        // some code
    }

    function my_test() {
        $result = '';
        foreach ($this->data as $i_data) {
            $result .= $TItem->parse($i_data);
        }
        return $result;
    }
}

$T = new BlitzTemplate('main.tpl','item.tpl');
// $bla_bla = ...
$T->set_data($blabla);
echo $T->parse();

Начиная с версии 0.3 в blitz поддерживается передача параметров из шаблона в пользовательский метод:

Ex.7, file ex7A.tpl:
calling template with arguments: {{ my_test(134,$x,"hello,world!",$dummy) }}
Ex.7, file ex7B.php:

<?

class BlitzTemplate extends Blitz {
    var $titem;

    function BlitzTemplate($t) {
        parent::Blitz($t);
        $this->set(array('x' => 1234));
    }

    function my_test($p1,$p2,$p3,$p4) {
        $result = 'user method called ('.__CLASS__.','.__LINE__.')'."\n";
        $result .= 'parameters are:'."\n";
        $result .= '1:'.var_export($p1,TRUE)."\n";
        $result .= '2:'.var_export($p2,TRUE)."\n";
        $result .= '3:'.var_export($p3,TRUE)."\n";
        $result .= '4:'.var_export($p4,TRUE)."\n";
        return $result;
    }
}

$T = new BlitzTemplate('ex7A.tpl');
echo $T->parse();

?>

Ex. 7, Output:
calling template with arguments: user method called (blitztemplate,12)
parameters are:
1:134
2:1234
3:'hello,world!'
4:NULL

Контексты. Начиная с версии 0.4 в blitz практически без изменений была добавлена функциональность движка php_templates. Суть контекстов заключается в следующем. Обычно мы имеем дело с "плоскими" шаблонами, в них есть либо переменные, либо какие-то операторы или вызовы, которые обязательно исполняются. Контексты - это подшаблоны, которые не используются до тех пор, пока контроллер шаблона явно это не укажет. Например, если у нас есть php-код " переменная: [?=$a; ?], метод: [?=b(); ?] ", то оба куска этого кода будут всегда исполнены. Никакой иерархии нет, все php-шаблоны плоские. Теперь рассмотрим некий псевдо-код с контекстами "переменная : {{ $a }}, контекст {{ BEGIN b }} что-то внутри {{ END }}". Здесь b - это контекст, который по умолчанию не будет использован (чаще используют термин "итерирован") - и вместо кода от BEGIN до END ничего не будет. Если контекст итерирован один раз, то в шаблоне появится результат исполнения внутренней части контекста. Если проитерировать дважды - результат исполнения внутренней части контекста два раза. Параметры у каждой итерации разумеется могут быть разными. Таким образом, для отображения списков достаточно просто итерировать контекст, описывающий элемент списка, для каждого элемента. Самое удобное заключается в том, что контексты могут быть вложены друг в друга. Каждый контекст однозначно определён своим путём - /root/node/item одначает что есть контекст root внутри которого контекст node внутри которого item. Если итерировать родительский контекст с одними параметрами, потом вложенные конкетсты, потом снова родительские контексты с другими параметрами, а потом снова вложенные, то можно при помощи одного единственного шаблона сделать страницу абсолютно любой сложности. Есть базовые операции с контекстами - установить текущий контекст и итерировать контекст. Установка означает, что все вызовы по умолчанию работают с этим контекстом, тут есть хорошая аналогия с работой коммандной оболочке - установить текущий контекст в /root/node/item по смыслу то же самое что сделать cd в /root/node/item. А итерировать фактически означает "исполнить".

Следующий код выводит ужасно доставшее всех знакомое всем приветствие, запрятанное в трёх вложенных контекстах.

tree.tpl:
{{ BEGIN root }}
  {{ BEGIN node }}
    {{ BEGIN item }}
        hello, world
    {{ END }}
  {{ END }}
{{ END }}
код:
$T = new Blitz('tree.tpl');
$T->iterate('/root/node/item');
echo $T->parse();

Следующий пример демонстрирует работу с простыми списками

ex8A.tpl:
{{ BEGIN row }}row #{{ $i }}
{{ END }}
ex8B.php:
$T = new Blitz('ex8A.tpl');

$max_num_list = 5;

// use context & iterate
$T->context('row');
for($i=0; $i<$max_num_list; $i++) {
    $T->iterate();
    $T->set(array('i' => $i));
}

// or just use block
for($i=0; $i<$max_num_list; $i++) {
    $T->block('/row',array('i' => $i));
}

echo $T->parse();

Ex. 8, Output:
row #0
row #1
row #2
row #3
row #4
row #0
row #1
row #2
row #3
row #4

Метод block - удобная замена последовательным iterate и set, которые встречаются в коде очень часто именно вместе. Разумеется, в Blitz внутри контекста можно использовать и include, и if, и пользовательские методы. Переменные, установленные в родительских контекстах, "не видны" в дочерних. Если есть необходимость в глобальных переменных, которые будут "видны" в любом месте шаблона - можно использовать метод set_globals вместо set.

Следующий пример показывает, как при помощи вложенных конекстов строить более сложные списки.

ex9A.tpl:
complex list example
{{ BEGIN list; }}
list #{{ $list_num }}
{{ BEGIN list_empty; }} this list is empty {{ END }}{{ BEGIN list_item; }} row #{{ $i_row; }}
{{ END }}
{{ END }}
ex9B.php:
$T = new Blitz('ex9A.tpl');

$max_num_list = 5;
$max_num_item = 5;

$T->context('/list');
for($i=0; $i<$max_num_list; $i++) {
    $T->block('',array('list_num' => $i));
    $is_empty = $i%2; // emulate empty sub-lists

    if($is_empty) {
        $T->block('list_empty');
    } else {
        for($j=0; $j<$max_num_item; $j++) {
           $T->block('list_item',array('i_row' => $i.':'.$j));
        }
    }
}

echo $T->parse();

Ex. 9, Output:
complex list example

list #0
 row #0:0
 row #0:1
 row #0:2
 row #0:3
 row #0:4


list #1
 this list is empty

list #2
 row #2:0
 row #2:1
 row #2:2
 row #2:3
 row #2:4


list #3
 this list is empty

list #4
 row #4:0
 row #4:1
 row #4:2
 row #4:3
 row #4:4

Фактически на это простом механизме попеременных итераций вложенных котекстов реализуется абсолютно любая логика даже в одном единственном шаблоне.

Для того, чтобы иметь возможность разделять шаблоны, и использовать контент одного шаблона при работе с другим шаблоном, и даже более того, тело одного контекста в одном шаблоне внутри другого, можно использовать метод fetch:

ex10A.tpl:
{{ BEGIN online }} online! {{ END }}
{{ BEGIN offline }} was online {{ $n }} {{ BEGIN h }}hours{{ END }}{{ BEGIN d }}days{{ END }}{{ BEGIN m }}months{{ END }} ago {{ END }}
{{ BEGIN away }} away... {{ END }}

ex10B.php:
$T = new Blitz('ex10A.tpl');

// online
echo $T->fetch('online')."\n";

// away
echo $T->fetch('away')."\n";

$T->context('offline');

// 15 days ago
$T->iterate('d');
echo $T->fetch('offline', array('n' => 15))."\n";

$T->iterate(); // create next iteration for offline block

// 2 months ago
$T->iterate('m');
echo $T->fetch('offline', array('n' => 2))."\n";

Ex. 10, Output:
 online!
 away...
 was online 15 days ago
 was online 2 months ago

Вместо того, чтобы "очистить" каким-либо образом предыдущую итерацию контекста offline (такой функционал будет добавлен в blitz в самое ближайшее время), создается новая итерация. Метод fetch получает результат исполнения последней итерации контекста. В-общем, функционал контекстов достаточно мощный для того, что бы использовать шаблонный движок для сколь угодно сложных проектов. В blitz внутри контектов также доступны такие приятные мелочи как if, include и вызов метода контроллера.

Наконец, можно использовать метод load, чтобы загрузить тело шаблона из обычной php-переменной:

ex11A.php:
$body = <<<BODY
hello, {{ \$who }}!
{{ bye; }}

BODY;

class View extends Blitz {
    function bye() {
        return "Have a lot of fun!...";
    }
}

$T = new View();
$T->load($body);
echo $T->parse(array('who' => 'world'));

Ex. 11, Output:
hello, world!
Have a lot of fun!...

Параметры настройки

Синтаксис Blitz и API