php slim skeleton Download - php slim skeleton Quellcode Download

Ereignisgesteuerte Slim 4 Framework Skeletton

Ein ereignisorientiertes Slim 4-Framework-Skelett mit AMQP und CQRS

Installation

Standard -Installationsprofil

Das Standardinstallationsprofil enthält keine Beispiele. Sie sollten dieses Profil verwenden, wenn Sie wissen, was los ist, und mit einem sauberen Schiefer beginnen möchten.

 > 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

Vollständiger Installationsprofil

Das vollständige Installationsprofil hat ein vollständiges Arbeitsbeispiel.

 > 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

Einige Beispiele

Registrieren einer neuen Route

 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 ;
    }
}

Gehen Sie zu config/routes.php und fügen Sie eine Route für Ihren RequestHandler hinzu:

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

Vollständige Dokumentation

Konsolenbefehle

Die Konsolenanwendung verwendet die Symfony Console -Komponente, um die CLI -Funktionalität zu nutzen.

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

Vollständige Dokumentation

Domänenbefehle und Befehlshandler

Mit dem Skelett können Sie Befehle und Befehlshandler verwenden, um Aktionen auszuführen. Diese 2 kommen immer paarweise, wenn ein neuer Befehl im Schreibmodell erstellt wird, muss ebenfalls ein entsprechender Befehlshandler erstellt werden.

Erstellen eines neuen Befehls

 namespace App  Domain  WriteModel  User  CreateUser ;

class CreateUser extends DomainCommand
{
 
}

Erstellen des entsprechenden Befehlshandlers

 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.
    }
}

Vollständige Dokumentation

Ereignis

Die Idee dieses Projekts ist, dass alles ereignisgesteuert ist oder kann. Die Ereignisbeschaffung wird standardmäßig nicht bereitgestellt.

Erstellen Sie eine neue Veranstaltung

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

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

Notieren Sie das Ereignis

 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 ;
    }
}

Veröffentlichen Sie die Veranstaltung

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

Hören Sie sich die Veranstaltung an

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

Vollständige Dokumentation

Asynchrische Verarbeitung von Befehlen mit Rabbitmq

Die ausgewählte AMQP -Implementierung für dieses Projekt ist Rabbitmq, kann jedoch leicht auf die AMQP -Lösung von Amazon umgestellt werden.

Registrieren neuer Warteschlangen

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

Warteschlangenbefehle

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

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

Ihre Warteschlange konsumieren

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

Vollständige Dokumentation

Datenbankmigrationen

Um Datenbankmigrationen zu verwalten, wird das Doktrin/Migrations -Paket verwendet.

#[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 ,
    ) {
    }

    // ...
}

Sie können eine Migration für Sie generieren, indem Sie den aktuellen Status Ihres Datenbankschemas mit den Zuordnungsinformationen vergleichen, die mithilfe des ORM definiert und dann diese Migration ausführen.

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

Vollständige Dokumentation

Vorlagenmotor

Die Template Engine of Choice für dieses Projekt ist Zweig und kann verwendet werden, um alles, was HTML bezieht.

Erstellen Sie eine Vorlage

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

Die Vorlage rendern

 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 ;
    }
}