Изменения

Шаблонизатор VMX::Template

36 988 байтов добавлено, 20:43, 27 июля 2018
Нет описания правки
Данный модуль представляет собой новую версию '''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.
Развивается то одна, то другая, в зависимости от проекта, над которым я работаю в моменте.== Что это за шаблонизатор? ==
<span style="border: 2px #FF8000 dashed; padding: 4px">Про '''VMX::Template можно сказать «ох уж эти перлисты — что ни пишут, всё Template::Toolkit получается».<''' изначально реализован по мотивам примитивного шаблонизатора, взятого из кода форума phpBB 2 ([[/span> Это к томуСтарая версия|историческое описание старой версии]]), что идея вообще-то схожая, но реализация гораздо проще и быстрее.с тех пор (с 2006 года) переписанного 4 раза:# На регулярные выражения &rarr;# На поиск подстроки &rarr;# На метод рекурсивного спуска &rarr;# И, наконец, на LALR(1) грамматику на основе генератора парсеров LIME
== Идеи ==Есть PHP и Perl версии шаблонизатора, основная версия шаблонизатора — в данный момент PHP. Есть некоторые различия реализации — например, в Perl’е для кэширования кода используются coderef’ы, а в PHP предполагается, что кэшированием занимается какой-нибудь [http://xcache.lighttpd.net/ XCache] или [http://eaccelerator.net/ eAccelerator], ибо там сохранить coderef между запросами невозможно.
Уйти от assign_vars()<span style="border: 2px #FF8000 dashed; padding: 4px">Про VMX::Template можно сказать «ох уж эти перлисты — что ни пишут, assign_block_vars(). Передавать, как и в обычных движках, просто хеш с данными $vars. Как, например, в всё Template::Toolkitполучается». При этом сохранить данные методы для совместимости.</span>
Почистить синтаксис: ликвидировать «преобразования»Это к тому, «вложенный путь по переменной» (->key->index->key->и т. п.)что и идея, специальный и синтаксис для окончания SET, неочевидное обращение к счётчику block.#шаблонов вообще-то схожи, tr_assign_* и т. пно сама реализация гораздо проще и быстрее.
Переписать с нуля компилятор.== Использование ==
Добавить в употребление функции, но только самые необходимые.=== PHP ===
Добавить обработку ошибок и диагностические сообщенияТребуется PHP версии не ниже 5.4.
== Реализация ==<code-php>require_once 'template.php';
Маркеры начала и конца # Конструктор (значения опций - по умолчанию)$template = new VMXTemplate(array( 'root' => '.', # директория с шаблонами 'cache_dir' => './cache', # директория для кэширования компилированного кода <ttшаблонов 'print_error' =><nowikifalse, # если true, ошибки компиляции выводятся на STDOUT 'raise_error' =>false, # если true, при ошибке компиляции вызывается die() 'log_error' => false, # если true, ошибки компиляции логгируются через error_log() 'reload' => true, # если false, шаблоны будут считываться с диска только 1 раз, и вызовов stat() происходить не будет 'use_utf8' => true, # если true, использовать кодировку UTF-8 для строковых операций 'begin_code' => '<!-- ', # маркер начала директивы кода 'end_code' => '--></nowiki', # маркер конца директивы кода 'eat_code_line' =></tttrue, # (похоже на TT CHOMP) съедать "лишний" перевод строки, если в строке только директива? 'begin_subst' => и '{', # маркер начала подстановки <tt><nowiki>выражения (либо { , либо false) 'end_subst' => '}</nowiki', # маркер конца подстановки выражения (либо }, либо false) 'compiletime_functions' =></tt # дополнительные компилируемые функции array('func' => могут быть заменены любыми другими. Еслиcallback), например# хеш вида имя функции (в шаблонах) => callback($template, вы привыкли к TTarray $args), можно установить <tt # которому передаются скомпилированные выражения всех аргументов 'strip_space' =><nowikitrue, # встроенный фильтр: срезание пробелов из начал и концов строк 'filters' =>[% %]</nowiki></tt>. Маркеры подстановки можно вообще убрать # фильтры - выполняются над выводом всех шаблонов array(callback1, ибо подстановка тоже является кодом...), 'auto_escape' => false, # функция авто-экранирования, например "s" (для HTML-безопасного режима)));
Путь к # Присвоение одной переменной теперь может включать в себя числа. Это будут обращения к элементам массивов:$template->vars("ключ", в то время как всё остальное — обращения к элементам хешей."значение");
Вне блока {block} будет иметь значение ARRAY# Присвоение кучи переменных:$template->vars(0x…), то есть массив всех итераций блока blockarray("ключ" => "значение", а {block.0} будет иметь значение HASH..)); # Выполнение шаблона и получение результата:# (0x…возможно с передачей данных в шаблон)$page = $template->parse('имя_файла.tpl' [, array("ключ" => "значение", то есть первую итерацию блока block...)]);
<pre# Выполнение именованного блока из файла:$page = $template-><!-- BEGIN block -exec_from('имя_файла.tpl', 'имя_блока' [, array("ключ" => "значение", ...)]); # Выполнение кода из строки:$page = $template-></preparse_inline('код' [, array("ключ" =>"значение", ...)]);
Теперь, внутри # Выполнение именованного блока {block} теперь будет иметь значение HASHиз кода (0x…не рекомендуется, но возможно):$page = $template->exec_from_inline('код', то есть уже 'имя_блока' [, array("ключ" => "значение текущей итерации блока block", а {block.#} будет иметь значением номер текущей итерации блока, отсчитываемый с 0, а не с 1, как в старой версии..)]); # Очистка сохранённых данных для генерации ещё одной страницы:$template->clear;</code-php>
<pre><!-- END block --></pre>=== Perl ===
На <nowiki><!-- END другоеимя --></nowiki> после <nowiki><!-- BEGIN block --></nowiki> шаблонизатор выдаст ошибку, «ибо нефиг» (c). Если block Perl версия обновлена и теперь в хеше данных — не массив, а хеш — это значит, что итерация у блока только одна, и тогда <nowiki><!точности соответствует PHP-- BEGIN block --></nowiki> работает как for($expression) {} в Perlверсии.
<ttsource lang="perl">BEGIN ... END</tt> — это циклы в «старом стиле». А можно использовать и TT-подобный:use VMXTemplate;
<pre# Конструктор$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' => '<!-- FOR var ', # маркер начала директивы кода 'end_code' = block > '-->', # маркер конца директивы кода 'begin_subst' => '{', # маркер начала подстановки выражения 'end_subst' => '}', # маркер конца подстановки выражения 'eat_code_line' => 1, # (похоже на TT CHOMP) если TRUE, съедать "лишний" перевод строки, если в строке только директива кода (begin_code..end_code) 'no_code_subst' => 1, # если TRUE, выполнять директивы кода (begin_code..end_code), но игнорировать их результат<!-- END 'compiletime_functions' => # дополнительные компилируемые функции { 'func' => sub {} }, # хеш вида имя функции (в шаблонах) => coderef, # которому передаются скомпилированные выражения всех аргументов и первым -парсер (объект VMXTemplate::Parser) 'filters' => [ sub {}, .. ], # фильтры для запуска на выводе каждого внешнего шаблона (фильтр -функция, модифицирующая $_[0]) 'strip_space' =>0, # если TRUE, удалять пробелы и табы из начала и конца всех строк вывода</pre 'auto_escape' =>'', # функция авто-экранирования, например "s" (для HTML-безопасного режима));
Причём, <tt$template->vars({ var</tt> может быть само <tt>block</tt=>'омvalue', . Это, по сути, и есть то, что делает BEGIN: <!-- BEGIN block --> эквивалентно <!-- FOR block = block -->. Предыдущее значение переменной цикла после выхода из цикла всегда восстанавливается.});
К номеру итерации можно обратиться через # Выполнения полностью аналогичны PHP:$page = $template->parse('имя_файла.tpl'[, { "ключ" => "значение", ... }]);$page = $template->exec_from('<ttимя_файла.tpl', 'имя_блока' [, { "ключ" =>"значение", ... }]);$page = $template->parse_inline('код' [, {var#"ключ" => "значение", ... }</tt]);$page = $template->exec_from_inline('код', 'имя_блока' [, { "ключ" => "значение", ... }]);
'''Операторов нет''', но есть функции. Пример# Очистка сохранённых данных для генерации ещё одной страницы:$template->clear;</source>
<pre><!-- IF OR(function(block.key1),AND(block.key2,block.key3)) --></pre>== Синтаксис шаблонов ==
Синтаксис вызова функции нескольких аргументов:Шаблон — любой текст (типично — HTML), в который ''местами'' включены директивы и/или подстановки.
<pre><!Если вы знаете о порождающих грамматиках, то вот контекстно-- functionсвободная грамматика для LALR(block.key, 0, "abc"1) --></pre>алгоритма разбора:
Подстановка* Голая Bison-грамматика, для получения представления о синтаксисе:http://yourcmc.ru/git/vitalif/VMXTemplate/raw/master/template.y* Рабочая [http://github.com/vitalif/lime LIME]-грамматика: http://yourcmc.ru/git/vitalif/VMXTemplate/raw/master/template.lime (для её работы нужен патченый LIME — см. https://github.com/vitalif/lime)* Рабочая {{CPAN|Parse::Yapp}}-грамматика: http://yourcmc.ru/git/vitalif/VMXTemplate/raw/master/template.yp
<pre>{function(block.key, 0, "abc")}</pre> Синтаксис вызова функции одного аргумента:=== Пример ===
<pre>
<!-- function(blockSET title --> Статистика<!-- END --><!-- SET headscripts --> <script language="javascript" type="text/javascript" src="{DOMAIN}/tpldata/jquery.key) min.js"></script><!-- END --><!-- function blockINCLUDE "admin_header.key tpl" -->{block<!-- IF NOT srcid --> <p>Добро пожаловать в простую OLAPообразную статистику.keyВыберите источник данных:</p> <form action="?" method="GET"> <select style="width:100px" name="datasource"> <!-- FOR s}= sources --> <option value="{s blocks.keyid}">{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>
Условный вывод:=== Маркеры ===
* <prett><!-- IF function(block.key) --nowiki>'<!-- ELSEIF ... ', '-->'<!-- END --/nowiki></tt> — маркеры начала и конца директивы* <!-- tt><nowiki>'{', '}'</nowiki></tt> — маркеры начала и конца подстановки выражения (между скобками не может быть инструкций типа IF NOT block.key -->./ELSE и т. п.)* Подстановки можно использовать и в директивах* Маркеры начала и конца директивы можно заменить другими — если, например, вы привыкли к TT, можно установить <!-- END --tt> <nowiki>[% %]</prenowiki></tt>. Главное, чтобы маркер начала не был равен маркеру конца.* Маркеры подстановок можно тоже заменить на другие, либо отключить вовсе.
ELSIF эквивалентно ELSE IF и ELSEIF.=== Выражения ===
Запись значения переменной* Выражения состоят из переменных, операторов и вызовов функций и методов объектов* Синтаксис обращений к переменным 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><!-- SET block.key -->...<!-- END --></nowiki><!-- SET block.key = выражение --></pre>== Операторы ===
Все операторы, кроме сравнений, левоассоциативны. Сравнения — не ассоциативны. <tab sep="bar" class="wikitable">a .. b | Конкатенацияa <html>&#x7C;&#x7C;</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> === Директивы === <tab sep="bar" class="wikitable"><tt>&lt;!--# Комментарий --&gt;</tt> | Комментарий<tt>&lt;!-- FOR item = array --&gt;</tt><br />…код…<br /><tt>&lt;!-- END --&gt;</tt> | Цикл. Вместо FOR можно использовать слово FOREACH. Внутри цикла можно обратиться к счётчику через <tt>{item_index}</tt><tt>&lt;!-- IF выражение --&gt;</tt><br />…код… | Если (выражение)<tt>&lt;!-- ELSEIF выражение --&gt;</tt><br />…код… | Иначе если (выражение)<tt>&lt;!-- ELSE --&gt;</tt><br />…код… | Иначе<tt>&lt;!-- END --&gt;</tt> | Конец если / цикла / присваивания<tt>&lt;!-- SET var = выражение --&gt;</tt> | Присваивание переменной var результата выполнения выражения<tt>&lt;!-- SET var --&gt;</tt><br />…код…<br /><tt>&lt;!-- END --&gt;</tt> | Присваивание переменной var результата выполнения кода<tt>&lt;!-- FUNCTION name (arg1, arg2) = выражение --&gt;</tt> | Определение функции шаблона как результата выполнения выражения<tt>&lt;!-- FUNCTION name (arg1, arg2) --&gt;</tt><br />…код…<br /><tt>&lt;!-- END --&gt;</tt> | Определение функции / «блока» шаблона. Вместо FUNCTION можно использовать также слова BLOCK или MACRO</tab> === Функции === Синтаксис вызова функций:* <tt>ФУНКЦИЯ(АРГУМЕНТ, АРГУМЕНТ, ...)</tt>* <tt>ФУНКЦИЯ <пробел> ОДИН_АРГУМЕНТ</tt> Существующие функции перечислены ниже. Через «=» в подзаголовках указываются синонимы функций. Расширяемость в области функций: ;Run-time функции: В качестве функции можно использовать метод переданного в хеше данных объекта. В «функцию» можно вынести и блок кода из шаблона — см. [[#Блоки]]. Оно хорошо кэшируется.;Compile-time функции: При создании объекта шаблона можно передать параметр <tt>compiletime_functions</tt>, равный хешу, в котором ключи — имена дополнительных функций, а значения — любые coderef’ы (Perl) или callable (PHP). Эти функции вызываются в контексте объекта шаблона с параметрами, равными '''коду для вычисления соответствующего аргумента''', и должны возвращать '''код для вычисления результата'''. То есть, они выполняются на этапе компиляции.
{{note}} Первое, что обычно нужно — это S(), H(), T(), Q(), I(), то есть «фильтры» для различных преобразований строки:
 
* S() — это htmlspecialchars(), экранирует HTML/XML-спецсимволы в строках.
* H() — удаляет все HTML-теги, кроме «безопасных».
* T() — удаляет все HTML-теги.
* Q() — это addslashes(), экранирует символы строки для использования, например, в JS.
* I() — преобразует значение к целому числу.
=== OR, AND, NOT = HTML-безопасный режим ====
Логические ИЛИЕсли вы хотите использовать «HTML-безопасный» режим с автоматическим экранированием — установите опцию '''auto_escape''' равной, Инапример, НЕкак раз «s». Смысл режима в том, действующие аналогично Perl операторам ||чтобы:* Не экранировать все значения руками* Случайно не забыть что-то экранировать, &&, !.экранируя это руками
=== EVENРаботает так: если какое-то подставляемое значение не экранировано вами явно через одну из функций вроде перечисленных выше (s/t/h/i и т. п.), ODD ===то оно будет экранировано функцией, заданной в auto_escape. Получается «авто-защита» от атак типа XSS. Значения, которые надо подставить «как есть», нужно предварить вызовом функции RAW: {raw value}. Тогда значение auto_escape’ом экранировано не будет.
Истина в случаеНа заметку: для удобства функции JSON, если аргумент чётный или нечётный соответственноQUOTE, SQL_QUOTE и REQUOTE считаются «безопасными», хотя таковыми, строго говоря, не являются. Однако используются они обычно внутри JS-кода, поэтому лучше их вывод не трогать.
=== INT=IЧисла, ADD, MUL, DIV, MOD, LOG логические операции ===
Преобразование к целому числу, арифметические операции и логарифм.==== LOG ====
=== EQ, NE, SEQ, SNE, GT, LT, GE, LE, SGT, SLT, SGE, SLE ===Логарифм.
Действуют аналогично Perl операторам == eq > < >= <= gt lt ge le.EVEN, ODD ====
В PHP-версии на данный момент такого многообразия нетИстина в случае, есть просто EQ NE GT LT GE LEесли аргумент чётный или нечётный соответственно.
=== COUNT, SUBARRAY=ARRAY_SLICE, SUBARRAY_DIVMOD INT=I=INTVAL ====
Количество элементов массива, или 0, если аргумент - не массив - count(аргумент)Преобразование к целому числу.
Аналог функции [http://php.net/manual/en/function.array-slice.php array_slice] из PHP.==== SEQ, SNE, SGT, SLT, SGE, SLE ====
Выбор из массива каждого div'того элемента, начиная с номера mod или нуля по умолчанию - subarray_divmod(массив, div, mod)Строковые сравнения.
=== ARRAY= NEQ, HASH NNE, NGT, NLT, NGE, NLE ====
Создание массива или хэша из всех атрибутовЧисленные сравнения.
Соответственно в хеше атрибуты идут парами КЛЮЧ, ЗНАЧЕНИЕ, КЛЮЧ, ЗНАЧЕНИЕ и т.п. (специального синтаксиса "=>" нет).=== YESNO ====
=== GETYESNO($1, AGET$2, HGET ===$3) — тернарный оператор ($1 ? $2 : $3).
Получение элемента массива/хэша по «динамическому» ключу. По-моему, это лучше, чем зюки-хрюки Template Toolkit’а: <tt>hash.${hash2.$key}</tt> и т. п.=== Строки ===
GET(откуда==== LC=LOWER=LOWERCASE, что) автоматически решает, «откуда» — это массив или хеш, AGET служит только для массивов, а HGET только для хешей. В PHP-версии все три идентичны.UC=UPPER=UPPERCASE ====
=== MAP ===Нижний и верхний регистр.
Применение функции==== LCFIRST, имя которой передано как первый аргумент, ко всем переданным аргументам и элементам всех переданных массивов — map(«имя_функции», аргументы).UCFIRST ====
=== LC=LOWER=LOWERCASE, UC=UPPER=UPPERCASE ===Преобразование первого символа строки в нижний и верхний регистр соответственно.
Нижний и верхний регистр.==== Q=QUOTE=ADDSLASHES, SQ=SQL_QUOTE, REQUOTE=RE_QUOTE=PREG_QUOTE ====
=== STRLIMIT ===* Экранирование символов " ' \ и перевода строки бэкслэшем — quote(строка).* Экранирование символа " удвоением — sql_quote(строка). (актуально также для [[rupedia:CSV|CSV]])* Экранирование символов, являющихся специальными в регулярных выражениях — re_quote(строка). (см. [http://perldoc.perl.org/perlre.html perldoc perlre]).
(пока только PHP-версия, в Perl будет в будущем) Ограничение длины строки s максимальной длиной l — strlimit(s, l). Если строка превышает заданную длину, она обрезается предпочтительно по пробелу или Tab’у, а в конец добавляется «…» (троеточие).==== URI_QUOTE=URIQUOTE=URLENCODE ====
=== S=HTML=HTMLSPECIALCHARS, T=STRIP, H=STRIP_UNSAFE ===URL-кодирование строки ({{CPAN|URI::Escape}} в Perl и [http://php.net/manual/en/function.urlencode.php urlencode()] в PHP).
Преобразование символов < > & " ' в HTML-сущности.==== REPLACE, STR_REPLACE ====
Удаление всех [[lib:HTML|HTML]]/[[lib:XML|XML]] тегов* Замена Perl- (соответственно PCRE- в PHP-версии) регулярного выражения в строке — replace(RegExp, замена, строка).* Замена подстроки в строке — str_replace(искомое, замена, строка).
Удаление только запрещённых тегов.==== STRLEN ====
=== URI_QUOTE=URIQUOTE=URLENCODE ===Длина строки ''в символах''.
URL-кодирование строки ({{CPAN|URI::Escape}} в Perl и [http://php.net/manual/en/function.urlencode.php urlencode()] в PHP).==== SUBSTR=SUBSTRING ====
=== CONCATСтандартная (для всех, JOIN=IMPLODE ===кроме жавистов) функция подстроки — substr(строка, начало, длина), или substr(строка, начало). Причём начало и длина могут быть отрицательными, тогда они считаются относительно длины строки.
Конкатенация всех своих аргументов — concat(аргументы). Конкатенирует также все элементы всех переданных массивов.==== TRIM ====
Конкатенация элементов массива через разделитель — join(строка, аргументы). Конкатенирует также все элементы всех переданных массивовУдаление пробелов из начала и конца строки.
=== Q=QUOTESPLIT =ADDSLASHES, REQUOTE=RE_QUOTE=PREG_QUOTE ===
Экранирование символов " ' \ и перевода Разделение строки бэкслэшем — quoteпо регулярному выражению и лимиту — split(строкаRegExp, аргумент, лимит).Лимит необязателен. (см. [http://perldoc.perl.org/functions/split.html perldoc -f split])
Экранирование символов==== S=HTML=HTMLSPECIALCHARS, являющихся специальными в регулярных выражениях — re_quote(строка). (см. [http://perldoc.perl.org/perlre.html perldoc perlre]).T=STRIP, H=STRIP_UNSAFE, NL2BR ====
=== REPLACE, SPLIT ===* Преобразование символов < > & " ' в HTML-сущности.* Удаление всех [[lib:HTML|HTML]]/[[lib:XML|XML]] тегов.* Удаление только «небезопасных» HTML-тегов.* Преобразование переводов строк (\n) в HTML-тег <tt><nowiki><br /></nowiki></tt>.
Замена Perl- (соответственно PCRE- в PHP-версии) регулярного выражения в строке — replace(RegExp==== CONCAT, замена, строка).JOIN=IMPLODE ====
Разделение строки по регулярному выражению и лимиту — split* Конкатенация всех своих аргументов — concat(RegExp, аргумент, лимитаргументы). Лимит необязателенКонкатенирует также все элементы всех переданных массивов. * Конкатенация элементов массива через разделитель — join(смстрока, аргументы). [http://perldocКонкатенирует также все элементы всех переданных массивов.perl.org/functions/split.html perldoc -f split])
==== SUBST, SPRINTF, STRFTIME ====
Подстановка Subst — подстановка на места подстрок вида $ЧИСЛО соответствующих параметров функции или элементов переданного массива — subst(строка, $1, $2, …).
Sprintf — он и в Африке [http://perldoc.perl.org/functions/sprintf.html sprintf].
Форматирование даты и/или времени с помощью функции [http://www.manpagez.com/man/3/strftime/ strftime] — strftime(формат, дата [, часть_даты]). Формат strftime’овский (например, «%d %b %Y»). Дата может передаваться как один или два аргумента, если два — они конкатенируются через пробел. Далее дата разбирается способом, похожим на wfTimestamp() в MediaWiki. Принимается один из следующих форматовследующее:
* UNIX время.
* Времена типа MySQL DATE, MySQL DATETIME, EXIF, ISO 8601, MediaWiki, и любые другие, подпадающие под следующий формат: 1 группа из 4 или более цифр (год) и 2 (месяц, день) или 5 (месяц, день, часы, минуты, секунды) групп по 2 цифры, разделённые любыми нецифровыми символами и в конце — опционально временная зона — 2 цифры, предварённые пробелом, плюсом или минусом. Короче говоря, <pre>^\D*(\d{4,})\D*(\d{2})\D*(\d{2})\D*(?:(\d{2})\D*(\d{2})\D*(\d{2})\D*([\+\- ]\d{2}\D*)?)?$</pre>
* Оракловский формат даты-времени: День(2 цифры)<nowiki>ДД-Месяц(3 буквы)Мес-Год ЧасыГГ[ГГ] ЧЧ. МинутыММ. СекундыСС</nowiki>.
* 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-… шаблонОВ): <tt><nowiki>{num} шаблон{plural_ru(num, '', 'а', 'ов')}</nowiki></tt> === Массивы и хеши === ==== HASH ==== Создание хэша из всех аргументов. Соответственно в хеше аргументы идут парами КЛЮЧ => ЗНАЧЕНИЕ, КЛЮЧ => ЗНАЧЕНИЕ и т. п. ==== KEYS, HASH_KEYS, ARRAY_KEYS ==== Массив ключей хэша. Понятное дело, в PHP их порядок сохраняется, а в Perl — нет. ==== SORT ==== Сортировка массива по значениям. ==== PAIRS ==== Массив хэшей вида <tt>{ key => ключ, value => значение }</tt> для хэша, в случае Perl ключи будут отсортированы по имени. ==== ARRAY, RANGE ==== * Создание массива.* Диапазон от A до B — range(A, B). ==== IS_ARRAY ==== Проверка, является ли аргумент массивом. В PHP-версии не проверяется, а не является ли он при этом хэшем, ибо трудоёмко. ==== 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). ==== GET ==== <tt>GET(что)</tt> — получение значения переменной верхнего уровня. ==== SET ==== <tt>SET(куда, что)</tt> — присваивание «куда» значения «что». Уравнения, понятное дело, не решает, то есть, как и обычно, присваивать можно только lvalue :) ==== ARRAY_MERGE ==== Слить массивы в один. Под Perl — только массивы (не хеши), под PHP — любые массивы. ==== 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 ==== Вывод всех данных из структуры — Dumper в Perl’е и var_dump в PHP. ==== JSON ==== Форматирование любой структуры данных в формат JSON. ==== CALL ==== Вызов метода объекта по «динамическому» имени — <tt>call(varref, method_name, arg1, arg2, arg3, ...)</tt>. ==== MAP ==== Применение функции, имя которой передано как первый аргумент, ко всем переданным аргументам и элементам всех переданных массивов — map(«имя_функции», аргументы). == Изменения относительно старых версий == * Ликвидированы assign_vars(), assign_block_vars(), tr_assign_vars() — теперь, как и обычно, передаётся просто хеш с данными $vars* Синтаксис типа {a->key} ликвидирован* Авто-переводы, которые были в перловой версии — тоже тю-тю (хотя, может, и будут возрождены)* SET теперь заканчивается обычным END, а не ENDSET* Обращение к счётчику цикла теперь {block_index}, а не {block.#}* Добавлены функции, операторы* Добавлены детальные сообщения об ошибках* Добавлен встроенный фильтр для ликвидации пробелов из начал/концов каждой строки шаблона == Различия PHP и Perl версий == ==== Кэширование работает по-разному ==== В целом, общий смысл — сделать так, чтобы шаблоны было не стыдно вызывать много раз, как много раз за один запрос, так и в целом, при этом максимально использовать механизмы интерпретатора самого языка. Но механизмы для этого применяются разные. Основная причина различий следующая:Sway * 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, и вызывается метод класса, соответствующий функции шаблона (&lt;!-- FUNCTION … --&gt;). ==== Несколько различается действие <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 запрос сразу для всех 100 объектов. Чтобы такого не было — нужно, чтобы объекты помнили, частью какой коллекции они являются, и при чтении свойства читали его сразу для всех объектов «своей» коллекции. Идея основана на предположении, что если у объекта, прочитанного из БД как часть большой выборки, запрашивается какое-то свойство — велика вероятность того, что это же свойство будет запрошено и у всех остальных объектов той же самой выборки. При такой реализации — и писать удобно (не нужно заморачиваться, что передавать в шаблон, а что нет), и производительность не страдает. Примечание: так как PHP — «язык наизнанку», сам немножко являющийся шаблонизатором, то при выполнении следующих требований можно писать и без шаблонизатора:* ''Руками'' писать в «шаблонном стиле»:*# Не смешивать сложные конструкции с HTML.*# Шаблоны выносить в отдельные функции и общаться с ними через 1 ассоциативный массив с данными.*# Вывод не печатать, а буферизовать (ob_start() &rarr; ob_get_contents() &rarr; ob_end_clean()) и возвращать.* Использовать читаемый стиль кода (?> и <?php только в конце строк, отступы насквозь через PHP и HTML).Это бывает весьма полезно, если нужно написать модуль к системе, которая сама написана без шаблонизатора или с каким-нибудь полу-кривым собственным, и не хочется вводить дополнительную зависимость. [[Категория:РазработкаТехактивы]]
[[Категория:Perl]]
[[Категория:PHP]]