snapshotpl/tactician-doctrine

Plugins for Tactician commands using Doctrine, like wrapping every command in a transaction

1.2.0 2022-01-11 13:05 UTC

Requires

• php: >=7.1
• doctrine/dbal: ^2.4 || ^3.1.5
• league/tactician: ^1.1

Requires (Dev)

• doctrine/orm: ^2.4
• mockery/mockery: ^1.3.5
• phpunit/phpunit: ^7.5.20 || ^9.5.10
• squizlabs/php_codesniffer: ^3.6.2
• yoast/phpunit-polyfills: ^1.0

Suggests

• doctrine/orm: Required if you need to use ORM Transaction Middleware

MIT

• Ross Tuck

• doctrine
• transactions
• command bus
• tactician

README

This package adds plugins for using Tactician with Doctrine components, either the ORM or just DBAL. The main feature is the ability to wrap each command in a separate database transaction.

Setup

Via Composer

$ composer require league/tactician-doctrine

Next, add the ORM\TransactionMiddleware to your CommandBus:

$commandBus = new \League\Tactician\CommandBus(
    [
        new TransactionMiddleware($ormEntityManager)
    ]
);

That's it. Each command you execute will now open and close a new transaction.

If a command fires off more commands, be aware that those commands will run in the same transaction as the parent. It is recommended that you run each command as a separate transaction, so to prevent this from happening, use the LockingMiddleware that ships in Tactician core. This will queue the commands up internally until the parent command has completed.

If an exception is raised while handling the command, the transaction is rolled back, the EntityManager closed, and the exception rethrown.

Symfony integration

When using the [tactician-bundle] (https://github.com/thephpleague/tactician-bundle), don't forget to add the Doctrine middleware to your Symfony config:

tactician:
    commandbus:
        default:
            middleware:
             - tactician.middleware.locking
             - tactician.middleware.doctrine
             - tactician.middleware.command_handler

Testing

$ ./vendor/bin/phpunit

Security

Disclosure information can be found on the main Tactician repo.

License

The MIT License (MIT). Please see License File for more information.