astrotomic / laravel-transaction-proxy
This package provides a trait and class to call methods in a database transaction.
Fund package maintenance!
Gummibeer
SarahSibert
Issuehunt
forest.astrotomic.info
Installs: 1 280
Dependents: 0
Suggesters: 0
Security: 0
Stars: 5
Watchers: 4
Forks: 0
Open Issues: 0
Requires
- php: ^7.4 || ^8.0
- illuminate/database: ^7.0 || ^8.0
- illuminate/support: ^7.0 || ^8.0
Requires (Dev)
- orchestra/testbench: ^5.0 || ^6.0
- phpunit/phpunit: ^9.3
README
This package provides a trait and class to call methods in a database transaction. This is useful if you have any listeners also running database queries, like deleting child models.
Installation
You can install the package via composer:
composer require astrotomic/laravel-transaction-proxy
Usage
The easiest will be to use the \Astrotomic\LaravelTransactionProxy\HasTransactionCalls
trait which adds a transaction()
method.
use Astrotomic\LaravelTransactionProxy\HasTransactionalCalls; class MyClass { use HasTransactionalCalls; }
Transaction chained Method
You can call the transaction()
without any argument and the method after will be called in a transaction.
This example will call the delete()
method in a transaction.
This is useful if you have any listeners also running database queries, like deleting child models.
The transaction will prevent you from corrupted data if any of the queries fails.
$model->transaction()->delete(); // vs use Illuminate\Support\Facades\DB; DB::transaction(fn() => $model->delete());
Conditional Callback
If you want you can also pass a callback to the transaction()
method you will get the calling object as first argument.
$model->transaction(function(Model $model) { $model->update(); $model->child->update(); });
Testing
composer test
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details. You could also be interested in CODE OF CONDUCT.
Security
If you discover any security related issues, please check SECURITY for steps to report it.
Credits
License
The MIT License (MIT). Please see License File for more information.
Treeware
You're free to use this package, but if it makes it to your production environment I would highly appreciate you buying the world a tree.
It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you contribute to my forest you’ll be creating employment for local families and restoring wildlife habitats.
You can buy trees at offset.earth/treeware
Read more about Treeware at treeware.earth