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