Покритикуйте шаблонизатор

Введение
Класс обеспечивает работу с шаблонами. Цель - вынести весь HTML код
в отдельные файлы *.tpl которые будут содержать весь дизайн и т.п. Програмируя суть не заморачиваешься о HTML, код проще писать и читать, дизайнеру нет надобности разбираться в PHP коде.


Описание класса
Класс написан по шаблону singleton, т.е. предусматривает существование только одного экземпляра класса.
Экземпляр создается методом init.
$templ = templ::init(каталог_шаблонов, каталог_скинов, режим_шаблонизатора);

Режим_шаблонизатора может быть: file, folder, db
Режим db подразумевает хранение шаблонов в базе данных. На данный момент в стадии разработки. Режим folder подразумевает, что для каждого скина отдельная папка а не файл. Используется редко. В данном режиме нельзя использовать inc в скинах. По умолчанию используется тип file. В этом режиме каждому скину соответствует
файл в папке скинов. Далее описывается работа именно этого режима.

Каталог_скинов это каталог в котором хранятся скины. По умолчанию равен каталогу шаблонов.

Каталог_шаблонов это каталог в котором лежат шаблоны страниц. По умолчанию равен dirname(__FILE__).'/../templ/' т.е. если модуль шаблонизатора расположен в каталоге /include/ и при инициализации шаблонизатора не указать параметров

$templ = templ::init();

то шаблонизатор будет искать шаблоны и скины в папке /templ/

Метод set добавляет переменную в шаблонизатор.

$templ->set(имя_переменной,значение);

Метод get используется для чтения переменной из шаблонизатора. Строго говоря желательно отправлять переменную в шаблонизатор когда все манипуляции с ней завершены. Плюс как правило если переменная нужна проще сохранить ее в пространстве переменных самого php но в некоторых случаях удобнее взять ее из шаблонизатора.

$templ->get(имя_переменной);

Метод do_templ выполняет интерпретацию шаблона и возвращает результат. В отличии от старых версий выводит результат нужно самому. Так сделано потому, что некоторые классы наследующие шаблонизатор выводят html-заголовки и организуют кэширование.

$templ->go(имя_шаблона,имя_скина);

Имя скина по умолчанию равно template.

Типичная работа с модулем выглядит примерно так:

$templ = templ::init(); // инициируем модуль
// собственно логика приложения
$templ->set(имя_переменной1,значение1); // передаем первую переменную
...
$templ->set(имя_переменнойN,значениеN); // передаем N-ную переменную
echo $templ->do_templ(имя_шаблона); // выводим данные с использованием имя_шаблона

Синтаксис языка шаблонов
HTML-код состоит из двух частей - скина и шаблона. Скин это общие для сайта или раздела элементы, а шаблон это часть которая специфична для конкретной страницы. Как правило "скин" содержит дизайн а шаблон структуру данных конкретной страницы.

Работа шаблонизатора начинается с поиска файла соответствующего скина. Если шаблон не указан ищется шаблон с именем template. Если шаблон не найден, то считается что содержимое шаблона равно {BODY}.

В первую очередь в файле скина производится замена конструкций {inc=имя_инклюда} на содержимое соответствующего файла.
Имена подключаемых файлов, как и имена скинов и шаблонов указываются без расширения, которое равно .tpl
Файлы ищутся в папке со скинами. Все несуществующие инклюды считаются равными пустой строке.

Далее шаблонизатор ищет конструкцию {body} и заменяет ее на содержимое файла шаблона. Если шаблон не найден он считается равным пустой строке.

Следующим шагом шаблонизатор заменяет все конструкции {inc=имя_инклюда} на содержимое соответствующих файлов. Эти файлы ищутся уже в папке шаблонов. Все несуществующие инклюды считаются равными пустой строке.

Далее шаблонизатор ищет все конструкции вида {$имя_переменной=значение переменной}, добавляет соответствующие переменные в массив переменных для подстановки и удаляет эти конструкции из шаблона. Это удобно для хранения текстовых констант прямо в шаблоне давая дизайнеру возможность править тексты, или как один из вариантов организации мультиязычности или тайтл хранить в шаблоне, или разместить бокс с "подсказками" в скине, а сами тексты подсказок хранить в шаблонах.

Основные конструкции шаблонизатора

Все конструкции вида {имя_переменной} которые не являются управляющими конструкциями заменяются на значение соответствующей переменной.

Конструкция вида

{if=имя_переменной}
тело
{/if=имя_переменной}

заменяется на "тело" если значение переменной "имя_переменной" истино, и заменяется на пустую строку если оно ложно.

Конструкция вида

{if!=имя_переменной}
тело
{/if!=имя_переменной}

в отличии от предидущей заменяется на "тело" если значение переменной "имя_переменной" ЛОЖНО, и заменяется на пустую строку если оно ИСТИННО.

Массивы

Вывод таблиц и прочих массивов обеспечивается следующей конструкцией:

<array=имя_массива>
тело
</array=имя_массива>

Для каждого элемента массива выводится "тело" с заменой соответствующих переменных. Внутри "тела" массива применимы переменные вида {имя_массива.имя переменной}. Аналогично и условия в условных конструкциях.

Пример php-кода передачи массива:

$people=array();
$people[]=array('name'=>'Иван','woman'=>FALSE,'age'=>18);
$people[]=array('name'=>'Петр','woman'=>FALSE,'age'=>36);
$people[]=array('name'=>'Анна','woman'=>TRUE,'age'=>20);
$people[]=array('name'=>'Гена','woman'=>FALSE,'age'=>33);
$people[]=array('name'=>'Лена','woman'=>TRUE,'age'=>21);
$templ->set('people',$people);

код шаблона для вывода этого массива:

{array=people}
{people.name}, {people.age} лет.
{if=people.woman}Женщина{/if=people.woman}
{if!=people.woman}Мужчина{/if!=people.woman}
{/array=people}

"Волшебные" переменные

В шаблонизаторе есть некоторые предопределенные переменные:
_SELF - адрес страницы откуда вызван скрипт (аналог PHP_SELF) удобна для форм.

В массивах есть такие переменные:
_first - истина если это первая запись в массиве и ложна если НЕ первая.
_last - истинна если последняя запись в массиве и ложна если НЕ последняя.
_odd - истина если запись нечетная по порядку
_even - истина если четная по порядку

Четность/нечетность удобна для того, чтобы можно было выделять разным цветом рядом идущие строки, что улучшает юзабилити интерфейса. Часто не нужно выводить тот или иной тег или надпись если запись первая или последняя но выводить для всех остальных.

Зарезервированные выражения
if=
if!=
array
$
inc
body
_self
_first
_last
_odd
_even
прочие переменные через _
а также аналогичные выражения большими буквами.

HOOK`и шаблонов
HOOK`и это когда в шаблоне делается некая пометка типа "здесь кончается главный блок" или "это начало верхнего меню" или "тут конец левой колонки" и т.п. Когда программист пишет плагин, то он просто указывает что такой-то шаблон нужно вставить вместо того или иного хука. Т.о. при разработке дизайна сайта не обязательно учитывать сразу все плагины. Достаточно расставить в нужных местах хуки, а уже разработчик плагина будет задумываться о том как правильно оформить свой плагин. Далее разработчик плагина хочет в этом месте вывести свой код... к примеру блок тэгов или календарь или рекламную ссылку или любой другой.

Метки хуков в шаблонизаторе имеют такой синтаксис: {#имя_метки}
Программист должен зарегистрировать соответствующий хук примерно таким кодом:
$templ->hook('имя_метки','имя_шаблона');
шаблонизатор встретив метку в шаблоне смотрит есть ли хуки для этой метки.
Если хуков нет, то он просто удаляет метку. Если хуки есть, то он добавляет соответствующие файлы шаблонов вместо метки. Для каждой метки может быть неограниченное количество хуков. Они выводятся в порядке их объявления в программе. Шаблоны хуков берутся в папке шаблонов а не скинов.
Существует также дополнительный синтаксис хуков:
$templ->hook('имя_метки','#код_хука');
т.е. если хук начинается со знака решетки, то вместо того, чтобы искать файл с хуком шаблонизатор просто вставляет все что идет после решетки в шаблон. Рекомендуется использовать такой синтаксис в исключительных случаях, поскольку правила хорошего стиля говорят, что весь html-код должен быть в шаблонах а не в коде, однако в некоторых случаях это является разумным - например когда код вводится в админке и хранится в базе, или когда код настолько прост, что глупо плодить сотни маленьких файлов шаблонов. К примеру код банеров проще выводить напрямую без шаблонов.