ดาวน์โหลด php slim skeleton - php slim skeleton Source Source Download

โครงกระดูก 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 และเพิ่มเส้นทางสำหรับ requesthandler ของคุณ:

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

เอกสารฉบับเต็ม

การประมวลผลคำสั่ง async ด้วย rabbitmq

การใช้งาน AMQP ที่เลือกสำหรับโครงการนี้คือ RabbitMQ แต่สามารถเปลี่ยนเป็นตัวอย่างได้อย่างง่ายดายเช่นโซลูชัน AMQP ของ Amazon

การลงทะเบียนคิวใหม่

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