MichaelRubel\EnhancedPipeline\Traits\HandlesDatabaseTransactions

Complexity

Total Complexity

7

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	beginTransaction()	0	7	2
A	commitTransaction()	0	7	2
A	withTransaction()	0	5	1
A	rollbackTransaction()	0	7	2

<?php

declare(strict_types=1);

namespace MichaelRubel\EnhancedPipeline\Traits;

use Illuminate\Support\Facades\DB;

trait HandlesDatabaseTransactions
{
    /**
     * Determines whether class uses transaction.
     *
     * @var bool
     */
    protected bool $useTransaction = false;

    /**
     * Enable transaction in pipeline.
     *
     * @return static
     */
    public function withTransaction(): static
    {
        $this->useTransaction = true;

        return $this;
    }

    /**
     * Begin the transaction if enabled.
     *
     * @return void
     */
    protected function beginTransaction(): void
    {
        if (! $this->useTransaction) {
            return;
        }

        DB::beginTransaction();
    }

    /**
     * Commit the transaction if enabled.
     *
     * @return void
     */
    protected function commitTransaction(): void
    {
        if (! $this->useTransaction) {
            return;
        }

        DB::commit();
    }

    /**
     * Rollback the transaction if enabled.
     *
     * @return void
     */
    protected function rollbackTransaction(): void
    {
        if (! $this->useTransaction) {
            return;
        }

        DB::rollBack();
    }
}