Valkyrja\Orm\Schema\SqlFileMigration

Complexity

Total Complexity

8

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	runFailure()	0	2	1
A	rollbackMigration()	0	3	1
A	runMigration()	0	3	1
A	executeSql()	0	17	5

<?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;
use Valkyrja\Exception\RuntimeException;

use function explode;
use function file_get_contents;
use function trim;

/**
 * Class SqlFileMigration.
 */
abstract class SqlFileMigration extends TransactionalMigration
{
    /**
     * @inheritDoc
     */
    protected function runMigration(): void
    {
        $this->executeSql($this->getRunMigrationFilePath());
    }

    /**
     * @inheritDoc
     */
    protected function rollbackMigration(): void
    {
        $this->executeSql($this->getRollbackMigrationFilePath());
    }

    /**
     * Execute sql.
     *
     * @param string $filePath The sql file path
     *
     * @return void
     */
    protected function executeSql(string $filePath): void
    {
        $sql = file_get_contents($filePath);

        if ($sql === false) {
            throw new RuntimeException("Invalid file $filePath given");
        }

        foreach (explode(';', trim($sql)) as $queryString) {
            if (! $queryString) {
                continue;
            }

            $statement = $this->orm->prepare($queryString);

            if (! $statement->execute()) {
                throw new RuntimeException($statement->errorMessage() ?? 'Error occurred');
            }
        }
    }

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

    /**
     * Get the run sql file path.
     *
     * @return string
     */
    abstract protected function getRunMigrationFilePath(): string;

    /**
     * Get the rollback sql file path.
     *
     * @return string
     */
    abstract protected function getRollbackMigrationFilePath(): string;
}