Quantum\Exceptions\MigrationException

Complexity

Total Complexity

8

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	tableDoesnotExists()	0	3	1
A	methodNotDefined()	0	3	1
A	wrongDirection()	0	3	1
A	nothingToMigrate()	0	3	1
A	unsupportedDriver()	0	3	1
A	columnNotAvailable()	0	3	1
A	unsupportedAction()	0	3	1
A	tableAlreadyExists()	0	3	1

<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <arman.ag@softberg.org>
 * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
 * @link http://quantum.softberg.org/
 * @since 2.7.0
 */

namespace Quantum\Exceptions;

/**
 * MigrationException class
 *
 * @package Quantum
 * @category Exceptions
 */
class MigrationException extends \Exception
{

    /**
     * Wrong migration direction message
     */
    const WRONG_MIGRATION_DIRECTION = 'Migration direction can only be [up] or [down]';
    
    /**
     * Database Driver is not supported message
     */
    const NON_SUPPORTED_DRIVERER = 'The driver `{%1}`, does not support migrations';
    
    /**
     * Migration action is not supported, possible variants are 'create', 'alter', 'rename', 'drop'
     */
    const NON_SUPPORTED_ACTION = 'The action `{%1}`, is not supported';
    
    /**
     * Table already exists message
     */
    const TABLE_ALREADY_EXISTS = 'The table `{%1}` is already exists';
    
    /**
     * Table does not exists message
     */
    const TABLE_DOES_NOT_EXISTS = 'The table `{%1}` does not exists';
    
    /**
     * Column not available message
     */
    const COLUMN_NOT_AVAILABLE = 'The column `{%1}` is not available';
    
    /**
     * Method is no defined message
     */
    const METHOD_NOT_DEFINED = 'The method `{%1}` is not defined';
    
    /**
     * No migrations to migrate
     */
    const NOTHING_TO_MIGRATE = 'Nothing to migrate';

    /**
     * @return \Quantum\Exceptions\MigrationException
     */
    public static function wrongDirection(): MigrationException
    {
        return new static(self::WRONG_MIGRATION_DIRECTION, E_ERROR);
    }

    /**
     * @param string $databaseDriver
     * @return \Quantum\Exceptions\MigrationException
     */
    public static function unsupportedDriver(string $databaseDriver): MigrationException
    {
        return new static(_message(self::NON_SUPPORTED_DRIVERER, $databaseDriver), E_ERROR);
    }

    /**
     * @param string $action
     * @return MigrationException
     */
    public static function unsupportedAction(string $action): MigrationException
    {
        return new static(_message(self::NON_SUPPORTED_ACTION, $action), E_ERROR);
    }

    /**
     * @param string $name
     * @return \Quantum\Exceptions\MigrationException
     */
    public static function tableAlreadyExists(string $name): MigrationException
    {
        return new static(_message(self::TABLE_ALREADY_EXISTS, $name), E_ERROR);
    }

    /**
     * @param string $name
     * @return \Quantum\Exceptions\MigrationException
     */
    public static function tableDoesnotExists(string $name): MigrationException
    {
        return new static(_message(self::TABLE_DOES_NOT_EXISTS, $name), E_ERROR);
    }

    /**
     * @param string $name
     * @return \Quantum\Exceptions\MigrationException
     */
    public static function columnNotAvailable(string $name): MigrationException
    {
        return new static(_message(self::COLUMN_NOT_AVAILABLE, $name), E_ERROR);
    }

    /**
     * @param string $name
     * @return \Quantum\Exceptions\MigrationException
     */
    public static function methodNotDefined(string $name): MigrationException
    {
        return new static(_message(self::METHOD_NOT_DEFINED, $name), E_ERROR);
    }

    /**
     * @return \Quantum\Exceptions\MigrationException
     */
    public static function nothingToMigrate(): MigrationException
    {
        return new static(self::NOTHING_TO_MIGRATE, E_NOTICE);
    }

}