Starlit\Db\Migration\AbstractMigration

Complexity

Total Complexity

5

Size/Duplication

Total Lines	36
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getNumber()	0	8	3
	up()	0	1	?
A	down()	0	3	1

<?php declare(strict_types=1);
/**
 * Starlit Db.
 *
 * @copyright Copyright (c) 2019 Starweb AB
 * @license   BSD 3-Clause
 */

namespace Starlit\Db\Migration;

use Starlit\Db\Db;

/**
 * Concrete migration class names must contain a sequential migration number, eg. "Migration1".
 *
 * Names can also include something more meaningful, eg. "Migration14CreateAuthorsTable".
 *
 * @author Andreas Nilsson <http://github.com/jandreasn>
 */
abstract class AbstractMigration
{
    /**
     * @var Db;
     */
    protected $db;

    /**
     * @param Db $db
     */
    final public function __construct(Db $db)
    {
        $this->db = $db;
    }

    public function getNumber(): int
    {
        if (!preg_match('/\d+/', get_class($this), $matches) ||  !($number = (int) $matches[0])) {
            throw new \LogicException("Invalid migration class name (must include a migration number)");
        }

        return $number;
    }

    /**
     * Actions to be performed when migrating up to this version (e.g. 6.1.0 -> 6.2.0)
     */
    abstract public function up(): void;

    /**
     * Actions to be performed when migrating down from this version (e.g. 6.2.0 -> 6.0.0)
     */
    public function down(): void
    {
    }
}