Эта страница будет полезной для разработчиков, которым необходимо создать свои собственные теги или фильтры. Она позволит понять, каким образом MACRO компилирует шаблоны. Мы подробно разберем процесс компиляции шаблонов, укажем на основные классы, участвующие в компиляции, покажем, как генерится php-код компилированных шаблонов, как отрабатывают выражения для вывода данных и т.д.
Очень глубоких деталей реализации MACRO-компилятора мы все же касаться не будем, но полученных знаний будет достаточно чтобы создать новый тег или фильтр.
Мы предполагаем, что Вам знаком материал раздела "Компиляция и выполнение шаблона. Пример рендеринга MACRO-шаблона".
Вы уже знаете, что MACRO обрабатывает шаблоны в две стадии:
На этапе компиляции шаблон собирается целиком и переводится в php-скрипт с уникальным классом, который содержит метод публичный render(), закрытый метод _init(), а также прочие методы, количество и имена которых зависят от использования тегов {{insert}}, {{insert:into}}, {{template}} и {{apply}}.
При компиляции шаблон разбирается и создается его структура в виде дерева. Каждый элемент этого дерева - это объект класса lmbMacroNode (или его дочерние). После создания дерева компиляции, компилятор проходит по этому дереву и для каждого элемента дерева вызывает метод generate($code_writer), тем самым просит каждый из компонентов фазы компиляции добавить что-либо в компилируемый шаблон. Объект $code_writer класс lmbMacroCodeWriter аккумулирует весь генерируемый код, чтобы затем его записать в файл.
Во время фазы исполнения (RunTime) запускается сначала метод _init() (аналог превдо-конструктора). Содержимое этого метода обычно используется для инициализации так называемых runtime компонентов, или просто helper-ов, которые используются для работы тех или иных тегов. К числу тегов, которые создают runtime-компоненты относятся, например, тег {pager}} и теги группы FormTags.
После выполнения метода _init() выполняется остальная часть метода render(), которая содержит смесь обычного html-кода с php-кодом.
Мы подробно опишем, как происходит компиляция на примере тега {{paginate}}.
Рассмотрим простейший пример вывода на экран произвольного списка заголовков:
<html> <body> <h1>List example</h1> {{paginate iterator='$#items' pager='my_pager'}} {{pager id="my_pager" items="5"}} {{pager:prev}}<a href="{$href}">Prev page</a>{{pager:prev}} {{pager:next}}<a href="{$href}">Next page</a>{{pager:next}} {{/pager}} {{list using="$#items"}} <table border="0"> {{list:item}} <tr> <td>{$item.title}</td> </tr> {{/list:item}} </table> {{/list}} </body> </html>
Теперь мы подробно покажем как MACRO откомпилирует данный шаблон.
Весь процесс компиляции управляется из класса lmbMacroCompiler (limb/macro/src/compiler/lmbMacroCompiler.class.php).
Во время компиляции шаблон анализируется и создается так называемое дерево фазы компиляции.
Это дерево состоит из элементов - нодов. Базовый класс для всех нодов дерева компиляции - lmbMacroNode, limb/macro/src/compiler/lmbMacroNode.class.php).
В это дерево в качестве элементов попадают практически все элементы шаблона:
В нашем примере мы получим следующее дерево:
Root | |-lmbMacroTextNode | |-lmbMacroPaginateTag | |-lmbMacroPagerTag | | | |-lmbMacroPagerPrevTag | | | | | |-lmbMacroTextNode | | | |-lmbMacroPagerNextTag | | | |-lmbMacroTextNode | |-lmbMacroListTag | | | |-lmbMacroTextNode | | | |-lmbMacroListItemTag | | | | | |-lmbMacroTextNode | | | | | |-lmbMacroOutputExpressionNode | | | | | |-lmbMacroTextNode | | | |-lmbMacroTextNode | |-lmbMacroTextNode
Класс lmbMacroNode - это основной класс ноды дерева фазы компиляции.
Каждый объект класса lmbMacroNode содержит следующие атрибуты:
lmbMacroNode содержит необходимые методы для навигации по дереву и поиску необходимых элементов:
Класс lmbMacroNode также содержит метод, который участвуют в процессе компиляции:
Параметр $code_writer - это объект класс lmbMacroCodeWriter, который содержит код откомпилированного шаблона.
Параметр $code_writer методов генерации класса lmbMacroCodeWriter - это объект класса lmbMacroCodeWriter (limb/macro/src/compiler/lmbMacroCodeWriter .class.php).
Класс lmbMacroCodeWriter содержит следующие часто используемые методы:
Класс lmbMacroCodeWriter автоматически переключает контекст с html на php. Поэтому вы можете легко смешивать вызовы writeHTML() и writePHP().
Класс lmbMacroTag - это основной класс для тегов. Он наследуется от lmbMacroNode , но добавляет функционал по работе с атрибутами тегов.
Вот список наиболее значительных методов для работы с атрибутами:
Кроме этого класс lmbMacroTag содержит набор методов, которые его наследники используют при генерации:
Обратите внимание, что перекрывать метод generate($code) наследникам lmbMacroTag крайне не рекомендуется, так как реализация lmbMacroTag :: generate($code) содержит важный код, который необходим для работы со сложными атрибутами (так называемая прегенерация атрибутов).
Рассмотрим тег {{paginate}} и на его примере продемонстрируем, каким образом формируется компилированный шаблон.
Код класса lmbMacroPaginateTag можно найти в файле limb/macro/src/tags/pager/paginate.tag.php:
<?php /** * Applies pager to iterator (so called "pagination") * @tag paginate * @req_attributes iterator * @package macro * @version $Id$ */ class lmbMacroPaginateTag extends lmbMacroTag { protected function _generateContent($code) { $iterator = $this->get('iterator'); if($this->has('pager')) { if(!$pager_tag = $this->parent->findUpChild($this->get('pager'))) $this->raise('Can\'t find pager by "pager" attribute in {{paginate}} tag'); $pager = $pager_tag->getRuntimeVar(); if($this->has('limit')) $code->writePhp("{$pager}->setItemsPerPage({$this->get('limit')});\n"); $code->writePhp("{$pager}->setTotalItems({$iterator}->count());\n"); $code->writePhp("{$pager}->prepare();\n"); $offset = $code->generateVar(); $code->writePhp("{$offset} = {$pager}->getCurrentPageBeginItem();\n"); $code->writePhp("if({$offset} > 0) {$offset} = {$offset} - 1;\n"); $code->writePhp("{$iterator}->paginate({$offset}, {$pager}->getItemsPerPage());\n"); return; } elseif($this->has('offset')) { if(!$this->has('limit')) $this->raise('"limit" attribute for {{paginate}} is required if "offset" is given'); $code->writePhp("{$iterator}->paginate({$this->get('offset')},{$this->get('limit')});\n"); return; } elseif($this->has('limit')) { $code->writePhp("{$iterator}->paginate(0,{$this->get('limit')});\n"); return; } } }
Разберем подробно код класса.
Итак, lmbMacroPaginateTag является потомком от lmbMacroTag, то есть обычным MACRO-тегом.
Генерация кода обычно производится в методе _generateContent($code_writer) (об этом мы уже указывали в описании класса lmbMacroTag).
Рассмотрим следующие строки класса lmbMacroPaginateTag :
if($this->has('pager')) { if(!$pager_tag = $this->parent->findUpChild($this->get('pager'))) $this->raise('Can\'t find pager by "pager" attribute in {{paginate}} tag'); $pager = $pager_tag->getRuntimeVar(); [..]
Если тег содержит атрибут pager, тогда он пытается найти соответствующий элемент дерева при помощи метода findUpChild(), вызывая его у своего родителя. Метод raise($message) используется для генерации исключения, если во время компиляции произошла ошибка. Метод raise() автоматически добавляет в исключение информацию о том, где в шаблоне произошла ошибка.
Далее
$pager = $pager_tag->getRuntimeVar(); if($this->has('limit')) $code->writePhp("{$pager}->setItemsPerPage({$this->get('limit')});\n");
Первая строка этого блока возвращает имя переменной, по которой runtime компонент пейджера будет доступен в шаблоне на этапе выполнения.
Так как limit - это скорее всего число или переменная, а не строка, при генерации ее значения в шаблон мы использовали метод get($attr_name). В припципе, правильнее было бы использовать метод getEscaped($attr_name).
$code->writePhp("{$pager}->setTotalItems({$iterator}->count());\n");
$code->writePhp("{$pager}->prepare();\n");
$offset = $code->generateVar();
$code->writePhp("{$offset} = {$pager}->getCurrentPageBeginItem();\n");
$code->writePhp("if({$offset} > 0) {$offset} = {$offset} - 1;\n");
$code->writePhp("{$iterator}->paginate({$offset}, {$pager}->getItemsPerPage());\n");
return;
Здесь мы также использовали генерацию временной переменной $offset при помощи метода lmbMacroCodeWriter :: generateVar();
В результате в компилированном шаблоне мы получим приблизительно следующий код, который сгенерит тег paginate:
<?php $this->pager_pager->setTotalItems($this->photos->count()); $this->pager_pager->prepare(); $EX = $this->pager_pager->getCurrentPageBeginItem(); if($EX > 0) $EX = $EX - 1; $this->photos->paginate($EX, $this->pager_pager->getItemsPerPage()); ?>
Теперь кратко покажем, как генерят компилированный шаблон остальные элементы дерева компиляции.
Все, что не является MACRO-тегами или выражения, MACRO интерпретирует как обычный текст и выдает его в компилированный шаблон «как есть», то есть внутри класса lmbMacroTextNode есть такой код:
function generate($code_writer) { $code_writer->writeHTML($this->contents); parent :: generate($code_writer); } } ?>
где $this→contents - и есть сам текст.
По-умолчанию выражения (если они не являются атрибутами MACRO-тегов) формируют в компилированном шаблоне код <?php echo …; ?>. Остальное зависит от фильтров и от сложности самого выражения. Например, выражение {$title|html} фактически означает применение фильтра html к данным, а $title - это переменная. В результате из {$title|html} в откомпилированном шаблоне получим следующее:
<?php echo htmlspecialchars($title, ENT_QUOTES); ?>