ave-cms/help/README.md

AVE.cms — документация

Справочник по компонентам движка. Разделы раскладываются по папкам — по одному компоненту (или группе) на описание.

Название системы — AVE.cms. В документации слова «панель управления» и «админка» обозначают административный интерфейс AVE.cms. adminx/ — имя его технического каталога по умолчанию и часть внутренних имён API, а не название отдельного продукта. Каталог можно переименовать при установке или позднее.

Разделы

Раздел	Описание
Установка	Чистая установка AVE.cms, требования, первый вход и защита от повторного запуска.
Управление системой	Карта core-разделов панели: дашборд, пользователи, настройки, БД, события и эксплуатация.
Как собирается сайт	Шаблоны, рубрики, поля, документы, меню, запросы, блоки и универсальный каталог: связи и порядок публичного рендера.
Ядро и жизненный цикл запроса	Инициализация (App::init), маршрутизация, контроллеры, авторизация, сессии/CSRF, права.
Модульная система	Модули панели управления и составные пакеты AVE.cms: manifest, установка, обновление, удаление, ZIP, миграции и вклады в UI.
Поля документов	Архитектура полей, настройки, хранение, шаблоны и разработка собственного типа.
Медиа и миниатюры	Файловый браузер, генерация превью, режимы размеров, WebP и очистка производных файлов.
Хуки и события	Подписка на события ядра, контексты, каталог хуков, изменение данных и отладка.
Публичная отладка	Защищённый Debug Toolbar на сайте, его вкладки, доступ и собственные вызовы Debug::panel().
HTTP API	Токены, JSON API документов, форматы запросов и ответов, ошибки и безопасность.
Работа с базой данных	Фасад DB, плейсхолдеры запросов, чтение результатов, CRUD, транзакции, кеш запросов, резолверы имён таблиц.
Безопасность файлов	SHA-256 эталон, эвристический анализ, защита загрузок, карантин и автоматические проверки.
Хелперы фреймворка	26 статических хелперов: строки, массивы, HTTP-запрос/ответ, валидация, файлы, безопасность, дата/число и т. д.

Соглашения

• Код совместим с PHP 7.3 (без стрелочных функций, ??=, типизации свойств и т. п.).
• Классы ядра и установленных модулей подключаются штатным загрузчиком; ручные require для классов не нужны.
• Почти все хелперы — статические (Helper::method()), состояние не хранят.
• Пути к файлам приложения стройте относительно BASEPATH, не привязываясь к расположению проекта на конкретном сервере.

Документация описывает поддерживаемые контракты движка. Непубличные детали реализации могут меняться между версиями.