ysm/with-transaction

Laravel trait to automatically wrap model operations in transactions.

1.0.0 2025-06-29 15:28 UTC

Requires

• php: ^8.1
• illuminate/support: ^10.0|^11.0|^12.0

MIT

• orm
• model
• trait
• laravel
• transaction

README

This package provides a reusable Laravel trait that automatically wraps Eloquent model operations (create, update, save, delete, etc.) in database transactions — giving you cleaner, safer code without writing DB::transaction() everywhere.

✨ Features

• Automatically wraps model actions in a transaction
• Easily toggle transaction behavior per operation
• Works with all Eloquent models
• Supports create, update, save, delete, restore, forceDelete
• Static helpers: withTransaction, transaction

📦 Installation

composer require ysm/with-transaction

php artisan vendor:publish --tag=with-transaction-config

📖 Usage

1. Add the Trait

In your Eloquent model, use the WithTransaction trait:

use App\Traits\WithTransaction;

class Post extends Model
{
    use WithTransaction;

    protected $fillable = ['title', 'content'];
}

2. Use in the controller

Now you can use your model as usual, and all operations will be automatically wrapped in a transaction:

namespace App\Http\Controllers\Api;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;

class PostController extends Controller
{
    public function store(Request $request)
    {
       $post = Post::transaction(function () use ($request) {

            $model = Post::create($request->validated());

            $model->tags()->attach(Tag::inRandomOrder()->take(3)->pluck('id'));
            $model->categories()->attach(Category::inRandomOrder()->take(3)->pluck('id'));

            $model->addMediaFromRequest('image')
                ->toMediaCollection('posts');

            // all or nothing rollback automatically
            return $model;
        });

        return response()->json([
            'message' => 'Post created successfully',
            'post' => $post,
        ]);
    }
}

3. Updating the Model

You can also use the same trait for updating models:

namespace App\Http\Controllers\Api;

use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\Request;

class PostController extends Controller
{
    public function Update(Request $request, Post $post)
    {
        $post = Post::transaction(function () use ($post) {

            $post->update([
                'title' => 'Update title Post v1',
            ]);

            $post->tags()->sync([4, 5, 6]);

            return $post;
       });

        return response()->json([
            'message' => 'Post updated successfully',
            'post' => $post,
        ], 200);
    }
}

4. Deleting the Model

You can also delete models using the same trait:

namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\Request;
class PostController extends Controller
{
    public function destroy(Post $post)
    {
        $post = Post::transaction(function () use ($post) {
            $post->delete();
            // If you want to perform any additional operations after deletion,
            // you can do so here. For example, logging or cleaning up related data.
            // If the deletion fails, the transaction will automatically roll back.
            return $post;
        });

        return response()->json([
            'message' => 'Post deleted successfully',
            'post' => $post,
        ], 200);
    }
}

Or you can use it as a helper function

namespace App\Http\Controllers\Api;
use App\Http\Controllers\Controller;
use App\Models\Post;
use Illuminate\Http\Request;
use YSM\Support\transaction;

class PostController extends Controller
{
    public function destroy(Post $post)
    {

        $post = transaction(function () use ($post) {
            $post->delete();
            // If you want to perform any additional operations after deletion,
            // you can do so here. For example, logging or cleaning up related data.
            // If the deletion fails, the transaction will automatically roll back.
            return $post;
        });

        return response()->json([
            'message' => 'Post deleted successfully',
            'post' => $post,
        ], 200);
    }
}

🔁 Using the Global Helper Function

Use anywhere in your app:

use function YSM\Support\transaction;

transaction(function () use ($post) {
    $post->update([...]);
}, attempts: 2, onSuccess: fn () => Log::info('Done!'), onFailure: fn ($e) => report($e));

🧠 Fluent Transaction Builder

Need more control? Use the fluent interface:

use YSM\Support\Facades\Transaction;

Transaction::start()
    ->attempts(3)
    ->onSuccess(fn ($result) => Log::info('Transaction success', ['id' => $result?->id]))
    ->onFailure(fn ($e) => Log::error('Transaction failed', ['message' => $e->getMessage()]))
    ->run(fn () => Post::create([...]));

❤️ Thank You

Thanks for using this package! If it saved you time or avoided a bug, consider giving it a ⭐ on GitHub.