Фремворк Limb

Отредактируйте страницу и нажмите «Сохранить». Прочтите справочную страницу для ознакомления с синтаксисом вики. Пожалуйста, редактируйте только в том случае, если планируете улучшить содержимое. Если вы просто хотите потестировать что-либо, воспользуйтесь специальной страницей: PlayGround.

====== Композиция шаблонов: включение(include), обворачивание(wrap) и переиспользование(reuse) шаблонов ======

===== Компиляция MACRO шаблонов =====

MACRO содержит различные средства, которые позволяют собирать конечные шаблоны из набора других шаблонов:
  * **Включение (include)** - включение одного шаблона в другой.
  * **Обворачивание (wrap)** - обворачивание одного шаблона другим.
  * **Переиспользование (reuse)** - использование части текущего шаблона несколько раз в различных местах.

**MACRO компилирует шаблоны только целиком!** То есть сначала обрабатываются все теги, такие как [[limb3:ru:packages:macro:tags:core_tags:include_tag| {{include}}]], [[limb3:ru:packages:macro:tags:core_tags:wrap_tag| {{wrap}}]], [[limb3:ru:packages:macro:tags:core_tags:into_tag| {{into}}]], [[limb3:ru:packages:macro:tags:core_tags:apply_tag| {{apply}}]] , и только затем окончательно создается откомпилированный шаблон. Именно поэтому разбиение шаблона на составляющие в MACRO с точки зрения выполнения конечного шаблона ничего не стоит (лишь увеличивается время компиляции). Это дает нам возможность выносить в отдельные шаблоны все, что повторяется в нескольких файлах.

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

===== Включение (include). Использование тега {{include}} =====

Включение (include) одного шаблона в другой. Include в MACRO осуществляется посредством [[limb3:ru:packages:macro:tags:core_tags:include_tag|тега {{include}}]]. По-умолчанию, включаемый файл компилируется как обычный шаблон.

<code xml>
{{include file='header.phtml'}}
[...content...]
{{include file='footer.phtml'}}
</code>

Если вы используете MACRO совместно с пакетом VIEW, и в атрибуте file используется абсолютное значение (начинается с **/** или с **c:/**), тогда MACRO подключает шаблон по абсолютному пути. В противном случае - пытается найти шаблон через механизм подключения шаблонов.

Стоит также обратить внимание, что при включении шаблона включаемый шаблон должен быть сбалансированным с точки зрения MACRO-тегов. То есть если тег предусматривает закрывающий тег, например, тег [[limb3:ru:packages:macro:tags:list_tags:list_tag| {{list}}]] или [[limb3:ru:packages:macro:tags:pager_tags:pager_tag| {{pager}}]], значит и закрываться он должен в том же файле.

===== Обворачивание (wrap) =====

==== Введение в обворачивание шаблонов ====

Обворачивание (wrap) -- это вставка текущего шаблона в определенное место другого шаблона.

С обворачиванием шаблонов связаны следующие термины:
  * Текущий шаблон -- который содержит команды по обворачиванию (в нем содержатся теги [[limb3:ru:packages:macro:tags:core_tags:wrap_tag| {{wrap}}]])
  * Базовый шаблон -- в который осуществляется вставка текущего шаблона. 
  * Контейнер вставки или слот (slot/placeholder) -- находится в базовом шаблоне и помечает места вставки.

Обворачивание производится при помощи  [[limb3:ru:packages:macro:tags:core_tags:wrap_tag|тега {{wrap}}]]. Слот для вставки помечается в базовом шаблоне [[limb3:ru:packages:macro:tags:core_tags:slot_tag|тегом {{slot}}]].

Рассмотрим небольшой пример:

**page.html** -- базовый шаблон 
<code xml>
<html>
<head>
[...meta...]
</head>
<body>
 {{slot id='content'/}}
</body>
</html>
</code>

**my_page.html** -- текущий шаблон

<code xml>
{{wrap with='page.html' into='content'}}
[...content...]
{{/wrap}}
</code>

В результате получим нечто:

<code xml>
<html>
<head>
[...meta...]
</head>
<body>
 [...content...]
</body>
</html>
</code>

==== Использование тега {{wrap}}. Множественное обворачивание. Тег {{into}} ====

Разберем подробнее, как работает [[limb3:ru:packages:macro:tags:core_tags:wrap_tag|тег {{wrap}}]]. %%{{wrap}}%% требует закрывающего тега. Обворачиваемой считается та часть текущего шаблона, что обрамлена в рамки тега %%{{wrap}}%%.

По-умолчанию %%{{wrap}}%% вставляет все свое содержимое в слот, указаный при помощи атрибута **into**.

Однако можно различные части текущего шаблона отправить в различные слоты базового шаблона. Для этого используется [[limb3:ru:packages:macro:tags:core_tags:into_tag|тег {{into}}]].

Поясним это все на примере:

Допустим есть базовый шаблон страницы page.html:
<code xml>
<html>
<body>
  {{slot id='content'/}}
</body>
</html>
</code>

Также шаблон дополнительного дизайна layout.html с двумя местами для вставки (как бы второй базовый шаблон):
<code xml>
 <div id='header'>{{slot id='header'/}}</div>
 <div id='main'>{{slot id='main'/}}</div>
</code>

И теперь текущий шаблон display.html:

<code xml>
{{wrap with='page.html' into='content'}}

{{wrap file='layout.html'}}
 {{into slot='header'}}My Header{{/into}}
 {{into slot='main'}}My Complex content{{/into}}
{{/wrap}}

{{/wrap}}
</code>

На выходе получим:
<code xml>
<html>
<body>
  <div id='header'>My Header</div>
  <div id='main'>My Complex content</div>
</body>
</html>
</code>

Необходимо пояснить, как именно компилируется шаблон в данном случае. Сначала обрабатывается первый %%{{wrap}}%% и  мы получаем на 1-м шаге компиляции следующий шаблон:

<code xml>
<html>
<body>
  {{wrap with='layout.html'}}
   {{into slot='header'}}My Header{{/into}}
   {{into slot='main'}}My Complex content{{/into}}
  {{/wrap}}
</body>
</html>
</code>

Затем обрабатывается второй %%{{wrap}}%% и условно получается:

<div id='header'>{{slot id='header'/}}</div>
 <div id='main'>{{slot id='main'/}}</div>

{{into slot='header'}}My Header{{/into}}
 {{into slot='main'}}My Complex content{{/into}}

</body>
</html>
</code>

В результате работы тегов %%{{into}}%% получается конечный результат.

Если %%{{into}}%% тег находит вне %%{{wrap}}%% тега, тогда он пытается найти соответстувующий тег %%{{slot}}%% начиная с корня дерева компилируемого шаблона.

===== Повторное использование части текущего шаблона =====

Представим, что вам необходимо вывести 2 списка элементов одинакомым образом, однако имеющим различные источники данных. Например, на первой странице раздела нам нужно вывести лучшие товары и остальные товары раздела.

Первое решение - это вынести повторяющуюся часть шаблона в отдельный файл и подключать его 2 раза при помощи тега %%{{include}}%%. Это хороший вариант, если вы собираетесь использовать этот выделенный шаблон несколько раз еще в других шаблонах.

Если же общая часть используется только в рамках одного шаблона, то этих целей целесообразно использовать комбинацию [[limb3:ru:packages:macro:tags:core_tags:template_tag|тега {{template}}]] и нескольких [[limb3:ru:packages:macro:tags:core_tags:apply_tag|тегов {{apply}}]].

Например:

<code xml>
  {{template name="photo_tpl"}}
    <span class="date">{$item.ctime|date:"d.m.Y"}</span>
    <a href="/photo/item/{$item.id}" class="img"><img alt="{$item.title}" src="{$item.icon_file_url}"></a>
    <a href="/photo/item/{$item.id}" class="title">{$item.title}</a>
    <a href="#" class="author">{$item.member.nick}</a>
    <a href="{$item.thumbnail_file_url}" title="{$item.title}" class='preview'>предварительный просмотр</a>
  {{/template}}

<h2>Лучшие фото рубрики {$#category.title}</h2>
  {{list using="$#best_photos" as="$photo"}}
  <ul id='best_photos_list'>
    {{list:item}}
     <li>{{apply template="photo_tpl" item="$photo"/}}</li>
    {{/list:item}}
  </ul>
  {{/list}}

<h2>Все фото рубрики {$#category.title}</h2>
  {{list using="$#photos" as="$photo"}}
  <ul id='photos_list'>
    {{list:item}}
     <li>{{apply template="photo_tpl" item="$photo"/}}</li>
    {{/list:item}}
  </ul>
  {{/list}}
</code>

Сам тег %%{{template}}%% ничего не рендерит. Только вызовы %%{{apply}}%% вставляют часть этого кода в нужное место. Обратите внимание, что на уровне откомплированного шаблона %%{{template}}%% создает отдельный метод, а %%{{apply}}%% - это по сути вызов этого метода. Поэтому то, что находится в рамках %%{{template}}%% - это по сути отдельный локальный контекст и локальные переменные в нем будут не видны, и их нужно туда передавать, что и реализовано в приведенном примере.

Пожалуйста, введите код подтверждения, чтобы доказать, что вы не робот:

   _  __   ___    ____   _  __   __  ___
  / |/ /  / _ )  / __/  / |/ /  /  |/  /
 /    /  / _  | / _/   /    /  / /|_/ / 
/_/|_/  /____/ /_/    /_/|_/  /_/  /_/

Пожалуйста, оставьте это поле пустым:

Сводка изменений

Примечание: редактируя эту страницу, вы соглашаетесь на использование своего вклада на условиях следующей лицензии: CC Attribution-Share Alike 4.0 International

Фремворк Limb

Инструменты пользователя

Инструменты сайта

Инструменты страницы