[Twiggy] - шаблонизатор TWIG в MODX Revolution

Пакет Twiggy представляет из себя парсер расширяющий modParser.
Twiggy перехватывает обработку twig тегов на странице.
Подробнее ознакомится с TWIG можно на официальном сайте и на сайте сообщества TWIG.

При установке пакета в контексте web создаются две настройки:

• parser_class — класс парсера
• parser_class_path — путь к классу парсера

Соответственно twiggy парсер используется только для данного контекста web.


настройки пакета

• twiggy_extensions — список активных расширений через запятую, для подключения в Twiggy.
• twiggy_path_extensions — путь для загрузки расширений Twiggy.
• twiggy_path_templates — путь для загрузки шаблонов Twiggy.
• sandbox — разрешить режим песочницы, при подключении шаблона в Twiggy.

настройки twig

Настройки twig вынесены в отдельную секцию. Доступны следующие настройки:

• debug: При установке в true, генерируемые шаблоны имеют__toString() метод, который можно использовать для отображения сгенерированных узлов (по умолчанию false).
• charset: Кодировка, используемая в шаблонах (по умолчанию в UTF-8)
• base_template_class: Шаблон базового класса, который используют для сгенерированных шаблонов (по умолчанию Twig_Template).
• cache: Абсолютный путь, где хранятся скомпилированные шаблоны или false чтобы отключить кэширование (который по умолчанию).
• auto_reload: При разработке с Twig, полезно повторно компилировать шаблон при изменении кода-исходника. Если вы не установили значение опции auto_reload, то она будет определена автоматически на основании переменной debug.
• strict_variables: Если установлено false, Twig будет по умолчанию игнорировать недействительные переменные (переменные и или атрибуты/методы, которые не существуют) и заменять их значением null. Когда устанавлено true, Twig генерирует исключение (по умолчанию false).
• autoescape: Если установить true, авто-сохранение будет разрешено по умолчанию для всех шаблонов (по умолчанию true). Начиная с Twig 1.8, вы можете выбрать какую методику сохранения использовать (html, js, false для блокировки). Начиная с Twig 1.9, вы можете выбрать какую методику сохранения использовать (css, url, html_attr, или обратный вызов PHP, который берет шаблон “имя файла” и должен вернуть методику сохранения для использования — обратный вызов не может быть названием функции, чтобы избежать конфликта (коллизии) со встроенными методами сохранения. optimizations: Флаг, который указывает, какие оптимизации применять (по умолчанию -1 — все оптимизации разрешены; установите его на 0 для отключения).

настройки sandbox

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

• sandbox_tags — список разрешенных тэгов через запятую, для подключения в режиме песочницы.
• sandbox_filters — список разрешенных фильтров через запятую, для подключения в режиме песочницы.
• sandbox_methods — строка, закодированная в JSON, с разрешенными методами для подключения в режиме песочницы.
• sandbox_properties — строка, закодированная в JSON, с разрешенными свойствами для подключения в режиме песочницы.
• sandbox_functions — Список разрешенных функций через запятую, для подключения в режиме песочницы.

расширения twig

По умолчанию twig запускается со следующими расширениями

• Twig_Extension_Core — определяет все основные возможности Twig.
• Twig_Extension_Escaper — добавляет автоматический вывод данных-сохранение, а также возможность сохранить/пропустить блоки кода
• Twig_Extension_Optimizer — оптимизирует древо узлов перед компиляцией

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

— файл расширения должен лежать по пути указанному в path_extensions
— имя класса расширения соответствует TwiggyExtensionимя
— имя расширения должно быть указано в настройке extensions

шаблоны twig

Twiggy автоматически подгружает шаблоны с таблицы modTemplate, а так же файловые шаблоны из папки указанной в настройке path_templates
Имена шаблонов соответствуют их названиям, например

создадим шаблон base в MODX

<!DOCTYPE html> 
<html>
    <head>
        {% block head %}
            <link rel="stylesheet" href="style.css" />
            <title>{% block title %}{% endblock %} - Мой сайт</title>
        {% endblock %}
    </head>
    <body>
        <div id="content">{% block content %}{% endblock %}</div>
        <div id="footer">
            {% block footer %}
                © Copyright 2013 <a href="http://example.com/">Вы</a>.
            {% endblock %}
        </div>
    </body>
</html>

создадим расширяющий шаблон

{% extends "base" %}

{% block title %}Главная{% endblock %}
{% block head %}
    {{ parent() }}
    <style type="text/css">
        .important { color: #336699; }
    </style>
{% endblock %}
{% block content %}
    <h1>Главная</h1>
    <p class="important">
        Приветсвую на своем потрясном сайте!
    </p>
{% endblock %}

доступные переменные
Доступны следующие глобальные переменные

• get — $_GET
• post — $_POST
• session — $_SESSION
• cookie — $_COOKIE
• request — $_REQUEST
• files — $_FILES
• server — $_SERVER
• modx — $modx
• pls — массив доступных плейсходеров

расширения Tools
Для большего удобства написано небольшое расширения Tools github.com/vgrish/twiggy/blob/master/core/components/twiggy/elements/extensions/tools.class.php

там описаны основные функции и фильтры для комфортной работы с MODX api.
Ниже несколько примеров:

вывести заголовок ресурса

{{ modx.resource.pagetitle }}
//или
{{ resource('pagetitle') }}

получить объект modUserProfile и преобразовать в json

{{ getObject('modUserProfile', {'email':'admin@vgrish.ru'})|toJson }}

вывести почту авторизованного пользователя

{{ profile('email') }}

подсчитать кол-во modUserProfile

{{ getCount('modUserProfile') }}

вывести чанк

{{ chunk('@INLINE {{ name }} - {{ fio }}', data) }}

обратится к процессору и вывести результат работы

{% set response = processor('mgr/valute/getlist',{'ns':'currencyrate', 'sortdir':'asc'}) %}
{# { dump(response) }#}
{% for result in response.response.results %}
    <li>
        {{ result.name }}
    </li>
{% endfor %}

лексиконы

{{ loadLexicon('ru:core:default') }}
{{ _('access_denied') }}

и тд. Если вам интересны задавайте вопросы.

расширение Cache
Написано небольшое расширение для кэширования секций Cache github.com/vgrish/twiggy/blob/master/core/components/twiggy/elements/extensions/cache.class.php

пример, указываем ключ кэша и время

{% cache 'neighbors' 3000 %}
    {{ snippet('pdoNeighbors') }}
{% endcache %}

расширение DebugBar
phpdebugbar.com/
пример вывода

{% if hasSessionContext('mgr') %}

{{ dbgHead() }}
{{ dbgMessage(array) }}
{{ dbgRender() }}

{% endif %}

уницикация
Для большей унификации описаны методы getChunk и parseChunk аналогичные методам из пакета pdoTools Василия Наумкина.

$Twiggy->getChunk('twig', $row);

Код на github, создавайте isuue
Готовый пакет пока можно установить из моего репозитория rstore.pro/extras/

PS. Не рекомендую к установке на рабочие проекты
Чтобы отключить работу Twiggy парсера достаточно удалить настройки из контекста

// Пример ошибки при выводе ресурса через функцию dump() из modHelpers.
Unexpected token '<' in expression in e4d771b3eb4eed60131330f50f7a360d line 2, near '{<' <- there