Migration.php

<?php

/**
 * Copyright 2021 Jeremy Presutti <Jeremy@Presutti.us>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

declare(strict_types=1);

namespace Feast\Database;

use Exception;
use Feast\Exception\InvalidArgumentException;
use Feast\Exception\ServerFailureException;
use Feast\Interfaces\DatabaseFactoryInterface;
use Feast\Interfaces\DatabaseInterface;

abstract class Migration
{
    public const CONNECTION = 'default';
    protected const NAME = null;
    protected DatabaseInterface $connection;

    /**
     * Migration constructor.
     *
     * @throws Exception
     * @throws ServerFailureException
     */
    public function __construct()
    {
        if (static::CONNECTION === null) {
            throw new InvalidArgumentException('No connection specified');
        }
        if (static::NAME === null) {
            throw new InvalidArgumentException('Migration unnamed');
        }

        // Connect to databases
        $this->connection = di(DatabaseFactoryInterface::class)->getConnection((string)static::CONNECTION);
    }

    /**
     * Run DB Up.
     */
    public function up(): void
    {
        echo (string)static::NAME . ' Up ran successfully' . "\n";
    }

    /**
     * Run DB down.
     */
    public function down(): void
    {
        echo (string)static::NAME . ' Down ran successfully' . "\n";
    }

    /**
     * Get migration name.
     *
     * @return string
     */
    public function getName(): string
    {
        return (string)static::NAME;
    }
}