- Главная
- Документация
- Структура проекта
Структура проекта
Сайт на 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 и другие библиотеки — это файлы в репозитории, а не пакеты.