Компоненти

Сторінка Energine — це набір компонентів. Компонент — це PHP-об'єкт, який виконує одне завдання: меню, текстовий блок, список новин, редактор — і повертає результат у вигляді XML. Компоненти сторінки формують один XML-документ, а XSLT перетворює його на HTML; див. XSLT-представлення.

Від адреси до сторінки

  1. Веб-сервер передає кожну адресу, що не є файлом, до htdocs/index.php; bootstrap.php завантажує автозавантажувач Composer і конфігурацію htdocs/system.config.php.
  2. DocumentController отримує мову з адреси й створює Document. Документ знаходить сторінку за адресою та правами відвідувача на неї: немає прав — 403, немає сторінки — 404. Сторінка з адресою перенаправлення відповідає перенаправленням (302) на неї.
  3. Шаблони макету й вмісту сторінки об'єднуються в одну структуру, і кожен <component> у ній стає об'єктом; див. Шаблони сторінок.
  4. Кожен компонент виконується: зчитує свою дію з решти адреси й готує дані.
  5. Якщо в адресі залишилися сегменти, які не використала ні сторінка, ні жоден компонент, відповідь — 404.
  6. Документ формується як єдиний XML-документ, а трансформер перетворює його на відповідь.

Класи

Кожен компонент розширює Energine\share\components\Component; більшість використовують один з його нащадків:

Клас Що додає
Component ім'я та параметри; стан — дію, обрану з адреси, — з її конфігурацією та правами; build(), який виводить елемент <component>
DataSet опис даних, дані, панелі інструментів, поведінки JavaScript і пейджер; типи list і form
DBDataSet таблицю бази даних (параметр tableName) і її таблицю <table>_translation для мов; стовпці стають описом даних
Grid адміністративний редактор таблиці: список із фільтром, сортуванням і сторінками, форми додавання й редагування, видалення, впорядкування та експорт у CSV

DataSet будує свій XML у prepare(): опис даних — <fields> конфігурації, зіставлені з тим, що повертає loadDataDescription(), — пейджер, дані з loadData(), панель інструментів і скрипти. Підклас зазвичай перевизначає loadData(), який повертає масив рядків або false, або опис даних.

Параметри

Шаблон розміщує компонент разом із його параметрами; ось топові новини головної сторінки:

<component name="topNews" class="Energine\apps\components\NewsFeed">
    <params>
        <param name="title">TXT_TOP_NEWS</param>
        <param name="limit" type="hidden">5</param>
        <param name="showAll">1</param>
        <param name="active" type="hidden">0</param>
        <param name="template">news</param>
    </params>
</component>
  • class є обов'язковим і містить повне ім'я класу: об'єкт створюється так, як вказано, без пошуку за скороченим іменем.
  • name задає ім'я компонента в XML сторінки; без нього генерується випадкове ім'я.
  • Кожен клас оголошує свої параметри; невідомий параметр зупиняє сторінку з повідомленням «Компоненту передан неизвестный параметр.».
  • a|b|c перетворюється на список, так само як кілька <param> з однаковим іменем.
  • Кожен компонент знає state, rights, config і active; DataSet додає recordsPerPage, title і template; DBDataSet додає tableName, onlyCurrentLang і editable.

Стани та конфігурація

Дії компонента — це його стани, описані в його конфігурації, <Class>.component.xml. Частина конфігурації текстового блоку:

<configuration>
    <state name="main">
        <javascript>
            <behavior name="PageEditor"/>
        </javascript>
    </state>
    <state name="save" rights="3">
        <uri_patterns>
            <pattern>/save-text/</pattern>
        </uri_patterns>
    </state>
</configuration>
  • Активний компонент — параметр active; кожен Grid є таким — потребує конфігурації. Він обирає стан, чий <pattern> збігається з рештою адреси, і викликає метод <state>State() або <state>(), передаючи заповнювачі патерну як аргументи. Якщо жоден патерн не збігається, залишається значення параметра state, типово main.
  • У патерні [name] відповідає одному сегменту адреси, а [any]/ — решті: /get-data/[sortField]-[sortDir]/page-[pageNumber]/. Стани, перелічені першими, перевіряються першими.
  • Стан може задавати rights, власні <params>, <fields> свого списку чи форми, <toolbar> із кнопками <control>, поведінки <javascript> і <translations>, потрібні його представленню.
  • Конфігурація шукається за параметром config, потім як <Class>.component.xml у site/modules/main/config/, далі в config/ модуля, потім у конфігураціях батьківських класів. Конфігурація сайту з іменем файлу класу, таким чином, замінює конфігурацію ядра.

Права

Рівень Константа Назва
0 ACCESS_NONE «Права отсутствуют»
1 ACCESS_READ «Только чтение»
2 ACCESS_EDIT «Редактирование»
3 ACCESS_FULL «Полный доступ»

Права встановлюються для кожної сторінки та групи на вкладці «Права на страницу» форми сторінки; права відвідувача на сторінку визначаються як найвищий рівень з-поміж усіх його груп. У стартовому наборі є групи «Администратор», «Гость» і «Пользователь».

Компонент виконується лише тоді, коли права відвідувача на сторінку досягають його рівня: атрибут rights поточного стану або, за його відсутності, параметр rights компонента. Якщо не вказано жодного, рівень дорівнює правам самого відвідувача, і компонент виконується для всіх, хто може відкрити сторінку: власним редакторам задавайте <param name="rights">3</param>. Компонент, що перевищує рівень прав відвідувача, не включається до XML сторінки.

Режим редагування на сторінці потребує повного доступу.

Вікна адміністрування

<page address>/single/<component name>/<action> будує лише вказаний компонент сторінки. Таким чином Grid відкриває форми додавання й редагування — у вікні поверх списку.

Власний компонент

Автозавантажувач Composer стартового набору відображає EnergineSite\ на site/modules/:

  • клас EnergineSite\main\components\Hello знаходиться у site/modules/main/components/Hello.php;
  • шаблон розміщує його за повним іменем: <component name="hello" class="EnergineSite\main\components\Hello"/>;
  • його конфігурація, якщо вона потрібна, — це site/modules/main/config/Hello.component.xml;
  • його представлення — це XSLT-шаблон для component[@class='Hello'] у таблицях стилів сайту — див. XSLT-представлення.

Перший сайт будує його крок за кроком.