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

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

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

## Разделы

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

## Соглашения

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

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