XSLT-представления

XML-документ страницы, собранный из её компонентов, преобразуется в HTML с помощью таблиц стилей XSLT 1.0, выполняемых PHP-классом XSLTProcessor (libxslt). В таблицах стилей используются функции EXSLT set:distinct и dyn:evaluate; функции PHP в них недоступны.

Главная таблица стилей

Параметр конфигурации document.transformer — main.xslt в стартовом шаблоне — задаёт имя главной таблицы стилей в site/modules/main/transformers/. Файл из стартового шаблона подключает представления всех модулей, а затем собственные представления сайта:

<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
    <xsl:output method="html" doctype-system="about:legacy-compat"/>
    <xsl:include href="../../../../core/modules/share/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/user/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/calendar/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/apps/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/forms/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/comments/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/mail/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/ads/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/blog/transformers/include.xslt"/>
    <xsl:include href="../../../../core/modules/shop/transformers/include.xslt"/>
    <xsl:include href="include.xslt"/>
</xsl:stylesheet>

Файл сайта include.xslt подключает energine.xslt, страницу сайта: его шаблон match="/" формирует <html> с заголовком и телом страницы, а match="document" размещает компоненты макета и контент. Таблицы стилей считываются непосредственно из мест их расположения — они не линкуются в htdocs, поэтому при их редактировании не нужно запускать установку, — и компилируются при каждом запросе: кэша таблиц стилей нет.

Что получает таблица стилей

XML страницы содержит корневой элемент <document> с атрибутами debug и editable, а внутри него:

  • <properties> — заголовок страницы (title), ключевые слова (keywords), описание (description), директивы robots и шаблон, адрес сайта (base с адресами статических файлов, медиа и сервиса масштабирования изображений) и язык;
  • <layout> и <content> — компоненты и контейнеры шаблонов;
  • <translations> — строки интерфейса, зарегистрированные компонентами;
  • <javascript> — скрипты, необходимые компонентам.

document.xslt передаёт им глобальные переменные: $DOC_PROPS, $COMPONENTS, $TRANSLATION, $BASE, $LANG_ID, $LANG_ABBR, $STATIC_URL, $MEDIA_URL, $RESIZER_URL и другие.

Сопоставление компонентов

Элемент компонента содержит name, class — короткое имя класса, componentAction — его действие (состояние) — и такие свойства, как type (list или form), exttype (grid для таблиц данных) и sample. Шаблоны сопоставляются по ним:

  • component[@type='list'] и component[@type='form'] — базовые представления списков и форм;
  • component[@sample='TextBlock'] выводит каждый текстовый блок;
  • собственный класс сопоставляется с помощью component[@class='Hello'].

Представление текстового блока:

<xsl:template match="component[@sample='TextBlock']">
    <xsl:if test="@editable or recordset/record/field != ''">
        <div class="textblock">
            <xsl:apply-templates/>
        </div>
    </xsl:if>
</xsl:template>

Два класса с одинаковым коротким именем сопоставляются одинаково: Energine\apps\components\Ads и Energine\ads\components\Ads имеют имя Ads, и макет стартового шаблона различает их по имени (name). XML, для которого нет подходящего шаблона, копируется на страницу без изменений.

Изменение представления

Поместите ваши шаблоны в файл в каталоге site/modules/main/transformers/ и подключите его в файле сайта include.xslt. Он подключается после файлов ядра, поэтому шаблон с таким же паттерном заменит шаблон ядра; более точный паттерн или явный атрибут priority сделают выбор однозначным.

Заголовок страницы, стили и скрипты

document.xslt формирует секцию <head>: заголовок (собственный HTML-заголовок страницы или «хлебные крошки»), <base>, stylesheets/energine.css, файлы сайта stylesheets/main/main.css и print.css, а также метатеги. Затем подключаются MooTools 1.5.2 и scripts/Energine.js. Поведения (behaviours), указанные компонентами в их конфигурациях, загружаются через карту скриптов htdocs/system.jsmap.php, которую генерирует команда php index.php setup scriptMap; без этой карты ни одна страница не будет сформирована. jQuery 2.1.4 загружается с Google CDN и только для тех поведений, которым он требуется; см. Известные риски. Пустой шаблон match="/" mode="scripts" в document.xslt предназначен для размещения собственных скриптов.

Просмотр XML

При включённом параметре debug в конфигурации добавление ?debug к адресу страницы возвращает XML-документ страницы вместо HTML, а страницы ошибок показывают имя файла и строку. На рабочем сервере режим debug должен быть отключён.

Другие таблицы стилей выбираются в коде: error_page.xslt для ошибок, шаблоны модуля seo для robots.txt и карты сайта, rss.xslt для новостной ленты и окна single_*.xslt модуля интернет-магазина.