Данный модуль представляет собой новую версию '''VMX::Template''' — простой и высокопроизводительный шаблонизатор, построенную на некоторых новых идеях, ликвидировавшую безобразие имеющий Perl- и legacyPHP-код, накопленный в [[Шаблонизатор VMX::Template/Старая версия|старой версии]], однако сохранившую высокую производительность и простоту.
Есть * Лицензия: GNU GPL версии 3 или новее* Полный набор исходников здесь: http://yourcmc.ru/git/vitalif/VMXTemplate** PHP-версия (PHP >= 5.4): [{{SVN|vitaphotohttp:/branch/yourcmc.ru/git/vitalif/VMXTemplate/raw/master/template.phptemplate.php] и [http://yourcmc.ru/git/vitalif/VMXTemplate/raw/master/template.parser.php}} PHPtemplate.parser.php].** Новая Perl-версия: [http://yourcmc.ru/git/vitalif/VMXTemplate/raw/master/VMXTemplate.pm VMXTemplate.pm] и все его [{{SVN|vitaphotohttp:/branch/solsticeyourcmc.ru/lib-swaygit/VMXtree/TemplateVMXTemplate.git/master/VMXTemplate подмодули VMXTemplate/*.pm}} ].** Старая Perl-версия: [http://yourcmc.ru/git/vitalif/VMXTemplate/raw/master/VMX%2FTemplate.pm VMX/Template.pm] шаблонизатораи [http://yourcmc. Реализация, естественно, несколько отличается по причине различий языков — например, в Perl’е для кэширования кода используются coderef’ы, а в ru/git/vitalif/VMXTemplate/raw/master/VMX%2FCommon.pm VMX/Common.pm].** Исходный код грамматики PHP предполагается, что кэшированием занимается какой-нибудь версии (LALR(1) [http://xcacheyourcmc.lighttpdru/git/vitalif/lime LIME]): [http://yourcmc.netru/ XCachegit/vitalif/VMXTemplate/raw/master/template.lime template.lime] или .** Исходный код грамматики Perl-версии (LALR(1) {{CPAN|Parse::Yapp}}): [http://eacceleratoryourcmc.netru/ eAcceleratorgit/vitalif/VMXTemplate/raw/master/template.yp template.yp]и [http://yourcmc.ru/git/vitalif/VMXTemplate/raw/master/template.skel.pm template.skel.pm].** Исходный код голой грамматики (LALR(1) yacc): [http://yourcmc.ru/git/vitalif/VMXTemplate/raw/master/template.y template.y].** В Git-репозитории можно найти полную историю разработки, ибо там сохранить coderef между запросами, поначиная с самых старых phpbb-видимомуподобный версий.* Простые настройки для подсветки синтаксиса шаблонов в [http://www.midnight-commander.org/ Midnight Commander]'а: [{{SVN|vitalif/trunk/scripts/tpl.syntax|markup}} tpl.syntax]. Чтобы подсветка нормально выглядела, невозможнок tpl.syntax в начало надо дописать html.syntax из стандартного комплекта поставки mc.
Развивается то одна, то другая, в зависимости от проекта, над которым я работаю в моменте.== Что это за шаблонизатор? ==
Также есть простенький (и кривоватенький) файл настроек синтаксиса шаблонов для [http://www.midnight-commander.org/ Midnight Commander]'а''VMX: :Template''' изначально реализован по мотивам примитивного шаблонизатора, взятого из кода форума phpBB 2 ([[{{SVN|vitalif/trunk/scripts/tpl.syntaxСтарая версия|markup}} tpl.syntaxисторическое описание старой версии].]), и с тех пор (с 2006 года) переписанного 4 раза:# На регулярные выражения →# На поиск подстроки →# На метод рекурсивного спуска →# И, наконец, на LALR(1) грамматику на основе генератора парсеров LIME
Работаю над переводчиком с {{CPAN|TemplateЕсть PHP и Perl версии шаблонизатора, основная версия шаблонизатора — в данный момент PHP. Есть некоторые различия реализации — например, в Perl’е для кэширования кода используются coderef’ы, а в PHP предполагается, что кэшированием занимается какой-нибудь [http://xcache.lighttpd.net/ XCache] или [http:Toolkit}} на VMX::Template//eaccelerator. (ибо TT — задралnet/ eAccelerator], скотина!)ибо там сохранить coderef между запросами невозможно.
<span style="border: 2px #FF8000 dashed; padding: 4px">Про VMX::Template можно Template можно сказать «ох уж эти перлисты — что ни пишут, всё Template::Toolkit получается».</span> Это к тому, что идея вообще-то схожая, но реализация гораздо проще и быстрее.
== Идеи == Уйти от assign_vars()Это к тому, assign_block_vars(). Передаватьчто и идея, как и в обычных движках, просто хеш с данными $vars. Как, например, в {{CPAN|Template::Toolkit}}. При этом сохранить данные методы для совместимости. Почистить синтаксис: ликвидировать «преобразования», «вложенный путь по переменной» (шаблонов вообще->key->index->key->и т. п.), специальный синтаксис для окончания SET, неочевидное обращение к счётчику block.#, tr_assign_* и т. п. Переписать с нуля компилятор. Добавить в употребление функциито схожи, но только самые необходимые. Добавить обработку ошибок сама реализация гораздо проще и диагностические сообщениябыстрее.
== Использование ==
Здесь можно прочитать об: использовании в PHP, использовании в Perl, различиях реализаций.
=== PHP ===
Требуется PHP версии не ниже 5.4. <source lang="code-php">
require_once 'template.php';
# Конструктор(значения опций - по умолчанию)$template = new TemplateVMXTemplate(array(
'root' => '.', # директория с шаблонами
'cache_dir' => './cache', # директория для кэширования компилированного кода шаблонов
'print_error' => truefalse, # если true, ошибки компиляции выводятся на STDOUT
'raise_error' => false, # если true, при ошибке компиляции вызывается die()
'log_error' => false, # если true, ошибки компиляции логгируются через error_log()
'reload' => true, # если false, шаблоны будут считываться с диска только 1 раз, и вызовов stat() происходить не будет
'use_utf8' => true, # если true, использовать кодировку UTF-8 для строковых операций
'end_code' => '-->', # маркер конца директивы кода
'eat_code_line' => true, # (похоже на TT CHOMP) съедать "лишний" перевод строки, если в строке только директива?
'begin_subst' => '{', # маркер начала подстановки выражения(либо {, либо false) 'end_subst' => '}', # маркер конца подстановки выражения(либо }, либо false)
'compiletime_functions' => # дополнительные компилируемые функции
array('func' => callback), # массив хеш вида имя функции (в шаблонах) => callback($template, array $args),
# которому передаются скомпилированные выражения всех аргументов
'strip_space' => true, # немного legacy, устаревшеевстроенный фильтр:срезание пробелов из начал и концов строк 'wrapperfilters' => NULL, # если равно чемуфильтры -то, что можно вызвать, через это будет # пропущен вывод выполняются над выводом всех шаблонов array("глобальный фильтр"callback1, ...), 'strict_endauto_escape' => false, # требовать <!функция авто-экранирования, например "s" (для HTML- END имя_блока --> после <!-- BEGIN имя_блока -->безопасного режима)
));
# Выполнение шаблона и получение результата:
# (возможно с передачей целого хеша данныхв шаблон)$page = $template->parse('имя_файла.tpl' [, array("ключ" => "значение", ...)]);
# Аналогично выполнение Выполнение именованного блока из файла:$page = $template->parseexec_from('имя_файла.tpl', 'имя_блока' [, array("ключ" => "значение", ...)]);
# Аналогично выполнение Выполнение кода из строки:$page = $template->parseparse_inline(NULL, 'код' [, array("ключ" => "значение", ...)]); # Выполнение именованного блока из кода (не рекомендуется, но возможно):$page = $template->exec_from_inline('код', 'имя_блока'] [, array("ключ" => "значение", ...)]);
# Очистка сохранённых данных для генерации ещё одной страницы:
$template->clear;
</sourcecode-php>
=== Perl ===
=== Различия ===Perl версия обновлена и теперь в точности соответствует PHP-версии.
'''Кэширование работает по-разному.'''<source lang="perl">use VMXTemplate;
В целом# Конструктор$template = new VMXTemplate( 'root' => '.', # директория с шаблонами 'cache_dir' => undef, # директория для кэширования компилированного кода шаблонов 'reload' => 2, общий смысл — сделать так # если 0, чтобы то шаблоны было не стыдно вызывать много разбудут перечитываться с диска, как много и вызовов stat() происходить не будет # если >0, то шаблоны будут перечитываться с диска не чаще чем раз за один запросв reload секунд 'print_error' => 1, так и # если TRUE, ошибки компиляции попадают в целомвывод шаблона 'log_error' => 1, # если TRUE, ошибки компиляции печатаются на STDERR 'raise_error' => 0, # если TRUE, при этом максимально ошибке компиляции вызывается die() 'use_utf8' => undef, # если TRUE, использовать механизмы интерпретатора самого языка"use utf8" на шаблонах 'begin_code' => '<!--', # маркер начала директивы кода 'end_code' => '-->', # маркер конца директивы кода 'begin_subst' => '{', # маркер начала подстановки выражения 'end_subst' => '}', # маркер конца подстановки выражения 'eat_code_line' => 1, # (похоже на TT CHOMP) если TRUE, съедать "лишний" перевод строки, если в строке только директива кода (begin_code. Но механизмы для этого применяются разные. Основная причина следующаяend_code) 'no_code_subst' => 1, # если TRUE, выполнять директивы кода (begin_code..end_code), но игнорировать их результат 'compiletime_functions' => # дополнительные компилируемые функции { 'func' => sub {} }, # хеш вида имя функции (в шаблонах) => coderef, # которому передаются скомпилированные выражения всех аргументов и первым - парсер (объект VMXTemplate::Parser) 'filters' => [ sub {}, .. ], # фильтры для запуска на выводе каждого внешнего шаблона (фильтр - функция, модифицирующая $_[0]) 'strip_space' => 0, # если TRUE, удалять пробелы и табы из начала и конца всех строк вывода 'auto_escape' => '', # функция авто-экранирования, например "s" (для HTML-безопасного режима));
* Perl: считается, что всё прогрессивное человечество уже давно использует <tt$template->mod_perl</ttvars({ var => или [[Платформы для запуска Perl веб-приложений|другие способы запуска веб-приложений]], при которых частых переинициализаций интерпретатора не происходит. Иными словами, 'value'никто больше не использует CGI''. Таким образом, мы смело можем сохранить живой coderef (ссылку на функцию, или кому как больше нравится — анонимную функцию, замыкание, делегат) в промежутке между двумя запросами.* PHP: интерпретатор PHP инициализируется заново при обработке каждого HTTP-запроса . А coderef в промежутке между двумя инициализациями интерпретатора сохранить, видимо, невозможно..});
В # Выполнения полностью аналогичны PHP также есть ещё одна проблема — в процессе выполнения невозможно добавить метод в класс без использования извращений типа [http://pecl$page = $template->parse('имя_файла.phptpl' [, { "ключ" => "значение", .net/package/classkit classkit.. }]);$page = $template->exec_from('имя_файла.tpl', а хочется'имя_блока' [, { "ключ" => "значение", потому что сгенерированные из кода шаблона функции должны быть методами — они используют контекст класса Template... }]);$page = $template->parse_inline('код' [, { "ключ" => "значение", ... }]);$page = $template->exec_from_inline('код', 'имя_блока' [, { "ключ" => "значение", ... }]);
Поэтому компилированный шаблон PHP# Очистка сохранённых данных для генерации ещё одной страницы:$template-версии — это класс, производный от класса Template. Единожды за один HTTP-запрос он загружается в память, а при каждом вызове шаблона создаётся пустой объект этого класса, в него записывается ссылка на <tt>tpldataclear;</ttsource> и поле <tt>parent</tt>, ссылающееся на родительский объект Template, и вызывается метод класса, соответствующий блоку шаблона (см. [[#Блоки]]).
Кроме кэширования классов в рамках запроса в PHP существует ещё две ступени:* Текст шаблонов кэшируется в XCache или eAccelerator, если таковые присутствуют, и не перезагружается с диска лишний раз. Если <tt>reload = false</tt>, лишними считаются все разы, кроме первого, даже если файл шаблона менялся.* Компилированный код = Синтаксис шаблонов кэшируется в файлах на диске, и не компилируется лишний раз.==
В Perl действие <tt>reload</tt> немного отличается — <tt>reload = 0</tt> работает так жеШаблон — любой текст (типично — HTML), как <tt>reload = false</tt> в PHP, но если <tt>reload > 0<который ''местами'' включены директивы и/tt>, то тексты шаблонов перезагружаются с диска при изменении, но не чаще, чем раз в <tt>reload</tt> секунд. В остальном всё проще — компилированный шаблон представляет собой просто хеш с набором анонимных функций, которые сохраняются в my-переменной пакета VMX::Template и вызываются при обращении к шаблону или его блокам. Также существует и файловый кэш компилированного кодаподстановки.
'''Несколько различается действие <tt>use_utf8 = true</tt>.'''Если вы знаете о порождающих грамматиках, то вот контекстно-свободная грамматика для LALR(1) алгоритма разбора:
* Общий смысл — «мои шаблоны и страницы в кодировке UTFГолая Bison-8».* PHP: «использовать mb_str* функции грамматика, для работы со строками в выражениях».* Perlполучения представления о синтаксисе: «я передаю в шаблон все переменные с флагом UTF-8 = On, их можно смело конкатенировать с UTF-ными частями шаблона». Если кто-то не знает, в Perl строки имеют на себе флаг UTF-8 = да или нет, и при конкатенации строки без флага со строкой с флагом строка без флага будет автоматически переведена в UTF-8 из кодировки, соответствующей текущей локали. Что означает двойное UTF-8-кодирование в случае, если строка на самом деле всё-таки в UTF-8, но просто на ней не установлен флаг.*http: Для приведения всех переменных шаблона к UTF-8 можно использовать функцию <tt>utf8on()</tt> из [{{SVN|vitaphoto/branchyourcmc.ru/solsticegit/lib-swayvitalif/VMXVMXTemplate/Common.pm}} VMX::Common] (рекурсивный <tt>Encode::_utf8_on()<raw/tt>). '''Различается способ вывода ошибок при <tt>print_error = true<master/tt>template.'''y* Общий смысл — при <tt>print_error = true</tt> ошибки и предупреждения должны попасть на экран.* PHPРабочая [http: они просто выводятся print()'ами.* Perl: здесь так нельзя, потому что HTTP-заголовки сами могут и не отправиться, поэтому текст ошибок прицепляется к выводу шаблонизатора (возвращается вместе с результатом <tt>parse()</tt>)/github. '''Различаются аргументы, передаваемые в <tt>compiletime_functions<com/tt>.''' * PHP: просто список кода выражений всех аргументов вызова. Функцияvitalif/lime LIME]-компилятор вызывается вне контекста объекта.* Perlграмматика: тот же список + <tt>$self</tt> (объект VMXhttp::Template) в качестве первого элемента. '''Различается поведение функций сравнения.''' * PHP: EQ и т. п. без S/N — типозависимое сравнение/yourcmc.* Perl: EQ и т. п. без Sru/N эквивалентно строковому (Sxx). '''Различается поведение некоторых функций работы с массивами и хешами.''' * KEYS — в PHP порядок ключей массиваgit/vitalif/VMXTemplate/хеша сохраняется, а в Perl — нет и принимаются только хешиraw/master/template. Обусловлено реализацией хешей в этих языках.* EACH — в Perl-версии ключи будут отсортированы по имени.* RANGE — в Perl-версии принимает буквенные аргументы lime (Aдля её работы нужен патченый LIME — см..Z = весь алфавит).* IS_ARRAY — в PHP-версии не проверяется, а не является ли он при этом хэшем, ибо трудоёмко (надо проверить, численные ли все ключи).* AGET и HGET в PHP идентичны GET.* ARRAY_MERGEhttps: под Perl — только массивы (не хеши), под PHP — любые массивы.* DUMP — это Dumper в Perl’е и var_dump в PHP. == Реализация == Маркеры начала и конца кода <tt><nowiki><!-- --></nowiki></tt> и подстановки <tt><nowiki>{ }</nowiki></tt> могут быть заменены любыми другимиgithub. Если, например, вы привыкли к TT, можно установить <tt><nowiki>[% %]<com/nowiki><vitalif/tt>. Маркеры подстановки можно вообще убрать, ибо подстановка тоже является кодом.lime) Путь к переменной теперь может включать в себя числа. Это будут обращения к элементам массивов, в то время как всё остальное — обращения к элементам хешей. === Циклы === Вне блока * Рабочая {block} будет иметь значение ARRAY(0x…), то есть массив всех итераций блока block, а {block.0CPAN|Parse::Yapp} будет иметь значение HASH(0x…), то есть первую итерацию блока block. <pre><!-- BEGIN block --></pre> Теперь, внутри блока {block} теперь будет иметь значение HASH(0x…), то есть уже значение текущей итерации блока block, а {block.#} будет иметь значением номер текущей итерации блока, отсчитываемый с 0, а не с 1, как в старой версии. <pre><!-- END block --><грамматика: http:/pre> На <tt><nowiki><!-- END другоеимя --></nowiki><yourcmc.ru/tt> после <tt><nowiki><!-- BEGIN block --><git/nowiki><vitalif/tt> при <tt>strict_end = true<VMXTemplate/tt> шаблонизатор выдаст ошибку, «ибо нефиг» (c). Если block в хеше данных — не массив, а хеш — это значит, что итерация у блока только одна, и тогда <tt><nowiki><!-- BEGIN block --><raw/nowiki></tt> работает <s>как for($expression) {} в Perl<master/s> никакtemplate.yp
<tt>BEGIN ... END</tt> — это циклы в «старом стиле». А можно использовать и TT-подобный, обычно более удобный:=== Пример ===
<pre>
<!-- FOR var = expression SET title -->... Статистика
<!-- END -->
<!-- SET headscripts -->
<script language="javascript" type="text/javascript" src="{DOMAIN}/tpldata/jquery.min.js"></script>
<!-- END -->
<!-- INCLUDE "admin_header.tpl" -->
<!-- IF NOT srcid -->
<p>Добро пожаловать в простую OLAPообразную статистику. Выберите источник данных:</p>
<form action="?" method="GET">
<select style="width:100px" name="datasource">
<!-- FOR s = sources -->
<option value="{s s.id}">{s s.name}</option>
<!-- END -->
</select>
<input type="submit" value=" Продолжить " />
</form>
<!-- ELSEIF srcid == "test" || sources[srcid].mode == 'test' -->
<p>Тестовый режим.</p>
<!-- END -->
<!-- INCLUDE "admin_footer.tpl" -->
</pre>
Причём, если <tt>expression ::= block</tt>, то <tt>var</tt> может быть само <tt>block</tt>'ом. Это, по сути, и есть то, что делает BEGIN: <tt><nowiki><!-- BEGIN block --></nowiki></tt> эквивалентно <tt><nowiki><!-- FOR block = block --></nowiki></tt>. Предыдущее значение переменной цикла после выхода из цикла всегда восстанавливается.= Маркеры ===
К номеру итерации можно обратиться через * <tt><nowiki>'<!--', '-->'<tt/nowiki>{var#}</tt> — маркеры начала и конца директивы* <tt><nowiki>'{', '}'</nowiki></tt> — маркеры начала и конца подстановки выражения (между скобками не может быть инструкций типа IF/ELSE и т. п.)* Подстановки можно использовать и в директивах* Маркеры начала и конца директивы можно заменить другими — если, например, вы привыкли к TT, можно установить <tt><nowiki>[% %]</nowiki></tt>. Главное, чтобы маркер начала не был равен маркеру конца.* Маркеры подстановок можно тоже заменить на другие, либо отключить вовсе.
=== Функции Выражения ===
* Выражения состоят из переменных, операторов и вызовов функций и методов объектов* Синтаксис обращений к переменным JS-подобный: <tt>hash.key</tt>, <tt>array[0]</tt>, <tt>hash['key']</tt>* Имена переменных 'Операторов нет''регистрозависимы''', фильтров нетимена встроенных функций и названия директив (BEGIN, есть END и т. п.) — '''регистронезависимы'''* Никаких ошибок при обращениях к необъявленным переменным не происходит* Компилируемые функции: <tt>function(arg1, arg2, . Пример..)</tt> или <tt>function single_arg</tt> (через пробел с одним аргументом)* Функции, определённые через FUNCTION:<tt>fn_name('arg' => 'value', 'arg2' => 'value2', ...)</tt> или <tt>exec('fn_name', { 'arg' => 'value', 'arg2' => 'value2', ... })</tt>* Включение других шаблонов: <tt>INCLUDE 'template.tpl'</tt>, <tt>INCLUDE('template.tpl', { 'arg' => 'value', ... })</tt>* Выполнение функции из другого шаблона: <tt>exec_from('template.tpl', 'fn_name', { 'arg' => 'value', 'arg2' => 'value2', ... })</tt>* Методы объектов: <tt>var.method(arg1, arg2, ...)</tt>
<pre><!-- IF OR(function(block.key1),AND(block.key2,block.key3)) --></pre>=== Операторы ===
Почему? Тут всё просто — основываясь на предположенииВсе операторы, что длинные выражения в шаблонах нужны очень редкокроме сравнений, было лениво писать нормальную грамматику для разбора обычных выраженийлевоассоциативны. Почему они нужны редко? Да просто минимум логики в шаблонах — признак хороших шаблонов. А функции покрывают сразу и выражения, и «фильтры», и методы объектовСравнения — не ассоциативны.
Синтаксис вызова функции нескольких аргументов:<tab sep="bar" class="wikitable">a .. b | Конкатенацияa <html>||</html> b, a OR b | Логическое ИЛИ. JS- или Perl-подобное — возвращает первое истинное значение.a XOR b | XOR — логическое исключающее ИЛИa && b, a AND b | Логическое Иa & b | Побитовое Иa == b, a != b, a < b, a > b, a <= b, a >= b | Операторы сравненияa+b, a-b, a*b, a/b, a%b | Сложение, вычитание, умножение, деление, взятие остатка от деления!a, NOT a | Логическое НЕ(exp) | Выражение в скобках{ 'a' => 'b', … } | Создание хешрефа (Perl), ассоциативного массива (PHP)</tab>
<pre><!-- function(block.key, 0, "abc") --></pre>=== Директивы ===
Подстановка:<tab sep="bar" class="wikitable"><tt><!--# Комментарий --></tt> | Комментарий<tt><!-- FOR item = array --></tt><br />…код…<br /><tt><!-- END --></tt> | Цикл. Вместо FOR можно использовать слово FOREACH. Внутри цикла можно обратиться к счётчику через <tt>{item_index}</tt><tt><!-- IF выражение --></tt><br />…код… | Если (выражение)<tt><!-- ELSEIF выражение --></tt><br />…код… | Иначе если (выражение)<tt><!-- ELSE --></tt><br />…код… | Иначе<tt><!-- END --></tt> | Конец если / цикла / присваивания<tt><!-- SET var = выражение --></tt> | Присваивание переменной var результата выполнения выражения<tt><!-- SET var --></tt><br />…код…<br /><tt><!-- END --></tt> | Присваивание переменной var результата выполнения кода<tt><!-- FUNCTION name (arg1, arg2) = выражение --></tt> | Определение функции шаблона как результата выполнения выражения<tt><!-- FUNCTION name (arg1, arg2) --></tt><br />…код…<br /><tt><!-- END --></tt> | Определение функции / «блока» шаблона. Вместо FUNCTION можно использовать также слова BLOCK или MACRO</tab>
<pre>{function(block.key, 0, "abc")}</pre>=== Функции ===
Синтаксис вызова функции одного аргументафункций:* <tt>ФУНКЦИЯ(АРГУМЕНТ, АРГУМЕНТ, ...)</tt>* <tt>ФУНКЦИЯ <пробел> ОДИН_АРГУМЕНТ</tt>
<pre><!-- function(blockСуществующие функции перечислены ниже.key) --><!-- function blockЧерез «=» в подзаголовках указываются синонимы функций.key -->{block.key/s}{s block.key}</pre>
Синтаксис вызова метода объектаРасширяемость в области функций:
<pre>{object.method()}{object.method(arg1, arg2)}{call(object, "method")}{call(object, "method", array(arg1, arg2))}</pre> Последние два применения — как нетрудно заметить, обращение к ;Run-time функции call() и служат для вызова метода по вычисляемому имени. Цепочки вызовов методов типа <tt>object.method().another_method()</tt> не поддерживаются, ибо к ним без сохранения звеньев нервно относится даже сам PHP. === IF === Условный вывод: <pre><!-- IF function(blockВ качестве функции можно использовать метод переданного в хеше данных объекта.key) --><!-- ELSEIF ... --><!-- END --><!-- IF NOT block.key -->...<!-- END --> </pre> ELSIF эквивалентно ELSE IF В «функцию» можно вынести и ELSEIFблок кода из шаблона — см. === SET === Запись значения переменной: <pre><!-- SET block[[#Блоки]].key -->Оно хорошо кэшируется...<!-- END --></nowiki><!;Compile-- SET block.key = выражение --></pre> === Включения === Включение другого шаблона также осталосьtime функции: <pre><!-- INCLUDE another-file.tpl --><!-- INCLUDE "another-file.tpl" --></pre> По «динамическому» имени При создании объекта шаблона включение производится функцией можно передать параметр <tt>[[#INCLUDE=PROCESS=PARSE|INCLUDE]]compiletime_functions</tt>. Как несложно заметить, вторая строка — как раз вызов функции. === Блоки === Блок — это часть шаблонаравный хешу, выделенная в отдельную «функцию»котором ключи — имена дополнительных функций, хорошо кэшируемая и предназначенная для повторного вызова из других места значения — любые coderef’ы (Perl) или callable (PHP). Покрывает сразу несколько вещей — «блоки», «макросы» и «обёртки» из TT. Да-да, TT славится бессмысленным дублированием функционала. Но имеет несколько преимуществ:* блоки, определённые Эти функции вызываются в одном шаблоне, можно смело вызывать из других по имени файла + имени блока!* блок можно определить просто как некоторое выражение.* блоки хорошо кэшируются — контексте объекта шаблона с VMX::Template вы не испытаете разочарованияпараметрами, если вызовете какой-нибудь блок 1000 раз. В отличие от TT. Блоки в шаблоне не могут быть вложеннымиравными '''коду для вычисления соответствующего аргумента''', а циклы, SET и прочие вещидолжны возвращать '''код для вычисления результата'''. То есть, их оборачивающие, не имеют они выполняются на них никакого влияния. После этапе компиляции блоки просто вырезаются и преобразуются в отдельные функции PHP/Perl’а. <pre><!-- BLOCK имя_блока -->...код...<!-- END --></pre> или <pre><!-- BLOCK имя_блока = выражение --></pre> Вместо слова <tt>BLOCK</tt> можно также использовать слово <tt>FUNCTION</tt> или <tt>MACRO</tt>. Вызывать блок из шаблона следует с помощью функции [[#INCLUDE=PROCESS=PARSE|PROCESS]]. Вызывать блок из кода следует, передавая после имени файла шаблона имя блока. См. [[#Использование (PHP)]]. == Функции ==
{{note}} Первое, что обычно нужно — это S(), H(), T(), Q(), I(), то есть «фильтры» для различных преобразований строки:
* H() — удаляет все HTML-теги, кроме «безопасных».
* T() — удаляет все HTML-теги.
* Q() — это addslashes(), экранирует символы строки для использования, например, в JS.
* I() — преобразует значение к целому числу.
Расширяемость в области функций:==== HTML-безопасный режим ====
;Run-time функции: В качестве функции можно Если вы хотите использовать метод переданного в хеше данных объекта. В «функцию» можно вынести и блок кода из шаблона — см. [[#Блоки]]. Оно хорошо кэшируется.;Compile«HTML-time функции: При создании объекта шаблона можно передать параметр <tt>compiletime_functions</tt>, равный хешу, в котором ключи — имена дополнительных функций, а значения — любые coderef’ы (Perl) или callable (PHP). Эти функции вызываются в контексте объекта шаблона безопасный» режим с параметрами, равными автоматическим экранированием — установите опцию '''коду для вычисления соответствующего аргументаauto_escape'''равной, и должны возвращать '''код для вычисления результата'''например, как раз «s». То естьСмысл режима в том, они выполняются на этапе компиляции.чтобы:* Не экранировать все значения руками* Случайно не забыть что-то экранировать, экранируя это руками
=== ЧислаРаботает так: если какое-то подставляемое значение не экранировано вами явно через одну из функций вроде перечисленных выше (s/t/h/i и т. п.), логические операции ===то оно будет экранировано функцией, заданной в auto_escape. Получается «авто-защита» от атак типа XSS. Значения, которые надо подставить «как есть», нужно предварить вызовом функции RAW: {raw value}. Тогда значение auto_escape’ом экранировано не будет.
==== ORНа заметку: для удобства функции JSON, ANDQUOTE, NOT ====SQL_QUOTE и REQUOTE считаются «безопасными», хотя таковыми, строго говоря, не являются. Однако используются они обычно внутри JS-кода, поэтому лучше их вывод не трогать.
Логические ИЛИ, И, НЕ, действующие аналогично Perl операторам ||, &&, !. ==== ADDЧисла, SUB, MUL, DIV, MOD логические операции ==== Арифметические операции + — * / %.
==== LOG ====
Преобразование к целому числу.
==== EQ, NE, GT, LT, GE, LE ====
Сравнения == != > < >= <= аргументов как строк (Perl) или типо-зависимое сравнение (PHP). В PHP если хотя бы один из аргументов численный, сравниваются они как числа.
==== SEQ, SNE, SGT, SLT, SGE, SLE ====
Аргументы сравниваются всегда как строкиСтроковые сравнения.
==== NEQ, NNE, NGT, NLT, NGE, NLE ====
Аргументы сравниваются всегда как числаЧисленные сравнения.
==== YESNO ====
Тернарный YESNO($1, $2, $3) — тернарный оператор ($1 ? $2 : $3).
=== Строки ===
Нижний и верхний регистр.
==== Q=QUOTE=ADDSLASHESLCFIRST, SQ=SQL_QUOTE, REQUOTE=RE_QUOTE=PREG_QUOTE UCFIRST ====
Экранирование символов " ' \ и перевода Преобразование первого символа строки бэкслэшем — quote(строка)в нижний и верхний регистр соответственно.
Экранирование символа " удвоением - sql_quote(строка). (актуально также для [[rupedia:CSV|CSV]])==== Q=QUOTE=ADDSLASHES, SQ=SQL_QUOTE, REQUOTE=RE_QUOTE=PREG_QUOTE ====
* Экранирование символов " ' \ и перевода строки бэкслэшем — quote(строка).* Экранирование символа " удвоением — sql_quote(строка). (актуально также для [[rupedia:CSV|CSV]])* Экранирование символов, являющихся специальными в регулярных выражениях — re_quote(строка). (см. [http://perldoc.perl.org/perlre.html perldoc perlre]).
==== URI_QUOTE=URIQUOTE=URLENCODE ====
URL-кодирование строки ({{CPAN|URI::Escape}} в Perl и [http://php.net/manual/en/function.urlencode.php urlencode()] в PHP).
==== REPLACE, STR_REPLACE ====
* Замена Perl- (соответственно PCRE- в PHP-версии) регулярного выражения в строке — replace(RegExp, замена, строка). * Замена подстроки в строке - строке — str_replace(искомое, замена, строка).
==== STRLEN ====
==== S=HTML=HTMLSPECIALCHARS, T=STRIP, H=STRIP_UNSAFE, NL2BR ====
* Преобразование символов < > & " ' в HTML-сущности. * Удаление всех [[lib:HTML|HTML]]/[[lib:XML|XML]] тегов. * Удаление только «небезопасных» HTML-тегов. * Преобразование переводов строк (\n) в HTML-тег <tt><nowiki><br /></nowiki></tt>.
==== CONCAT, JOIN=IMPLODE ====
* Конкатенация всех своих аргументов — concat(аргументы). Конкатенирует также все элементы всех переданных массивов. * Конкатенация элементов массива через разделитель — join(строка, аргументы). Конкатенирует также все элементы всех переданных массивов.
==== SUBST, SPRINTF, STRFTIME ====
Подстановка Subst — подстановка на места подстрок вида $ЧИСЛО соответствующих параметров функции или элементов переданного массива — subst(строка, $1, $2, …).
Sprintf — он и в Африке [http://perldoc.perl.org/functions/sprintf.html sprintf].
* RFC 822.
==== STRLIMIT =TRUNCATE ==== Ограничение длины строки <tt>str</tt> максимальной длиной <tt>len</tt> — <tt>strlimit(str, len, dots = "...")</tt>. Если строка превышает заданную длину, она обрезается предпочтительно по пробелу или Tab’у, а в конец добавляется <tt>dots</tt> или по умолчанию <tt>"..."</tt>, если аргумент <tt>dots</tt> не передаётся. ==== PLURAL_RU ==== Выбор правильного окончания в русском языке в зависимости от количества: <tt>plural_ru(число, один, несколько, много)</tt>. Например (1 шаблон, 2-3-4-102 шаблонА, 5-6-15-… шаблонОВ):
Ограничение длины строки s максимальной длиной l — strlimit<tt><nowiki>{num} шаблон{plural_ru(snum, l). Если строка превышает заданную длину'', она обрезается предпочтительно по пробелу или Tab’у'а', а в конец добавляется «…» (троеточие'ов').}</nowiki></tt>
=== Массивы и хеши ===
Создание хэша из всех аргументов.
Соответственно в хеше аргументы идут парами КЛЮЧ, => ЗНАЧЕНИЕ, КЛЮЧ, => ЗНАЧЕНИЕ и т. п. (специального синтаксиса «=>» нет).
==== KEYS, HASH_KEYS, ARRAY_KEYS ====
Сортировка массива по значениям.
==== EACH PAIRS ====
Массив хэшей вида <tt>{ id key => ключ, name value => значение }</tt> для хэша, в случае Perl ключи будут отсортированы по имени.
==== ARRAY, RANGE ====
* Создание массива. * Диапазон от A до B — range(A, B).
==== IS_ARRAY ====
==== COUNT, SUBARRAY=ARRAY_SLICE, SUBARRAY_DIVMOD ====
* Количество элементов массива, или 0, если аргумент — не массив — count(аргумент).* Аналог функции [http://php.net/manual/en/function.array-slice.php array_slice] из PHP.* Выбор из массива каждого div’того элемента, начиная с номера mod или нуля по умолчанию — subarray_divmod(массив, div, mod).
Аналог функции [http://php.net/manual/en/function.array-slice.php array_slice] из PHP.==== GET ====
Выбор из массива каждого div’того элемента, начиная с номера mod или нуля по умолчанию — subarray_divmod<tt>GET(массив, div, modчто)</tt> — получение значения переменной верхнего уровня.
==== GET, AGET, HGET SET ====
Получение элемента массива/хэша по «динамическому» ключу. По-моему, это лучше, чем зюки-хрюки Template Toolkit’а: <tt>hash.${hash2.$key}</tt> и т. п. <tt>GETSET(откудакуда, что)</tt> автоматически — присваивание «куда» значения «что». Уравнения, понятное дело, не решает, «откуда» — это массив или хешто есть, AGET служит только для массивовкак и обычно, а HGET присваивать можно только для хешей. В PHP-версии все три идентичны. <tt>GET(чтоlvalue :)</tt> — получение значения переменной верхнего уровня.
==== ARRAY_MERGE ====
==== SHIFT, POP, UNSHIFT, PUSH ====
* Вынуть элемент из начала массива, вынуть массива — <tt>shift(array)</tt>* Вынуть из конца, добавить конца — <tt>pop(array)</tt>* Добавить в начало — <tt>unshift(array, value)</tt>, добавить * Добавить в конец — <tt>push(array, value)</tt>. === Включения === Сюда относятся функции выполнения других шаблонов и/или их блоков. Во все эти функции можно передавать «данные» (tpldata) либо с помощью создания хеша функцией hash(), либо просто передачей аргументов как <tt>КЛЮЧ => ЗНАЧЕНИЕ, ...</tt>. ==== PARSE=INCLUDE=PROCESS ==== Включение другого шаблона. <pre>parse('имя файла')parse('имя файла', hash( ключ => значение, ... ))parse('имя файла', ключ => значение, ...)</pre> ==== PARSE_INLINE=INCLUDE_INLINE=PROCESS_INLINE ==== Включение кода не из файла, а просто из строки — <tt>parse_inline('код шаблона'[, аргументы])</tt>. ==== EXEC ==== Включение блока из текущего шаблона — <tt>exec('имя блока'[, аргументы])</tt>. ==== EXEC_FROM ==== Включение блока из другого шаблона — <tt>exec_from('имя файла', 'имя блока'[, аргументы])</tt>. ==== EXEC_FROM_INLINE ==== Ещё больше не рекомендуется, но можно вызывать и функции из кода из строки — <tt>exec_from_inline('код шаблона', 'имя блока'[, аргументы])</tt>. === Прочее ===
==== VOID ====
Вычислить аргумент и вернуть пустую строку. Потенциально нужно для игнорирования результата, ибо все возвращаемые значения радостно подставляются в выходной поток.
==== RAW ====
Пустое преобразование первого аргумента со снятием флага «небезопасности». Нужно для подстановки значений «как есть» в HTML-безопасном режиме авто-экранирования.
==== DUMP=VAR_DUMP ====
Форматирование любой структуры данных в формат JSON.
==== INCLUDE=PROCESS=PARSE CALL ====
Включение другого шаблона или выполнение блокаВызов метода объекта по «динамическому» имени — <tt>call(varref, method_name, arg1, arg2, arg3, ...)</tt>.
<pre>process('имя файла')process('имя файла', 'имя блока')process('имя файла', 'имя блока', hash( аргументы ))process('::имя блока в текущем шаблоне' [, hash(аргументы)])</pre>==== MAP ====
Не рекомендуетсяПрименение функции, но возможно также имя которой передано как первый аргумент, ко всем переданным аргументам и передавать код вместо имени файла:элементам всех переданных массивов — map(«имя_функции», аргументы).
<pre>process('', 'код шаблона' [, 'функция'] [, hash( аргументы )])</pre>== Изменения относительно старых версий ==
==== CALL ====* Ликвидированы assign_vars(), assign_block_vars(), tr_assign_vars() — теперь, как и обычно, передаётся просто хеш с данными $vars* Синтаксис типа {a->key} ликвидирован* Авто-переводы, которые были в перловой версии — тоже тю-тю (хотя, может, и будут возрождены)* SET теперь заканчивается обычным END, а не ENDSET* Обращение к счётчику цикла теперь {block_index}, а не {block.#}* Добавлены функции, операторы* Добавлены детальные сообщения об ошибках* Добавлен встроенный фильтр для ликвидации пробелов из начал/концов каждой строки шаблона
Вызов метода объекта по «динамическому» имени — <tt>call(varref, method_name, arg1, arg2, arg3, ...)</tt>.== Различия PHP и Perl версий ==
==== MAP Кэширование работает по-разному ====
Применение В целом, общий смысл — сделать так, чтобы шаблоны было не стыдно вызывать много раз, как много раз за один запрос, так и в целом, при этом максимально использовать механизмы интерпретатора самого языка. Но механизмы для этого применяются разные. Основная причина различий следующая: * Perl: считается, что всё прогрессивное человечество уже давно использует <tt>mod_perl</tt> или [[Платформы для запуска Perl веб-приложений|другие способы запуска веб-приложений]], при которых частых переинициализаций интерпретатора не происходит. Иными словами, ''никто больше не использует CGI''. Таким образом, мы легко можем сохранить живой coderef (ссылку на функцию, или кому как больше нравится — анонимную функцию, замыкание, делегат) в промежутке между двумя запросами. Так и живём — скомпилированный шаблон представляет собой просто хеш с набором анонимных функций, которые сохраняются в ''экземпляре объекта VMXTemplate'' и вызываются при обращении к шаблону или его блокам. Также существует и файловый кэш компилированного кода. '''Важное следствие:''' объект VMXTemplate между запросами нужно оставлять живым. Если его убить — кэш полностью очищается.* PHP: интерпретатор PHP всегда инициализируется заново при обработке каждого HTTP-запроса, а живой coderef в промежутке между двумя инициализациями интерпретатора сохранить, видимо, невозможно. Однако предполагается, что всё прогрессивное человечество давно использует APC/XCache/ZendOpCache/eAccelerator, и поэтому, когда текст шаблонов компилируется в файлы, а файлы подгружаются путём require, на самом деле они загружаются не с диска, а из памяти кэшера, причём — в уже скомпилированном виде. Кроме того, так как скомпилированный шаблон представляет собой класс — в рамках одного запроса он загружается максимум 1 раз, последующие вызовы происходят уже очень быстро. Ну и на всякий пожарный — хотя это, возможно, уже особого выигрыша и не даёт — нескомпилированный текст шаблонов тоже кэшируется в кэше переменных APC/XCache/eAccelerator, если таковой присутствует, и не перезагружается с диска лишний раз. Если <tt>reload = false</tt>, лишними считаются все разы, кроме первого, даже если файл шаблона менялся. В Perl действие <tt>reload</tt> немного отличается — <tt>reload = 0</tt> работает так же, как <tt>reload = false</tt> в PHP, но если <tt>reload > 0</tt>, то тексты шаблонов всё-таки перезагружаются с диска при изменении, но не чаще, чем раз в <tt>reload</tt> секунд. В PHP также есть ещё одна проблема — в процессе выполнения невозможно добавить метод в класс без использования извращений типа [http://pecl.php.net/package/classkit classkit], а хочется, потому что сгенерированные из кода шаблона функции должны быть методами — они дёргают разные функцииот $this, подразумевая, что это объект класса VMXTemplate. Поэтому компилированный шаблон PHP-версии — это класс, производный от класса VMXTemplate. Как уже сказано выше, единожды за один HTTP-запрос он загружается в память, а при каждом вызове шаблона создаётся пустой объект этого класса, в него записывается ссылка на <tt>tpldata</tt> и поле <tt>parent</tt>, ссылающееся на родительский объект Template, и вызывается метод класса, соответствующий функции шаблона (<!-- FUNCTION … -->). ==== Несколько различается действие <tt>use_utf8 = true</tt> ==== * Общий смысл — «мои шаблоны и страницы в кодировке UTF-8».* PHP: «использовать mb_str* функции для работы со строками в выражениях».* Perl: «я передаю в шаблон все переменные с флагом UTF-8 = On, их можно смело конкатенировать с UTF-ными частями шаблона». Если кто-то не знает, в Perl строки имеют на себе флаг UTF-8 = да или нет, и при конкатенации строки без флага со строкой с флагом строка без флага будет автоматически переведена в UTF-8 из кодировки, соответствующей текущей локали. Что означает двойное UTF-8-кодирование в случае, если строка на самом деле всё-таки в UTF-8, но просто на ней не установлен флаг.*: Для приведения всех переменных шаблона к UTF-8 можно использовать функцию <tt>utf8on()</tt> из <tt>VMXTemplate::Utils</tt> (рекурсивный <tt>Encode::_utf8_on()</tt>). ==== Различается способ вывода ошибок при <tt>print_error = true</tt> ==== * Общий смысл — при <tt>print_error = true</tt> ошибки и предупреждения должны попасть на экран.* PHP: ошибки группируются и выводятся в отдельном div’е в конце страницы, либо просто print’ами по месту возникновения при вызове из консоли.* Perl: текст ошибок прицепляется к выводу шаблонизатора (возвращается вместе с результатом <tt>parse()</tt>). ==== Различается поведение сравнений ==== * PHP: Тип обычных операторов сравнения определяется во время выполнения. То есть, если во время выполнения одно из сравниваемых значений — число, они сравниваются как числа, иначе — как строки.* Perl: Тип обычных операторов сравнения определяется ''во время компиляции''. То есть, если из контекста понятно, что одно из сравниваемых значений — число (если это константа или результат, например, функции count), сравнение будет численным, иначе — строковым.* Пустые массивы и хеши ложны в PHP и истинны в Perl. То есть простая проверка «IF array» (приведение к булеву типу), если array пуст, в PHP вернёт false, а в Perl — true. ==== Различается поведение некоторых функций работы с массивами и хешами ==== * KEYS — в PHP порядок ключей массива/хеша сохраняется, а в Perl — нет и принимаются только хеши. Обусловлено реализацией хешей в этих языках.* PAIRS — в PHP порядок ключей сохраняется, в Perl-версии ключи будут отсортированы по имени.* RANGE — в Perl-версии принимает буквенные аргументы (A..Z = весь алфавит).* IS_ARRAY — в PHP-версии не проверяется, а не является ли он при этом хэшем, ибо трудоёмко (надо проверить, численные ли все ключи).* AGET и HGET в PHP идентичны GET.* ARRAY_MERGE: под Perl — только массивы (не хеши), под PHP — любые массивы.* DUMP — это Dumper в Perl’е и var_dump в PHP. ==== Строка исходного файла ==== В PHP-версии в шаблоны не включаются C-подобные «прагмы» #line, а в текст ошибок не включается имя файла шаблона и строка. Ибо решил — раз уж #line не поддерживается, нечего на строки заморачиваться. == А кстати, зачем вообще нужен шаблонизатор? == Ответы:* Чтобы структурировать код, осознанно используя для генерации HTML-ек язык с ограниченными возможностями. Так как возможности ограничены, сложные вычисления писать на нём автоматически не хочется, соответственно, они перемещаются в логику, разделение становится более явным.* Чтобы структурировать выполнение — сначала логика, потом HTML. В идеале «обратной связи» из шаблонов в логику быть не должно, то есть шаблону должно передаваться ровно столько данных, сколько ему нужно, чтобы в процессе выполнения он ничего не дочитывал. Это приблизительно называется MVP (Model-View-Presenter; View имеет связь с моделью только через Presenter) и сразу же ликвидирует:** Трудноуловимые проблемы производительности, происходящие по вине ленивых вычислений и вызовов методов модели, дочитывающих данные из БД, из view.** Проблемы с преждевременной отправкой HTTP-заголовков, после которой передано внезапно обнаруживается, что, оказывается, нужно было сделать редирект.* Второй вариант — классический MVC, шаблон — это View (представление), во View передаётся модель, и View отображает состояние модели так, как первый аргументему хочется. То есть, ко всем переданным аргументам шаблон общается напрямую с живыми объектами модели, которые ему передают, «обратная связь» присутствует.*: {{Warning}} Важное ИМХО! Частая проблема классического подхода — по 100 запросов для чтения одного и элементам того же свойства при отображении 100 объектов выборки, вместо того, чтобы прочитать это свойство за 1 запрос сразу для всех переданных массивов — map100 объектов. Чтобы такого не было — нужно, чтобы объекты помнили, частью какой коллекции они являются, и при чтении свойства читали его сразу для всех объектов «своей» коллекции. Идея основана на предположении, что если у объекта, прочитанного из БД как часть большой выборки, запрашивается какое-то свойство — велика вероятность того, что это же свойство будет запрошено и у всех остальных объектов той же самой выборки. При такой реализации — и писать удобно («имя_функции»не нужно заморачиваться, аргументычто передавать в шаблон, а что нет), и производительность не страдает. Примечание: так как PHP — «язык наизнанку», сам немножко являющийся шаблонизатором, то при выполнении следующих требований можно писать и без шаблонизатора:* ''Руками'' писать в «шаблонном стиле»:*# Не смешивать сложные конструкции с HTML.*# Шаблоны выносить в отдельные функции и общаться с ними через 1 ассоциативный массив с данными.*# Вывод не печатать, а буферизовать (ob_start() → ob_get_contents() → ob_end_clean()) и возвращать.* Использовать читаемый стиль кода (?> и <?php только в конце строк, отступы насквозь через PHP и HTML).Это бывает весьма полезно, если нужно написать модуль к системе, которая сама написана без шаблонизатора или с каким-нибудь полу-кривым собственным, и не хочется вводить дополнительную зависимость.
[[Категория:Sway]][[Категория:РазработкаТехактивы]]
[[Категория:Perl]]
[[Категория:PHP]]