Valkyrja\Orm\Schema\TransactionalMigration

Complexity

Total Complexity

6

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	runFailure()	0	2	1
A	run()	0	16	2
A	rollback()	0	16	2
A	rollbackFailure()	0	2	1

<?php

declare(strict_types=1);

/*
 * This file is part of the Valkyrja Framework package.
 *
 * (c) Melech Mizrachi <melechmizrachi@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Valkyrja\Orm\Schema;

use Throwable;

/**
 * Abstract Class TransactionalMigration.
 *
 * @author Melech Mizrachi
 */
abstract class TransactionalMigration extends Migration
{
    /**
     * @inheritDoc
     *
     * @throws Throwable
     */
    public function run(): void
    {
        $orm = $this->orm;

        try {
            $orm->ensureTransaction();

            $this->runMigration();

            $orm->commit();
        } catch (Throwable $exception) {
            $orm->rollback();

            $this->runFailure($exception);

            throw $exception;
        }
    }

    /**
     * @inheritDoc
     *
     * @throws Throwable
     */
    public function rollback(): void
    {
        $orm = $this->orm;

        try {
            $orm->ensureTransaction();

            $this->rollbackMigration();

            $orm->commit();
        } catch (Throwable $exception) {
            $orm->rollback();

            $this->rollbackFailure($exception);

            throw $exception;
        }
    }

    /**
     * Do on run failure.
     *
     * @param Throwable $exception The exception
     *
     * @return void
     */
    protected function runFailure(Throwable $exception): void

The parameter $exception is not used and could be removed.

    {
    }

    /**
     * Do on rollback failure.
     *
     * @param Throwable $exception The exception
     *
     * @return void
     */
    protected function rollbackFailure(Throwable $exception): void

The parameter $exception is not used and could be removed.

    {
    }

    /**
     * Run the migration.
     *
     * @return void
     */
    abstract protected function runMigration(): void;

    /**
     * Rollback the migration.
     *
     * @return void
     */
    abstract protected function rollbackMigration(): void;
}