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

Сайт на Energine 2.13 складається з двох папок: ядро — клон репозиторію — і ваш проєкт, копія його starter/.

Ядро

energine/
├── core/modules/     the eleven modules: share, user, apps, forms, seo, calendar, comments, mail, ads, blog, shop
├── starter/          the starter project you copy
├── tools/            install-check.sh — the release's clean-install check
└── README.md  INSTALL.md  CHANGELOG.md  LICENSE

Модуль містить components/ (класи компонентів, простір імен Energine\<module>\components), gears/ (інші класи), config/ (<Class>.component.xml), templates/content/ і templates/layout/ (шаблони сторінок), transformers/ (XSLT із файлом include.xslt), а також scripts/, stylesheets/, images/.

Ваш проєкт

my-site/
├── htdocs/           the document root
│   ├── index.php  bootstrap.php  auth.php  resizer/
│   ├── uploads/      uploaded files
│   ├── system.config.php   your configuration
│   └── images/  scripts/  stylesheets/  templates/  system.jsmap.php   made by setup
├── site/modules/main/   your site's code
├── core/modules/     links to the core's modules, made by setup
├── setup/            the console tool
├── sql/              the database: an empty site and a site with demo content
├── configs/          the configuration template
├── cli/              mail_sender.php — sends the newsletters
├── jambalaya/        nginx and Apache examples
└── composer.json  composer.lock  vendor/

htdocs/auth.php обробляє форму входу; htdocs/resizer/ — ресайзер зображень TimThumb.

Код вашого сайту: site/modules/main

  • components/, gears/ — ваші класи: Composer завантажує EnergineSite\main\components\<Class> з site/modules/main/components/<Class>.php.
  • config/ — конфігурації компонентів; файл із назвою конфігурації ядра замінює її.
  • templates/content/, templates/layout/ — ваші шаблони сторінок; стартовий проєкт зберігає тут шаблони адмін-сторінок.
  • transformers/ — main.xslt, точка входу XSLT-представлень, include.xslt, energine.xslt із макетом сторінки та error_page.xslt.
  • scripts/, stylesheets/, images/ — підключаються до htdocs/scripts/main/, htdocs/stylesheets/main/, htdocs/images/main/.

Назва папки main — це «Вариант дизайна» (варіант дизайну) сайту; інший сайт може мати власну папку.

Setup

Setup запускається з htdocs/ від імені користувача сайту, лише з консолі, і завершується з ненульовим кодом виходу в разі помилки:

Команда Що робить
php index.php setup install перевіряє базу даних, записує адресу сайту, потім виконує linker і scriptMap
php index.php setup linker підключає модулі ядра до core/modules/ і наповнює htdocs/images/, scripts/, stylesheets/ та templates/: файли ядра — безпосередньо, файли вашого сайту — до main/; якщо режим налагодження вимкнено, скрипти копіюються у стисненому вигляді
php index.php setup scriptMap записує htdocs/system.jsmap.php — залежності скриптів; без нього жодна сторінка не будується
php index.php setup syncUploads реєструє файли, що вже знаходяться в htdocs/uploads/public/, у файловому репозиторії
php index.php setup untranslated, exportTrans, loadTransFile рядки інтерфейсу; див. Мови інтерфейсу

Запускайте linker після додавання файлів до site/modules/main/ (шаблони, скрипти, стилі, зображення), після оновлення або переміщення ядра чи проєкту, а також після зміни debug; запускайте scriptMap після додавання скрипту. PHP-класи, конфігурації та XSLT-таблиці стилів читаються безпосередньо з місця розташування.

Файли та кеші

  • htdocs/uploads/public/ — файловий репозиторій; uploads/temp/ — файли в процесі завантаження; uploads/tmp/ — тимчасові файли.
  • Ресайзер зображень кешує у системній тимчасовій папці.
  • Якщо site.cache увімкнено, структура бази даних кешується у папці cache/ проєкту.
  • Composer встановлює symfony/console та його залежності до vendor/; він використовується cli/mail_sender.php. MooTools, CKEditor, TimThumb та інші бібліотеки — це файли в репозиторії, а не пакети.