huangdijia/laravel-trigger

MySQL trigger base on MySQLReplication.

v5.0.0-beta.1 2024-03-23 05:17 UTC

Requires

• php: ^8.1
• illuminate/console: ^10.0|^11.0
• illuminate/support: ^10.0|^11.0
• moln/php-mysql-replication: ^1.2

Requires (Dev)

• huangdijia/php-coding-standard: ^2.1
• orchestra/testbench: ^8.0|^9.0
• phpstan/phpstan: ^1.0

MIT

• huangdijia

• mysql
• laravel
• trigger

README

Subscribe MySQL events like jQuery, base on php-mysql-replication

中文说明

MySQL server settings

In your MySQL server configuration file you need to enable replication:

[mysqld]
server-id        = 1
log_bin          = /var/log/mysql/mysql-bin.log
expire_logs_days = 10
max_binlog_size  = 100M
binlog_row_image = full
binlog-format    = row #Very important if you want to receive write, update and delete row events
Mysql replication events explained https://dev.mysql.com/doc/internals/en/event-meanings.html

Mysql user privileges:

GRANT REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'user'@'host';

GRANT SELECT ON `dbName`.* TO 'user'@'host';

Installation

Laravel

install

composer require "huangdijia/laravel-trigger:^4.0"

publish config

php artisan vendor:publish --provider="Huangdijia\Trigger\TriggerServiceProvider"

Lumen

install

composer require "huangdijia/laravel-trigger:^4.0"

edit bootstrap/app.php add:

$app->register(Huangdijia\Trigger\TriggerServiceProvider::class);
...
$app->configure('trigger');

publish config and route

php artisan trigger:install [--force]

Configure

edit .env, add:

TRIGGER_HOST=192.168.xxx.xxx
TRIGGER_PORT=3306
TRIGGER_USER=username
TRIGGER_PASSWORD=password
...

Usage

php artisan trigger:start [-R=xxx]

Subscriber

<?php
namespace App\Listeners;

use Huangdijia\Trigger\EventSubscriber;

class ExampeSubscriber extends EventSubscriber
{
    public function onUpdate(UpdateRowsDTO $event)
    {
        //
    }

    public function onDelete(DeleteRowsDTO $event)
    {
        //
    }

    public function onWrite(WriteRowsDTO $event)
    {
        //
    }
}

more subscriber usage

EventSubscribers

Event Route

common

$trigger->on('database.table', 'write', function($event) { /* do something */ });

multi-tables and multi-evnets

$trigger->on('database.table1,database.table2', 'write,update', function($event) { /* do something */ });

multi-events

$trigger->on('database.table1,database.table2', [
    'write'  => function($event) { /* do something */ },
    'update' => function($event) { /* do something */ },
]);

action as controller

$trigger->on('database.table', 'write', 'App\\Http\\Controllers\\ExampleController'); // call default method 'handle'
$trigger->on('database.table', 'write', 'App\\Http\\Controllers\\ExampleController@write');

action as callable

class Foo
{
    public static function bar($event)
    {
        dump($event);
    }
}

$trigger->on('database.table', 'write', 'Foo@bar'); // call default method 'handle'
$trigger->on('database.table', 'write', ['Foo', 'bar']);

action as job

Job

namespace App\Jobs;

class ExampleJob extends Job
{
    private $event;

    public function __construct($event)
    {
        $this->event = $event;
    }

    public function handle()
    {
        dump($this->event);
    }
}

Route

$trigger->on('database.table', 'write', 'App\Jobs\ExampleJob'); // call default method 'dispatch'
$trigger->on('database.table', 'write', 'App\Jobs\ExampleJob@dispatch_now');

Event List

php artisan trigger:list [-R=xxx]

Terminate

php artisan trigger:terminate [-R=xxx]

Thanks to

JetBrains