Twig: Введение. Что такое шаблонизатор Twig и зачем он нужен? Все что нужно знать про twig

В этой статье рассмотрим Twig теги - конструкции шаблонизатора, которые выполняют разнообразные задачи, такие как: условные операторы, циклы, экранирование данных, создание макросов, использование наследования шаблонов, запись в переменные и многое другое. В общем виде они записываются с помощью открывающего тега и закрывающего (именуется префиксом end). Закрывающий тег нужен не для всех конструкций. Пример абстрактного тега выглядит так:

{% tag %} {% endtag %}

Управляющие конструкции: условные операторы и циклы

Тег if

Тег if в Twig сравним с условным оператором if в PHP. В простейшей форме вы можете использовать его, чтобы проверить выражение на истинность:

{% if label_display == "after" %} {{ label }} {% endif %}

Вы также можете проверить массив или строку на существование:

{% if page.footer_fifth %}

{% endif %}

Twig шаблонизатор предполагает дополнительные проверки в условиях:

empty - проверяет, является ли переменная пустой:

{# возвращает true, если переменная foo равна null, false, пустой массив, или пустая строка #} {% if foo is empty %} ... {% endif %} {# возможен вариант с оператором отрицания not #} {% if foo is not empty %} ... {% endif %}

even и odd - возвращает true если данное число является четным или нечетным, соответственно:

{{ if var is even }} ... {% endif %} {{ if var is odd }} ... {% endif %}

iterable - проверяет, является ли переменная массивом или объектом (экземпляром класса, имплементирующего интерфейс Traversable):

{% if users is iterable %} {% for user in users %} Hello {{ user.name }}! {% endfor %} {% else %} {# users вероятно являетcя строкой #} Hello {{ users }}! {% endif %}

null - возвращает true, если переменная равна NULL :

{{ if var is null }} ... {% endif %}

constant - проверяет, имеет ли переменная точно такое же значение, как константа. Вы можете использовать либо глобальные константы, либо константы класса:

{% if status is constant("MARK_NEW") %} {{ "New"|t }} {% elseif status is constant("MARK_UPDATED") %} {{ "Updated"|t }} {% endif %}

divisible - проверяет, делится ли переменная на число:

{% if loop.index is divisible by(3) %} ... {% endif %}

same as - проверяет, указывают ли две переменные на одну ячейку памяти. Аналогичен оператору эквивалентности === в php:

{% if foo.attribute is same as(false) %} foo.attribute эквивалентен значению "false" {% endif %}

defined - проверяет, определена ли переменная:

{# defined работает как с именами переменных #} {% if foo is defined %} ... {% endif %} {# так и с атрибутами переменных #} {% if foo.bar is defined %} ... {% endif %} {% if foo["bar"] is defined %} ... {% endif %}

В условиях можно использовать логические операторы and, or, not:

{% if not page %} {% if foo and bar %} {% if foo or bar %} {# Возможны и сложные составные условия #} {% if (a and b) or (c and d) %}

В условиях имеется возможность использовать регулярные выражения

{% if phone matches "/^[\\d\\.]+$/" %} {% endif %}

Можно также проверить, начинается ли или заканчивается строка с определенного символа:

{% if "Drupal" starts with "D" %} {% endif %} {% if "Drupal" ends with "l" %} {% endif %}

Также вы можете использовать более сложные выражения if-elseif (кстати switch-case в Twig отсутствует ):

{% if rows %}

{% elseif empty %}

{% else %} else output {% endif %}

Тег for

Тег for аналогичен конструкции for в php и осуществляет "перебор" элементов массива или свойств объекта, если объект является экземпляром класса, имплементирующего Traversable интерфейс.

В качестве примера рассмотрим шаблон поля и в нем перебор множественных значений поля:

{% for item in items %} {{ item.content }} {% endfor %}

Переменные, доступные внутри цикла:

loop.index - Текущая итерация цикла (начинается с 1)
loop.index0 - Текущая итерация цикла (начинается с 0)
loop.revindex - Количество итераций с конца цикла (начинается с 1)
loop.revindex0 - Количество итераций с конца цикла (начинается с 0)
loop.first - Флаг равный True, если текущая итерация является первой
loop.last - Флаг равный True, если текущая итерация является последней
loop.length - Количество элементов в последовательности
loop.parent - Родительский контекст (используется для вложенных циклов)

В отличие от PHP нельзя прервать или продолжить цикл (continue и break). Однако можно создавать правила, позволяющие пропускать элементы по условиям for-if . В примере ниже неактивные пользователи пропускаются в итерациях:

{{ user.name }}

Также в Twig возможна конструкция for-else для выполнения действий, если массив или объект оказался пустым:

{{ user.name }}
{{ no_found|t }}

В Twig также возможны итерации с перебором и ключей, и значений

{% for key, value in values %}

{{ key }}: {{ value }}

{% endfor %}

Наследование шаблонов в Twig

Наследование шаблонов - одна из самых интересных особенностей в Twig. Наследование позволяет создавать базовые родительские шаблоны, которые потом можно будет использовать в дочерних шаблонах, при этом весь код родительских шаблонов доступен и в дочерних, а кроме того есть возможность переопределять некоторые блоки родительских шаблонов. Рассмотрим теги, которые позволяют реализовать наследование:

Тег extends

Рассмотрим использование наследования и тега extends на примере шаблона для блока block.html.twig и его дочерних шаблонов. Базовый родительский шаблон блока содержит код в упрощенном виде:

{{ title_prefix }} {% if label %} {{ label }} {% endif %} {{ title_suffix }} {% block content %} {{ content }} {% endblock %}

В шаблоне прописан код, который будет выводиться и в дочерних шаблонах. Содержимое шаблона, которое доступно для переопределения в дочерних шаблонах находится внутри тегов block. У каждой секции block имеется свое имя, которое будет использовано при переопределении. В данном примере есть только один блок с именем content. Весь код вне тегов block будет выведен как есть и его переопределить уже нельзя. Если в дочернем шаблоне вывод блока не будет переопределен, то код блока будет взят из базового шаблона. В качестве дочернего шаблона рассмотрим шаблон для блока с вкладками (в Drupal 8 они вынесены в отдельный блок) block--local-tasks-block.html.twig:

{# Будет унаследован block.html.twig из текущей темы #} {% extends "block.html.twig" %} {% block content %} {% if content %}

{% endif %} {% endblock %}

Наследовать шаблоны можно также из модулей и других тем:

{# Будет унаследован block.html.twig из модуля block (core/modules/block/templates/block.html.twig) #} {% extends "@block/block.html.twig" %} {# Будет унаследован block.html.twig из темы classy из каталога block/ (core/themes/classy/templates/block/block.html.twig) #} {% extends "@classy/block/block.html.twig" %}

При переопределении блока родительского шаблона, содержимое из родительского блока перезаписывается, но если в блоке нужно выводить содержимое родительского блока, то используется Twig функция parent()

{% block content %}

Header

... {{ parent() }} {# Выведет содержимое родительского блока #} {% endblock %}

Тег block

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

Макросы в Twig

Макросы можно сравнить с функциями в языках программирования. Они нужны для многократного использования часто используемых частей html кода и при этом макросы могут принимать параметры, что позволяет динамически изменять вставляемый код. Статический же блок с html кодом можно сохранить с помощью тега set. Макросы отличаются от php функций следующими особенностями:

аргументы по умолчанию в макросах задаются внутри тела макроса;
аргументы в макросах всегда являются опциональными (необязательными);
если в макрос передается больше аргументов, чем описано параметров, то все они будут содержаться в переменной varargs.

Как и php функции макросы не имеют доступа к глобальным переменным шаблона. Для передачи переменных из шаблона при необходимости нужно использовать специальная переменную _context.

Тег macro

Тег macro определяет новый макрос. В качестве простейшего примера рассмотрим макрос, который рендерит элемент формы input, при этом input type, name, value, size макрос содержит в качестве параметров (type и size задаются по умолчанию):

{% endmacro %}

{# Импортируем макросы из forms.html.twig в текущий шаблон #} {% import "forms.html" as forms %} {# Вызываем макрос #}

Если макрос определен и используется в одном и том же шаблоне, то для его импорта используется специальная переменная _self.

{% import _self as forms %}

Если нужно использовать макрос в другом макросе, но в том же самом шаблоне, то макрос импортируется локально внутри другого макроса:

{% macro input(name, value, type, size) %} {% endmacro %} {% macro wrapped_input(name, value, type, size) %} {% import _self as forms %}

{% endmacro %}

В Drupal 8 в шаблоне menu.html.twig макрос menu_links() определяется и используется в одном и том же шаблоне и дополнительно сам макрос используется рекурсивно внутри самого себя для вывода вложенных пунктов меню:

{% import _self as menus %} {{ menus.menu_links(items, attributes, 0) }} {% macro menu_links(items, attributes, menu_level) %} {% import _self as menus %} {% if items %} {% if menu_level == 0 %} {% else %}

{{ link(item.title, item.url) }} {% if item.below %} {{ menus.menu_links(item.below, attributes, menu_level + 1) }} {% endif %} {% endfor %}

{% endif %} {% endmacro %}

Тег import

Тег import импортирует все макросы из указанного шаблона:

{# forms.html.twig #} {# Описываем макрос input() #} {% macro input(name, value, type, size) %} {% endmacro %} {# Описываем макрос textarea() #} {% macro textarea(name, value, rows, cols) %} {{ value|e }} {% endmacro %} {# Импортируем в другой шаблон макросы из forms.html.twig #} {% import "forms.html" as forms %}

Username: {{ forms.input("username") }}
Password: {{ forms.input("password", null, "password") }}

Тег from

Тег from импортирует только указанные макросы из шаблона:

{# Импортируем из forms.html.twig макросы: input() с алиасом input_field и textarea() #} {% from "forms.html" import input as input_field, textarea %}

Username: {{ input_field("username") }}
Password: {{ input_field("password", "", "password") }}

Тег include

Тег include включает в себя имя шаблона и возвращает отображаемое содержимое этого файла в текущий шаблон. Все переменные текущего шаблона будут доступны в подключаемых шаблонах. С помощью include можно некоторые блоки кода вынести в отдельные шаблоны:

{# header.html.twig #}

{# footer.html.twig #} {# page.html.twig - available variables: header, footer #} {% include "header.html" %}

Body

{% include "footer.html" %} {# Результат:

Header

Body

Можно добавить дополнительные переменные, передавая их после with:

{# template.html.twig будет иметь доступ к переменным из контекста текущего шаблона и добавленным переменным #} {% include "template.html" with {"foo": "bar"} %} {% set vars = {"foo": "bar"} %} {% include "template.html" with vars %} {# Можно также добавлять несколько переменных #} {% include "template.html" with {"foo": var1, "bar" : var2} %} {# Будут доступны в template.html.twig переменные foo и bar #}

Или можно отключить доступ к контексту путем добавления only.

{# Только foo переменная будет доступна в template.html.twig #} {% include "template.html" with {"foo": "bar"} only %} {# В template.html.twig доступа к переменным не будет #} {% include "template.html" only %}

Вы можете отменить include при помощи инструкции ignore missing, и тогда Twig будет игнорировать подключение несуществующего шаблона. Размещается инструкция ignore missing сразу за именем шаблона:

{% include "sidebar.html" ignore missing %} {% include "sidebar.html" ignore missing with {"foo": "bar"} %} {% include "sidebar.html" ignore missing only %}

Можно предоставить и список шаблонов, которые проверяются на предмет существования до включения.

{% include ["page_detailed.html", "page.html"] %} {% include ["special_sidebar.html", "sidebar.html"] ignore missing %}

Пример использования include в Drupal 8 можно посмотреть в шаблоне темы Classy links--node.html.twig:

{% if links %}

{% include "links.html.twig" %}

{% endif %} {# В подключаемом шаблоне links.html.twig доступны все переменные из links--node.html.twig #}

Тег set

Внутри шаблонов можно создавать переменные с помощью тега set:

{# Записываем в переменную строку #} {% set foo = "foo" %} {# Записываем в переменную массив #} {% set foo = %} {# Записываем в переменную ассоциативный массив #} {% set foo = {"foo": "bar"} %} {# символ ~ осуществляет конкатенацию строк #} {% set foo = "foo" ~ "bar" %} {# Результат: foo содержит "foobar" #} {% set foo, bar = "foo", "bar" %} {# Создано две переменных foo и bar #}

С помощью тега set в переменную можно записать блок кода:

{% set foo %}

...

{% endset %}

Тег spaceless

Тег spaceless можно использовать для удаления пробелов между HTML-тегами, а также содержимого внутри HTML-тегов или пробелов в простом тексте:

{% spaceless %}

foo

{% endspaceless %} {# Результат:

foo

Тег autoescape

В зависимости от того, включено или нет автоматическое экранирование, вы можете отметить фрагмент шаблона для экранирования или же отключить эту функцию, используя тег autoescape (в Drupal 8 автоэкранирование включено в контексте html):

{% autoescape %} Автоэкранирование в этом блоке осуществляется методами HTML. {% endautoescape %} {% autoescape "html" %} Автоэкранирование в этом блоке осуществляется методами HTML. {% endautoescape %} {% autoescape "js" %} Автоэкранирование в этом блоке осуществляется методами js. {% endautoescape %} {% autoescape false %} Автоэкранирование отключено. Содержимое блока выводится без изменений. {% endautoescape %}

Тег verbatim

Тег verbatim маркирует секцию и сообщает шаблонизатору не обрабатывать содержимое блока:

{% verbatim %}

{{ item }}

{% endverbatim %} {# Результат:

{{ item }}

Тег filter

Тег filter позволяет применять стандартные фильтры шаблонизатора Twig для блоков данных шаблонов. Просто разместите код внутри секции "filter":

{% filter upper %} Drupal 8 {% endfilter %} {# Результат: "DRUPAL 8" #}

Можно также создавать комбинации фильтров:

{% filter lower|escape %} SOME TEXT {% endfilter %} {# Результат: "some text" #}

Если в теге используется фильтры escape или e, то drupal их заменит на свой фильтр drupal_escape .

Тег do

Тег do работает так же, как стандартное выражение с переменной {{ var }} , с той разницей, что ничего не выводится. На практике применим, если нужно вызвать функцию или метод объекта, которые что либо могут возвращать или выводить, но в выводе шаблона эти данные не нужны отображать.

{% do 1 + 2 %} {% do product.delete() %}

Тег trans

Тег trans специфичен для Drupal 8. Этот тег позволяет переводить текст (используя токены) внутри тега используя функцию t() или TranslationManager::formatPlural() , если внутри тега использована конструкция {% plural ... %} :

{% trans %}Submitted by {{ author.name }} on {{ node.date }}{% endtrans %}

На сегодняшний день существует большое количество способов осуществить вывод на html страницу. Всё чаще и чаще для этих целей веб разработчики пользуются так называемыми шаблонизаторами. Сегодня мы рассмотрим небольшой пример использования шаблонизатора Twig.

Особенности Twig

феноменально быстрая скорость работы (в сравнении с другими шаблонизаторами)
компиляция шаблонов в хорошо оптимизированный PHP код
применение “наследования” (можно определить базовый и дочерние шаблоны)
позволяет создавать и использовать макросы

Установка

Существует множество способов установки Twig-a. Самый простой и быстрый - это скачивание компонента с GitHub , после чего архив необходимо распаковать, и перекинуть каталог lib в папку с нашим проектом.

Структура проекта

Ну а теперь давайте приступим к делу и рассмотрим структуру нашего небольшого проекта:

compilation_cache
lib
- Twig
templates
- base.html
- books.html
index.php

Весь функционал, связанный с подключением и настройкой Twig-а, содержится в файле index.php .

В папке templates мы будем хранить файлы шаблонов. В нашем случае, этих файлов 2: base.html с базовым html кодом и books.html с выводом списка книг.

В каталоге compilation_cache будут помещаться PHP файлы, созданные Twig-ом для работы.

Подключение и базовая конфигурация Twig-a

Итак, первое что нам необходимо сделать, так это подключить Twig:

Require_once "lib/Twig/Autoloader.php"; Twig_Autoloader::register();

После этого сообщаем шаблонизатору, где у нас хранятся файлы шаблонов. В качестве аргумента передаём путь к каталогу templates :

$loader = new Twig_Loader_Filesystem("templates");

Затем создаём объект шаблонизатора и указываем ещё несколько опций:

$twig = new Twig_Environment($loader, array("cache" => "compilation_cache", "auto_reload" => true));

Параметру cache передаём путь к каталогу compilation_cache . Активируем опцию auto_reload, для того чтобы при обновлении страницы Twig заново обрабатывал шаблоны, и мы видели изменения. Если этого не сделать, то шаблонизатор просто закэширует страницы. Когда же работа над проектом будет завершена, эту опцию можно убрать, чтобы ваши страницы закэшировались и грузились ещё быстрее.

Данные

Для реализации нашего небольшого примера, возьмём список книг и сформируем массив вида ключ - значение:

$books = array(array("number" => "Книга 1", "title" => "Гарри Поттер и философский камень", "date" => "30.06.1997"), array("number" => "Книга 2", "title" => "Гарри Поттер и Тайная комната", "date" => "2.07.1998"), array("number" => "Книга 3", "title" => "Гарри Поттер и узник Азкабана", "date" => "8.07.1999"), array("number" => "Книга 4", "title" => "Гарри Поттер и Кубок огня", "date" => "8.07.2000"), array("number" => "Книга 5", "title" => "Гарри Поттер и Орден Феникса", "date" => "21.07.2003"), array("number" => "Книга 6", "title" => "Гарри Поттер и Принц-полукровка", "date" => "16.07.2005"), array("number" => "Книга 7", "title" => "Гарри Поттер и Дары Смерти", "date" => "21.07.2007"));

Загрузка файла и передача данных

Для того чтобы передать данные в какой-то шаблон и вывести html результат, нам необходимо воспользоваться методом render(); В качестве первого аргумента передаём название файла шаблона, который будем выводить. В качестве второго -массив вида ключ - значение. В дальнейшем по заданным ключам мы будем получать доступ к нашим данным в самих шаблонах.

Echo $twig->render("books.html", array("books" => $books));

index.php

Общий вид файла index.php

Require_once "lib/Twig/Autoloader.php"; Twig_Autoloader::register(); $loader = new Twig_Loader_Filesystem("templates"); $twig = new Twig_Environment($loader, array("cache" => "compilation_cache", "auto_reload" => true)); $books = array(array("number" => "Книга 1", "title" => "Гарри Поттер и философский камень", "date" => "30.06.1997"), array("number" => "Книга 2", "title" => "Гарри Поттер и Тайная комната", "date" => "2.07.1998"), array("number" => "Книга 3", "title" => "Гарри Поттер и узник Азкабана", "date" => "8.07.1999"), array("number" => "Книга 4", "title" => "Гарри Поттер и Кубок огня", "date" => "8.07.2000"), array("number" => "Книга 5", "title" => "Гарри Поттер и Орден Феникса", "date" => "21.07.2003"), array("number" => "Книга 6", "title" => "Гарри Поттер и Принц-полукровка", "date" => "16.07.2005"), array("number" => "Книга 7", "title" => "Гарри Поттер и Дары Смерти", "date" => "21.07.2007")); echo $twig->render("books.html", array("books" => $books));

Настройка базового шаблона

Базовый шаблон представляет собой обычный html документ со специальными вставками:

{% block title %}{% endblock %}

{% block content %} {% endblock %}

В нашем главном шаблоне мы прописываем 2 блока: title и content. Названия блоков выбираем сами.

В последствии, в эти общие блоки мы будем внедрять характерную для дочерних страниц информацию.

Настройка шаблона вывода книг

Для начала в дочернем шаблоне нам необходимо указать шаблон родителя:

{% block title %}Серия романов о Гарри Поттере{% endblock %}

Затем, пишем содержание, которое внедрится в блок под названием content в базовом шаблоне:

{% block content %}

Серия романов о Гарри Поттере

{% for book in books %}

{{book.number}}. "{{book.title}}" - {{book.date}}

{% endfor %}

{% endblock %}

Тут же в цикле for (Twig for) мы проходимся по всем книгам, которые передали в данный шаблон с помощью записи $twig->render("books.html", array("books" => $books)); и для извлечения значений обращаемся к элементам массива по ключам: {{book.number}}, {{book.title}} и так далее.

Таким образом, после срабатывания метода $twig->render("books.html", array("books" => $books)) , Twig подгрузит шаблон books.html и сформирует html содержание. Далее он распознает, что books.html - это дочерний шаблон base.html, и поместит сформированное содержание в базовый шаблон. После всего этого Twig вернёт нам полноценную html страницу.

Итог

Пример работы данного скрипта вы можете посмотреть в demo или скачать архив с готовым примером.

Ждём впечатлений в комментариях. Если вас заинтересовала данная тема, то в дальнейшем мы продолжим разговор о шаблонизаторе Twig.

Twig 2 - Twig for Template Designers

Twig для дизайнеров шаблонов

Этот документ описывает синтаксис и семантику механизма шаблона и будет наиболее полезен в качестве ссылки на те, которые создают шаблоны Twig.

конспект

Шаблон - это просто текстовый файл. Он может генерировать любой текстовый формат (HTML, XML, CSV, LaTeX и т. Д.). У него нет определенного расширения, .html или.xml просто отлично.

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

Ниже приведен минимальный шаблон, который иллюстрирует несколько основ. Ниже мы расскажем о следующих деталях:

My Webpage

Существует два типа разделителей: {% ... %} и {{ ... }} . Первый используется для выполнения таких операторов, как for-loops, последний печатает результат выражения в шаблоне.

Интеграция с IDE

Многие IDE поддерживают подсветку синтаксиса и автозаполнение для Twig:

Textmate через пакет Twig
Vim через плагин синтаксиса Jinja или плагин vim-twig
Netbeans через плагин синтаксиса Twig (до 7.1, родной по 7.2)
PhpStorm (родной от 2.1)
Eclipse через плагин Twig
Возвышенный текст через пакет Twig
GtkSourceView через определение языка Twig (используется gedit и другими проектами)
Coda и SubEthaEdit через синтаксический режим Twig
Coda 2 через другой синтаксический режим Twig
Комодо и Комодо Редактировать через режим Twid подсветки / синтаксиса
Блокнот ++ через Notepad ++ Twig Highlighter
Emacs через web-mode.el
Atom через PHP-ветку для атома
Код Visual Studio через пакет Twig

Реализация

Для удобства foo.bar выполняет следующие действия на уровне PHP:

если нет, и если foo является объектом, проверьте, что bar является допустимым свойством;
если нет, и если foo является объектом, проверьте, что bar является допустимым методом (даже если bar является конструктором - вместо этого используйте __construct());
если нет, и если foo является объектом, проверьте, что getBar является допустимым методом;
если нет, и если foo является объектом, проверьте, что isBar является допустимым методом;
если нет, и если foo является объектом, проверьте, что hasBar является допустимым методом;

foo["bar"] с другой стороны, работает только с массивами PHP:

проверьте, является ли foo массивом и bar действительный элемент;
если нет, верните null значение.

Глобальные переменные

В шаблонах всегда доступны следующие переменные:

_self: ссылается на текущее имя шаблона;
_context: ссылается на текущий контекст;
_charset: ссылается на текущую кодировку.

Установка переменных

Вы можете назначать значения для переменных внутри кодовых блоков. В назначениях используется тег set :

{% set foo = "foo" %} {% set foo = %} {% set foo = {"foo": "bar"} %}

фильтры

Переменные могут быть изменены фильтрами . Фильтры отделяются от переменной символом (|) и могут иметь необязательные аргументы в круглых скобках. Несколько фильтров могут быть скованы цепью. Выход одного фильтра применяется к следующему.

В следующем примере удаляются все теги HTML из name и заголовков:

Фильтры, которые принимают аргументы, имеют круглые скобки вокруг аргументов. Этот пример присоединяется к списку через запятую:

Чтобы применить фильтр к разделу кода, оберните его в тег filter :

{% filter upper %} This text becomes uppercase {% endfilter %}

Members

{{ user.username|e }}

По умолчанию фильтр-победитель использует html стратегию, но в зависимости от контекста экранирования вы можете явно использовать любые другие доступные стратегии:

{{ user.username|e("js") }} {{ user.username|e("css") }} {{ user.username|e("url") }} {{ user.username|e("html_attr") }}

Работа с автоматическим экранированием

Независимо от того, включено ли автоматическое экранирование или нет, вы можете пометить раздел шаблона, который должен быть экранирован или нет, используя тег autoescape :

{% autoescape %} Everything will be automatically escaped in this block (using the HTML strategy) {% endautoescape %}

По умолчанию автоматическое экранирование использует стратегию экранирования html . Если вы выводите переменные в других контекстах, вам необходимо явно избежать их с помощью соответствующей стратегии экранирования:

{% autoescape "js" %} Everything will be automatically escaped in this block (using the JS strategy) {% endautoescape %}

Спасаясь

Иногда желательно или даже необходимо, чтобы Twig игнорировали части, которые иначе обрабатывались бы как переменные или блоки. Например, если используется синтаксис по умолчанию, и вы хотите использовать {{ качестве исходной строки в шаблоне и не запускать переменную, вам нужно использовать трюк.

Самый простой способ - вывести разделитель переменных ({{), используя переменное выражение:

{{ "{{" }}

Для больших разделов имеет смысл отметить блок verbatim .

макрос

Макросы сопоставимы с функциями на обычных языках программирования. Они полезны для повторного использования часто используемых фрагментов HTML, чтобы не повторять себя.

{% if phone matches "/^[\\d\\.]+$/" %} {% endif %}

Оператор сдерживания

Оператор in выполняет тест на герметичность.

Он возвращает true если левый операнд содержится справа:

{# returns true #} {{ 1 in }} {{ "cd" in "abcde" }}

Наконечник

Вы можете использовать этот фильтр для выполнения теста сдерживания на строках, массивах или объектах, реализующих интерфейс Traversable .

Чтобы выполнить отрицательный тест, используйте оператор not in операторе:

{% if 1 not in %} {# is equivalent to #} {% if not (1 in ) %}

Оператор тестирования

Оператор выполняет тесты. Тесты могут быть использованы для проверки переменной на общее выражение. Правильный операнд - это имя теста:

{# find out if a variable is odd #} {{ name is odd }}

Тесты также могут принимать аргументы:

{% if post.status is constant("Post::PUBLISHED") %}

Тесты могут быть сведены на нет с помощью оператора is not:

{% if post.status is not constant("Post::PUBLISHED") %} {# is equivalent to #} {% if not (post.status is constant("Post::PUBLISHED")) %}

Используются для подготовки шаблонов печатных форм, писем, SMS и оповещений. Представляют из себя html-верстку с вкраплениями twig-разметки, поэтому для создания шаблонов необходимы базовые знания html и twig. В системе, как правило, есть ряд заранее подготовленных шаблонов, которые вы можете брать за основу.

Примеры обращений:

{% if order.fromApi %} {{ order.getNickName() }} {% endif %}

Объекты связаны между собой через поля, т.е., обращаясь к полю одного объекта, можно получить другой объект. В таких случаях описание поля в справочнике является ссылкой на объект, который возвращается при обращении к полю.

Пример обращения:

{% if order.getDeliveryType().getCode() == "russian-post" %} {{ order.trackNumber }} {% endif %}

Отмена генерации twig-шаблона

Могут возникать ситуации, когда требуется отменить генерацию шаблона. Например, мы на триггере хотим отправлять письмо с товарными рекомендациями, но, если никаких рекомендаций для клиента не найдено, то генерацию шаблона письма и его отправку производить не надо. Для отмены следует использовать тег {% cancel %} .

Пример использования:

{% set recom = best_selling_products() %} {% if recom|length > 0 %} {# выводим рекомендуемые товары #} {% else %} {% cancel %} {% endif %}

Если срабатывает {% cancel %} , то в это будет зафиксировано:

В теге также можно указать сообщение, которое будет зафиксировано в .

Пример использования с указанием сообщения:

{% set recom = best_selling_products() %} {% if recom|length > 0 %} {# выводим рекомендуемые товары #} {% else %} {% cancel "Не найдено рекомендованных товаров" %} {% endif %}

В журнале действий в этом случае будет следующее:

В случае отмены генерации шаблона письма, SMS или печатной формы, которые генерируются вручную, пользователю будет выведено сообщение, указанное в теге {% cancel %} .

Часто возникающие вопросы

1. Как вывести в шаблоне значение пользовательского поля заказа

Для вывода данных из пользовательского поля используйте метод getCustomField . Пример:

В примере some_code - символьный код пользовательского поля.

2. Ошибка при попытке вывести поле заказа, содержащее дату

Речь о проблеме в случае, когда вы видите следующее сообщение об ошибке:

Calling "__tostring" method on a "DateTime" object is not allowed

Дело в том, что при выводе в twig-шаблоне полей заказа (или клиента), которые содержат дату, требуется применять фильтр date , чтобы указать формат вывода даты.

3. Ошибка при попытке вывести поле, содержащее интервал дат

Речь о проблеме в случае, когда вы видите подобное сообщение об ошибке:

Calling "m" property on a "DateInterval" object is not allowed

Дело в том, что при выводе в twig-шаблоне полей, которые содержат интервал дат, требуется применять фильтр date , чтобы указать формат вывода.

Подробное описание форматов вывода DateInterval можно найти по ссылке: http://php.net/manual/ru/dateinterval.format.php

4. Как вывести текущую дату

Для вывода текущей даты используйте фильтр date следующим образом:

5. Как вывести штрихкод в печатной форме

Вы можете воспользоваться сервисом http://www.barcodes4.me/apidocumentation . Пример подстановки данных: