Ваш перший сайт

Від порожньої інсталяції до власного розділу, що відображає власний компонент через XSLT-шаблон. Вам знадобиться порожній варіант Встановлення та його адміністратор. Команди виконуються в папці проєкту від імені користувача сайту.

Під час розробки тримайте 'debug' => 1 у htdocs/system.config.php, а після змін запускайте php index.php setup linker з htdocs/. На робочому сайті поверніть значення 0.

1. Розділ

  1. Увійдіть за адресою /login/ та відкрийте «Управление структурой» (Управління структурою), /admin/structure/.
  2. Виберіть у дереві «Главная страница» (Головна сторінка) і натисніть «Добавить» (Додати) — плюс під деревом.
  3. Заповніть форму:
    • «Содержимое страницы» (Вміст сторінки) — «Текстовая страница» (Текстова сторінка);
    • «Макет страницы» (Макет сторінки) — «Базовый» (Базовий); обидва списки відкриваються на інших пунктах, тож виберіть обидва;
    • «Сегмент URI» (URI-сегмент) — releases;
    • на вкладках «Русский» і «Українська», «Название раздела» (Назва розділу) — Releases: назва обов'язкова для кожної мови.
  4. Натисніть «Сохранить» (Зберегти).

Розділ відкривається за адресою /releases/ із назвою як заголовком, і головне меню відображає його: новий розділ отримує тег menu.

2. Текст

На сторінці /releases/ увімкніть «Режим редактирования» (Режим редагування) на панелі інструментів сторінки, клацніть текстовий блок — він показує --, якщо порожній — і введіть текст. Текст зберігається при виході зі сторінки: вимкніть режим редагування. Робіть це у Firefox: браузери на основі Chromium — Chrome, Edge — блокують цей запит, і текст втрачається.

3. Компонент

Створіть site/modules/main/components/ReleaseList.php:

<?php
namespace EnergineSite\main\components;

use Energine\share\components\DataSet;
use Energine\share\gears\DataDescription;
use Energine\share\gears\FieldDescription;
use Energine\share\gears\SimpleBuilder;

class ReleaseList extends DataSet {
    public function __construct($name, ?array $params = null) {
        parent::__construct($name, $params);
        $this->setType(self::COMPONENT_TYPE_LIST);
    }

    protected function createBuilder() {
        return new SimpleBuilder();
    }

    protected function createDataDescription() {
        $result = new DataDescription();
        foreach (['version', 'note'] as $fieldName) {
            $field = new FieldDescription($fieldName);
            $field->setType(FieldDescription::FIELD_TYPE_STRING);
            $result->addFieldDescription($field);
        }
        return $result;
    }

    protected function loadData() {
        return [
            ['version' => '2.12', 'note' => 'PHP 5.5+'],
            ['version' => '2.13', 'note' => 'PHP 8.4+, MariaDB 10.11+'],
        ];
    }
}

Автозавантажувач Composer стартового набору відображає EnergineSite\ на site/modules/, тому клас не потребує реєстрації. DataSet формує XML компонента: createDataDescription() визначає поля, loadData() повертає рядки, а SimpleBuilder їх записує. Компонент не є активним, тому конфігурація йому не потрібна.

4. Шаблон сторінки

Скопіюйте текстову сторінку ядра до вашого сайту:

cp core/modules/share/templates/content/textblock.content.xml site/modules/main/templates/content/releases.content.xml

У releases.content.xml додайте ваш компонент після компонента textBlock_1:

<component name="releaseList" class="EnergineSite\main\components\ReleaseList"/>

Новий шаблон потребує посилання в htdocs/:

cd htdocs
php index.php setup linker

У «Управление структурой» виберіть «Releases», натисніть «Редактировать» (Редагувати) — олівець, оберіть CONTENT_RELEASES у «Содержимое страницы» і збережіть. Шаблон відображає свою константу, доки для неї немає перекладу: додайте CONTENT_RELEASES у «Редактор переводов» (Редактор перекладів), щоб дати їй назву. Текст з кроку 2 залишається: це перший текстовий блок цієї сторінки.

5. XSLT-шаблон

Створіть site/modules/main/transformers/releases.xslt:

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

    <xsl:template match="component[@class='ReleaseList']" priority="1">
        <ul class="release_list">
            <xsl:for-each select="recordset/record">
                <li>
                    <strong><xsl:value-of select="field[@name='version']"/></strong>
                    <xsl:text>: </xsl:text>
                    <xsl:value-of select="field[@name='note']"/>
                </li>
            </xsl:for-each>
        </ul>
    </xsl:template>

</xsl:stylesheet>

та підключіть його в site/modules/main/transformers/include.xslt після energine.xslt:

<xsl:include href="releases.xslt"/>

priority="1" ставить ваш шаблон вище загального вигляду списків. Таблиці стилів читаються там, де знаходяться, тому повторний запуск setup не потрібен: перезавантажте /releases/, і під текстом список відобразить «2.12: PHP 5.5+» та «2.13: PHP 8.4+, MariaDB 10.11+».

6. XML сторінки

З увімкненим режимом налагодження /releases/?debug повертає XML сторінки. Ваш компонент присутній там як <component name="releaseList" componentAction="main" class="ReleaseList" … type="list"> з <recordset> із елементів <record> і <field name="version"> у кожному: саме це й збігається з вашим шаблоном. Дивіться Компоненти та XSLT-шаблони.

Що потребує повторного запуску setup

Зміна Запуск
PHP-клас у site/modules/main/components/ не потрібен
новий файл у site/modules/main/templates/ php index.php setup linker
редагування шаблону, конфігурації або таблиці стилів не потрібен
нове зображення, скрипт або стиль php index.php setup linker, а для скрипта ще й php index.php setup scriptMap
значення debug php index.php setup linker