rjm/blackhole-framework

Small REST PHP framework base on ADR pattern

2.1.2 2025-12-25 15:10 UTC

Requires

• php: >=8.3
• ext-json: *
• composer/xdebug-handler: ^3.0
• filp/whoops: ^2.15
• guzzlehttp/guzzle: ^7.8
• haydenpierce/class-finder: ^0.5.3
• laminas/laminas-diactoros: ^3.3
• monolog/monolog: ^3.6
• nikic/fast-route: ^1.3
• nyholm/psr7: ^1.8
• php-di/php-di: ^7.0
• psr/http-server-middleware: ^1.0
• spiral/roadrunner-cli: ^2.6
• spiral/roadrunner-http: ^3.5
• symfony/console: ^7.1
• vlucas/phpdotenv: ^5.6

MIT

• RJM

README

Hi there, I'm Eugene !

HSE student, Web Developer 🇷🇺

BlackHole FrameWork

ADR фреймворк для REST API.

Код приложения находится в директории /app.

Примеры реализации находятся в директории app

Директория core является ядром проекта, редактируйте с аккуратностью!

ADR

Для базового использования нужно

1) Создать Action, имплементируемый в BlackHole\Interfaces\ActionInterface в директории app/Actions 2) Создать Domain, имплементируемый в BlackHole\Interfaces\DomainInterface в директории app/Domains 3) Создать роут в app/routes.php, с хендлером в виде созданного Action

Middleware

При потребности, можно создать Handler в директории app/Middleware имплементируемый от BlackHole\Interfaces\HandlerInterface

Логгирование

Логгер создает директории в логи в app/Logs при настройке в файле .env LOGGER_ON="true"

(Не забудьте добавить .env файл скопировав содержимое из dev.env)

CLI помощник

BlackHole имеет встроенного cli помощника hawking

Примечание: hawking создает файлы соответсвенно каноническим namespace в канонических директориях,а также изменяет имя файла, если оно некорректное

Примеры

имя ActionTest, преобразуется в TestAction, имя Test преобразуется в TestAction

Test\TestAction создается в app\Actions\Test\TestAction.php c соответсвующим namespace

Примеры используемых команд 1) Создание Action

php hawking create:action ExampleAction
php hawking create:action Example\ExampleAction

2) Создание Domain

php hawking create:domain ExampleDomain
php hawking create:domain Example\ExampleAction

3)Создание Middleware handler для request и response

php hawking create:handler:request ResponseHandler
php hawking create:handler:response Example\ExampleHandler

4) Старт сервера

php hawking serve