# CLAUDE.md This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. ## Project overview **Bicycle** — самописный PHP MVC micro-framework (PHP >= 8.2). Название отражает идиому «изобрести велосипед». ## Commands ```bash # Установка зависимостей composer install # Обновление автозагрузчика после добавления классов composer dump-autoload # Запуск всех тестов через Docker (контейнер уже должен быть запущен) docker exec bicycle vendor/bin/phpunit # Один файл / один тест docker exec bicycle vendor/bin/phpunit tests/Unit/RouteTest.php docker exec bicycle vendor/bin/phpunit --filter testControllerAndAction tests/Unit/RouteTest.php ``` Composer-скриптов нет — phpunit вызывается напрямую. Запускать тесты надо именно внутри контейнера: PHP-интерпретатор живёт в Docker, volume `/home/isaevea/http/Bicycle` → `/opt/project`. Проект запускается как веб-приложение через Apache + PHP 8.2 в контейнере `bicycle`. ## Architecture ### Directory layout ``` index.php — точка входа; константы EXT, DOCROOT, APPPATH, SYSPATH System/Classes/ — ядро фреймворка (namespace System\Classes\) System/Classes/HTTP/ — HTTP-инфраструктура: интерфейсы, заголовки, исключения System/Classes/HTTP/Client/ — исходящие HTTP-запросы (Curl, Request, Response) System/Classes/HTTP/Exception/ — HTTPException_403/404 App/Controller/ — контроллеры приложения (namespace App\Controller\) App/Repositories/ — конкретные репозитории (extends System\Classes\Repository), например BudgetRepository App/config/ — конфиги (config.php; config.local.php — в .gitignore) App/view/ — шаблоны приложения (.html файлы с PHP-кодом) App/media/ — статические ресурсы (js, css, img) Services/Auth/ — авторизация: интерфейс AuthDriver + FileAuthDriver (см. раздел Auth ниже) Services/Database.php, DataBase/ — реляционная БД (MariaDB/PDO): фабрика + Model/Classes/{PdoConnection,Statement,Profiler} (см. раздел DataBase ниже) Services/Elasticsearch.php, Elasticsearch/ — поиск: фабрика + Client (REST, см. раздел Elasticsearch ниже) Services/Mongo.php, Mongo/ — документная БД: фабрика + MongoDriver (см. раздел Mongo ниже) Services/Mail/, PDF/ — пустые каталоги-заготовки под будущие сервисы (PHPMailer / dompdf); кода пока нет System/view/ — системные шаблоны (ошибки 404/500/403, exception) tools/sort_html_attrs.php — CLI-утилита сортировки HTML-атрибутов (gitignored: /tools/* в .gitignore) tests/ — PHPUnit тесты ``` > Часть `Services/*` (Mail, PDF) ещё не созданы. `App/Classes/` — уже не пуст: `App\Classes\Currency` > (`const LIST` — код ISO 4217 => название, сейчас RUB/USD/EUR/CNY), используется и в форме счёта > (`App/view/Index/index.html`, `` с токеном. - `CSRF::$key` — имя поля/ключа (по умолчанию `csrf_token`). ### Auth (Services\Auth) Авторизация через сменный драйвер (`Services\Auth\AuthDriver`), как в Kohana Auth: по умолчанию `FileAuthDriver` (логины/пароли из PHP-файла), позже — БД/LDAP/Keycloak как новые классы `implements AuthDriver` без изменения остального кода (тот же принцип, что и `LogReader`/`FileLogReader`). - `Services\Auth::instance(?string $name = null)` — драйвер по имени (кэшируется); без аргумента — драйвер из `Config::get('auth', 'driver')` (по умолчанию `'file'`). - `AuthDriver::login($login, $password)` — проверяет и, если верно, авторизует (пишет в `Session`). - `AuthDriver::logout()` / `loggedIn()` / `getUser()` (без пароля) / `checkPassword($password)` (сверка пароля с текущим авторизованным пользователем, например перед сменой настроек). **Файл пользователей** — `App/config/auth_users.php` (в `.gitignore`, как `config.local.php`): ```php return [ 'admin' => [ 'password' => '', 'full_name' => 'ФИО', 'email' => '...', 'role' => 'admin', // 'admin' | 'manager' | 'user' | ... — своё для каждого проекта ], ]; ``` Путь берётся из `Config::get('auth', 'users_file')`. Поля, кроме `password`, произвольные — `AuthDriver::getUser()` отдаёт их как есть (без `password`); `role` — единственное поле, которое понимает framework-код (`Controller::$_auth_roles`), остальное (`full_name`, `email`, …) — просто проброс для шаблонов/логов. **Контроллеры** включают проверку флагом `$_auth_protection = true` (по умолчанию `false`, как `$_csrf_protection`, но с обратной полярностью — авторизация не обязательна по умолчанию). `$_auth_driver` — имя конкретного драйвера, если контроллеру нужен не дефолтный (`null` = дефолт из конфига). `$_auth_roles` — список разрешённых ролей (`['admin']`, `['admin', 'manager']`); пустой массив (по умолчанию) — любой авторизованный, без проверки роли. Проверка — в `Controller::before()`: нет авторизации → `HTTP::redirect('/login')` напрямую (не через `HTTPException` — редирект гостя на логин не исключительная ситуация, а штатное поведение; раньше это делалось через несуществующий больше `HTTPException_302`, но `throw` этого исключения ушёл бы в `MyException::handler()`, который не вызывает `getResponse()` и настоящий редирект не отправил бы — сам класс требовал прямого вызова `->getResponse()` без throw, что нарушало контракт остальных подклассов `HTTPException` и вводило в заблуждение; убран целиком); авторизован, но роль не подходит → `throw HTTPException::factory(403)`. `App\Controller\Admin\AdminController` включает `$_auth_protection = true` и `$_auth_roles = ['admin']` для всей админки. **Вход/выход** — `App/Controller/LoginController.php` (`/login` — форма и обработка, `/login/logout`), шаблон `App/view/Login/login.html`. Меню сайта (`Controller::menu()`) показывает «Войти» либо «Выйти (логин)» в зависимости от `Auth::instance()->getUser()`; пункт «Админка» виден только при `role === 'admin'`. ### DataBase (Services\Database, System\Classes\Repository) Реляционная БД (MariaDB) через PDO. Конфиг — `Config::get('db', $name)`, ключ `$name` — это имя *подключения*, по умолчанию `'default'`; значение — параметры подключения плоским массивом (`host`/`hosts`/`port`/`user`/`password`/`dbname`/`dialect`/`charset`), без обёртки под тип драйвера — PDO не «драйвер» в смысле выбора между несколькими реализациями (это сама обёртка над клиентской библиотекой конкретной СУБД), других вариантов подключения к реляционной БД в проекте нет, поэтому и нечего выбирать конфигом: ```php use Services\Database; $connection = Database::instance(); // Config::get('db', 'default') $stmt = $connection->query('SELECT * FROM users WHERE id = ?', [42]); $row = $stmt->fetch(); echo $stmt->sq(); // SQL с подставленными параметрами — для дебага (Statement::showQuery()) ``` Подключение — ленивое (первое обращение к `pdo()`/`query()`), с failover: `hosts` (массив) перебирается по порядку до первого успешного, иначе — `MyException` со списком ошибок по каждому хосту. **Диалект** — `dialect` (`'mysql'` по умолчанию, либо `'pgsql'`/`'sqlite'`) переключает только сборку DSN внутри `PdoConnection::buildDsn()` — реестра классов-драйверов по типу СУБД нет (в отличие от `Auth`/`LogReader`), потому что весь остальной код (`Statement`, `Profiler`, SAVEPOINT-транзакции) от диалекта не зависит, это осталось бы дублированием ради дублирования. `sqlite` — особый случай: `dbname` там путь к файлу (или `':memory:'`), а не имя базы на хосте, поэтому у него нет `host`/`hosts`/`user`/`password`/`charset` и failover-перебор для него не запускается (`connect()` подключается напрямую). Расширения `pdo_mysql` и `pdo_sqlite` есть в текущем Docker-образе, `pdo_pgsql` — нет (диалект `pgsql` в коде поддержан, но не проверен вживую). Транзакции на уровне `PdoConnection` — вложенные через SAVEPOINT (`beginTransaction()`/`commit()`/`rollback()` считают уровень вложенности сами), либо через обёртку: ```php $connection->transaction(function ($connection) { $connection->query('UPDATE accounts SET balance = balance - ? WHERE id = ?', [100, 1]); $connection->query('UPDATE accounts SET balance = balance + ? WHERE id = ?', [100, 2]); }); // исключение внутри колбэка → rollback (или ROLLBACK TO SAVEPOINT на вложенном уровне) + повторный throw ``` Тайминги запросов — `Services\DataBase\Classes\Profiler::entries()`/`totalTime()` (наполняется автоматически из `Statement::execute()` — единой точки для любого выполнения запроса, в т.ч. ручного `$connection->prepare()->execute()` в обход `query()`, как делает большинство методов `Repository`). **Repository** — `System\Classes\Repository` (`@template T of object`, abstract CRUD), конкретные — в `App/Repositories/*`. Таблица и класс строки задаются через конструктор, не через переопределение свойства: ```php namespace App\Repositories; use System\Classes\Repository; class BudgetRepository extends Repository { public function __construct(?string $connection = null) { parent::__construct('budget', connection: $connection); // + class-string вторым аргументом, по умолчанию Model::class } } ``` ```php $repo = new BudgetRepository(); // подключение — Database::instance() $repo->get(1); // T|false, через fetchObject() $repo->getItemWhere("status = 'open'"); // T|false|null, произвольное условие (без плейсхолдеров) $repo->getList('*', ['status' => 'open']); // T[]|false; $where — 'col' => 'value' (или 'IS NULL'/'IS NOT NULL') $repo->create(['title' => 'Q3', 'amount' => 1000]); // lastInsertId $repo->update(['id' => 1, 'amount' => 1200]); // primary_col обязателен в $data $repo->delete(1); $repo->deleteWhere('status = ?', ['closed']); $repo->transaction(fn () => /* несколько операций одной транзакцией */ null); // begin/commit/rollBack — делегируют в PdoConnection (там же и SAVEPOINT-логика) ``` `public string $primary_col = 'id'` и `public bool $is_auto_increment = true` — переопределяются в наследнике при необходимости. `processData()` (protected) — общая сборка bind-параметров для `create()`/`update()` с автоопределением `PDO::PARAM_*` по типу значения (массив кодируется в JSON). `getList()` по умолчанию — `$fetch = PDO::FETCH_CLASS`, и в этом случае в `fetchAll()` явно передаётся `$this->obj_class` (не generic `stdClass`) — так же, как в `get()`/`getItemWhere()`. Это сознательное отличие от паттерна, с которого портировали этот класс (`eoffice_v3/System/Classes/Repository.php`): там по умолчанию `PDO::FETCH_KEY_PAIR` (падает, если `$cols` — не ровно 2 колонки — плохой дефолт для общего метода) и `FETCH_CLASS` не прокидывает `obj_class` в `fetchAll()` вовсе (реальная нестыковка между PHPDoc и кодом в оригинале). Транзакции по той же причине не портированы один-в-один: там свой счётчик вложенности в каждом `Repository`, что ломается при двух репозиториях на одном соединении (оба думают, что они «внешние», оба зовут `PDO::beginTransaction()` — исключение); в Bicycle транзакции делегируются в `PdoConnection`, у которого счётчик один на всё подключение. `Model` (`Services\DataBase\Model`, `#[AllowDynamicProperties]`) — лёгкий пассивный носитель данных, это класс по умолчанию для `T` в `Repository`. Свойства настоящие (не спрятаны за внутренним массивом) — это принципиально: `PDO::FETCH_CLASS`/`fetchObject()` выставляет их напрямую, **минуя `__set()`** (внутренний механизм PDO, до вызова конструктора), поэтому попытка перехватить запись через `__set()` в скрытый массив не сработает — `toArray()` вернул бы пусто. Не ActiveRecord — чтение/запись в БД делает `Repository`. ### Elasticsearch (Services\Elasticsearch) Тонкая REST-обёртка на `System\Classes\HTTP\Client\Curl` — без тяжёлой composer-зависимости `elasticsearch/elasticsearch`. Конфиг — `Config::get('elasticsearch', $name)` (`base_url`, `timeout`, опционально `username`/`password` для Basic Auth). ```php use Services\Elasticsearch; $client = Elasticsearch::instance(); $client->index('logs', ['level' => 'error', 'message' => 'boom'], 'log-1'); $client->get('logs', 'log-1'); $client->search('logs', ['query' => ['match' => ['message' => 'boom']]]); $client->delete('logs', 'log-1'); $client->ping(); // false вместо исключения, если кластер недоступен — удобно для graceful skip ``` Контейнер `elasticsearch` в текущей dev-инфраструктуре не поднят (см. `docker-dev/docker-compose.yml`) — `ElasticsearchClientTest` пропускает тесты через `markTestSkipped()`, если `ping()` вернул `false`; оживает сам, без правки кода, как только контейнер появится. ### Mongo (Services\Mongo) Обёртка над `MongoDB\Client` (пакет `mongodb/mongodb`, уже в `composer.json`). **Требует PHP-расширение `ext-mongodb`**, которого пока нет в `docker/php-apache/8.2.8/Dockerfile` (общий для нескольких проектов — трогать его нельзя, см. раздел Apache; расширение добавляет пользователь сам). Код безопасен без расширения — падает только при реальном `new MongoDB\Client()` внутри `MongoDriver::__construct()`, не при простом подключении файла/автозагрузке, поэтому `Mongo::instance()` не вызывать эагерно из bootstrap. Конфиг — `Config::get('mongo', $name)` (`uri`, `database`): ```php use Services\Mongo; $driver = Mongo::instance(); $driver->collection('logs')->insertOne(['level' => 'error']); $driver->database()->listCollections(); ``` `MongoDriverTest` пропускает тесты через `markTestSkipped()`, если `!extension_loaded('mongodb')` — оживает сам, без правки кода, как только пользователь добавит расширение и поднимет контейнер `mongo`. ### ProfilerToolbar (System\Classes\ProfilerToolbar) Debug-панель внизу страницы (аналог [ProfilerToolbar для Kohana](https://github.com/Alert/profilertoolbar)) — портирована не один-в-один: FireBug-вывод (`firebug()`/FirePHP) и подсветка исходников (`debugSource()`/ GeSHi) из оригинала не переносились — устаревшие технологии, не нужны здесь. Вкладки: - **SQL** — из `Services\DataBase\Classes\Profiler` (см. раздел DataBase выше): время, текст запроса, параметры, `EXPLAIN` для SELECT-запросов (прогоняется заново через `Database::instance()` в момент рендера панели, не при исполнении самого запроса; ошибка `EXPLAIN` → `—`, не ломает панель). Сам `EXPLAIN` выполняется с `Statement::$skip_profiling = true` — иначе попал бы в тот же `Profiler` и засорял бы свой же счётчик. - **Vars** — `GET`/`POST`/`COOKIE`/`SESSION`/`SERVER`; чувствительные ключи (`Log::$mask_keys`: `password`, `pass`, `csrf_token`, `token`) маскируются `***` — та же маска, что и в `Log`. - **Files** — все подключённые к запросу файлы (`get_included_files()`) с размером и общим итогом. - **Route** — текущие `uri`/`method`/`controller`/`action`/`params` из `Request::$current`. - **Custom** — появляется, только если код вызвал `ProfilerToolbar::addData($data, $tab = 'custom')` (аналог `addData()` в оригинале) — свободная вкладка для точечной отладки из любого места кода. Подключена прямо в `App/view/layout.html` (`` перед ``) — рендерится для любой страницы сайта, но `render()` отдаёт пустую строку всем, кроме `role === 'admin'` (проверка через `Auth::instance()->getUser()`, как и остальные ролевые проверки в проекте). Верхняя строка сворачивает/разворачивает панель, кнопки переключают вкладки — инлайн `onclick` + один `