php slim skeleton

Скелет, управляемый событиями, Slim 4 Framework

---

Скелет Slim 4 Framework, управляемый событиями, с использованием AMQP и CQRS

Установка

Профиль установки по умолчанию

Профиль установки по умолчанию не имеет примеров. Вы должны использовать этот профиль, если вы знаете, что случилось, и хотите начать с чистого сланца.

 > composer create-project robiningelbrecht/php-slim-skeleton [app-name] --no-install --ignore-platform-reqs --stability=dev
# Build docker containers
> docker-compose up -d --build
# Install dependencies
> docker-compose run --rm php-cli composer install

Полный профиль установки

Полный профиль установки имеет полный рабочий пример.

 > composer create-project robiningelbrecht/php-slim-skeleton:dev-master-with-examples [app-name] --no-install --ignore-platform-reqs --stability=dev
# Build docker containers
> docker-compose up -d --build
# Install dependencies
> docker-compose run --rm php-cli composer install
# Initialize example
> docker-compose run --rm php-cli composer example:init
# Start consuming the voting example queue
> docker-compose run --rm php-cli bin/console app:amqp:consume add-vote-command-queue

Некоторые примеры

Регистрация нового маршрута

 namespace App  Controller ;

class UserOverviewRequestHandler
{
    public function __construct (
        private readonly UserOverviewRepository $ userOverviewRepository ,
    ) {
    }

    public function handle (
        ServerRequestInterface $ request ,
        ResponseInterface $ response ): ResponseInterface
    {
        $ users = $ this -> userOverviewRepository -> findonyBy ( /*...*/ );
        $ response -> getBody ()-> write ( /*...*/ );

        return $ response ;
    }
}

Перейдите к config/routes.php и добавьте маршрут для вашего запроса handler:

 return function ( App $ app ) {
    // Set default route strategy.
    $ routeCollector = $ app -> getRouteCollector ();
    $ routeCollector -> setDefaultInvocationStrategy ( new RequestResponseArgs ());
    
    $ app -> get ( ' /user/overview ' , UserOverviewRequestHandler::class. ' :handle ' );
};

Полная документация

Консольные команды

Консольное приложение использует компонент консоли Symfony для использования функциональности CLI.

#[AsCommand(name: ' app:user:create ' )]
class CreateUserConsoleCommand extends Command
{
    protected function execute ( InputInterface $ input , OutputInterface $ output ): int
    {
        // ...
        return Command:: SUCCESS ;
    }
}

Полная документация

Команды доменов и обработчики команд

Скелет позволяет вам использовать команды и обработчиков команд для выполнения действий. Эти 2 всегда входят в пары при создании новой команды в модели записи, также должен быть создан соответствующий обработчик команды.

Создание новой команды

 namespace App  Domain  WriteModel  User  CreateUser ;

class CreateUser extends DomainCommand
{
 
}

Создание соответствующего обработчика команды

 namespace App  Domain  WriteModel  User  CreateUser ;

#[AsCommandHandler]
class CreateUserCommandHandler implements CommandHandler
{
    public function __construct (
    ) {
    }

    public function handle ( DomainCommand $ command ): void
    {
        assert ( $ command instanceof CreateUser);

        // Do stuff.
    }
}

Полная документация

Событие

Идея этого проекта заключается в том, что все или может быть управляемое событиями. Поиск событий не предоставляется по умолчанию.

Создать новое событие

 class UserWasCreated extends DomainEvent
{
    public function __construct (
        private UserId $ userId ,
    ) {
    }

    public function getUserId (): UserId
    {
        return $ this -> userId ;
    }
}

Запишите событие

 class User extends AggregateRoot
{
    private function __construct (
       private UserId $ userId ,
    ) {
    }

    public static function create (
        UserId $ userId ,
    ): self {
        $ user = new self ( $ userId );
        $ user -> recordThat ( new UserWasCreated ( $ userId ));

        return $ user ;
    }
}

Публикуйте событие

 class UserRepository extends DbalAggregateRootRepository
{
    public function add ( User $ user ): void
    {
        $ this -> connection -> insert ( /*...*/ );
        $ this -> publishEvents ( $ user -> getRecordedEvents ());
    }
}

Послушайте событие

#[AsEventListener(type: EventListenerType:: PROCESS_MANAGER )]
class UserNotificationManager extends ConventionBasedEventListener
{
   
    public function reactToUserWasCreated ( UserWasCreated $ event ): void
    {
        // Send out some notifications.
    }
}

Полная документация

Асинхронная обработка команд с RabbitMQ

Выбранной реализацией AMQP для этого проекта является Rabbitmq, но ее можно легко переключить на, например, на решение Amazon AMQP.

Зарегистрирование новых очередей

#[AsEventListener(type: EventListenerType:: PROCESS_MANAGER )]
class UserCommandQueue extends CommandQueue
{
}

Команды очереди

 class YourService
{
    public function __construct (
        private readonly UserCommandQueue $ userCommandQueue
    ) {
    }

    public function aMethod (): void
    {
        $ this -> userCommandQueue -> queue ( new CreateUser ( /*...*/ ));
    }
}

Потребление вашей очереди

 > docker-compose run --rm php-cli bin/console app:amqp:consume user-command-queue

Полная документация

Миграции базы данных

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

#[Entity]
class User extends AggregateRoot
{
    private function __construct (
        #[Id, Column(type: ' string ' , unique: true , nullable: false )]
        private readonly UserId $ userId ,
        #[Column(type: ' string ' , nullable: false )]
        private readonly Name $ name ,
    ) {
    }

    // ...
}

Вы можете получить доктрину генерировать миграцию для вас, сравнив текущее состояние схемы вашей базы данных с информацией о отображении, которая определяется с помощью ORM, а затем выполнить эту миграцию.

 > docker-compose run --rm php-cli vendor/bin/doctrine-migrations diff
> docker-compose run --rm php-cli vendor/bin/doctrine-migrations migrate

Полная документация

Шаблон двигателя

Шаблонный механизм выбора для этого проекта - веточка и может использоваться для того, чтобы отображать что -либо, связанное с HTML.

Создать шаблон

< h1 >Users</ h1 >
< ul >
    {% for user in users %}
        < li >{{ user . username | e }}</ li >
    {% endfor %}
</ ul >

Визуализировать шаблон

 class UserOverviewRequestHandler
{
    public function __construct (
        private readonly Environment $ twig ,
    ) {
    }

    public function handle (
        ServerRequestInterface $ request ,
        ResponseInterface $ response ): ResponseInterface
    {
        $ template = $ this -> twig -> load ( ' users.html.twig ' );
        $ response -> getBody ()-> write ( $ template -> render ( /*...*/ ));

        return $ response ;
    }
}

Полная документация

Документация

Узнайте больше по этим ссылкам:

• Скелетная документация
• Стройная структура
• PHP-DI
• Symfony Console Commands
• Доктрина миграции
• Веточка

Проекты с использованием этого скелета

• Неофициальный общественный API World Cube Association Association (WCA)
• База данных недавно сгенерированных карт Pokemon с использованием GPT и стабильной диффузии
• Приложение PHP, которое генерирует карты Pokemon с использованием GPT и стабильной диффузии
• Генерировать полные 3D -картинки куба Rubiks

Внося

Пожалуйста, смотрите для получения подробной информации.