catchAdmin/extend/catcher/generate/support/Table.php

<?php
// +----------------------------------------------------------------------
// +----------------------------------------------------------------------
// | CatchAdmin [Just Like ～ ]
// +----------------------------------------------------------------------
// | Copyright (c) 2017~2020 http://catchadmin.com All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( https://github.com/yanwenwu/catch-admin/blob/master/LICENSE.txt )
// +----------------------------------------------------------------------
// | Author: JaguarJack [ njphper@gmail.com ]
// +----------------------------------------------------------------------
namespace catcher\generate\support;

use catcher\exceptions\FailedException;
use catcher\Utils;
use Phinx\Db\Adapter\AdapterFactory;
use think\facade\Db;
use think\migration\db\Column;

class Table
{
    protected static $adapter = null;

    protected static $table = null;

    protected static $tableName = null;

    public function __construct(string $tableName)
    {
        self::$tableName = $tableName;
    }

    /**
     * 获取 table 对象
     *
     * @time 2021年03月04日
     * @return \think\migration\db\Table
     */
    protected static function getTable(): \think\migration\db\Table
    {
        if (self::$table) {
            return self::$table;
        }

        return (new \think\migration\db\Table(Utils::tableWithOutPrefix(self::$tableName)))->setAdapter(self::getAdapter());
    }

    /**
     * create table
     *
     * @time 2021年03月04日
     * @param string $primaryKey
     * @param string $engine
     * @param string $comment
     * @return bool
     */
    public static function create(string $primaryKey, string $engine, string $comment): bool
    {
       self::getTable()
           ->setId($primaryKey)
           ->setPrimaryKey($primaryKey)
           ->setEngine($engine)
           ->setComment($comment)
           ->setCollation('utf8mb4_general_ci')
           ->create();

       return self::exist();
    }

    /**
     * 表是否存在
     *
     * @time 2021年03月04日
     * @return bool
     */
    public static function exist(): bool
    {
        return self::getTable()->exists();
    }

    /**
     * 删除表
     *
     * @time 2021年03月04日
     * @return bool
     */
    public static function drop(): bool
    {
        if (!self::exist()) {
            throw new FailedException(sprintf('table [%s] not exist, drop failed', self::$tableName));
        }

        self::getTable()->drop();

        return self::exist();
    }

    /**
     * 新增 column
     *
     * @time 2021年03月04日
     * @param mixed $column
     * @return bool
     */
    public static function addColumn($column): bool
    {
        if ($column instanceof \Closure) {
            $column = $column();
        }

        if (!$column instanceof Column) {
            throw new FailedException('Column Must Be "think\migration\db\Column');
        }

        // 新增字段
        self::getTable()
            ->addColumn($column)
            ->update();

        return self::hasColumn($column->getName());
    }

    /**
     * 是否存在 column
     *
     * @time 2021年03月08日
     * @param string $column
     * @return bool
     */
    public static function hasColumn(string $column): bool
    {
        return self::getTable()->hasColumn($column);
    }

    /**
     * 获取表结构信息
     *
     * @time 2021年03月05日
     * @return array
     */
    public static function columns(): array
    {
        return array_values(Db::getFields(Utils::tableWithPrefix(self::$tableName)));
    }

    /**
     * 删除 column
     *
     * @time 2021年03月04日
     * @param string $column
     * @return bool
     */
    public static function dropColumn(string $column): bool
    {
        self::getTable()->removeColumn($column)->update();

        if (self::getTable()->hasColumn($column)) {
            throw new FailedException('remove column ['.$column.'] failed');
        }

        return true;
    }

    /**
     * 唯一索引
     *
     * @time 2021年03月13日
     * @param  string| array $columns
     * @return void
     */
    public static function addUniqueIndex($columns)
    {
        self::getTable()->addIndex($columns, [
            'unique' => true, 'name' => self::$tableName . '_' . (is_string($columns) ? $columns : implode('_', $columns))
        ])->update();
    }

    /**
     * 添加普通索引
     *
     * @time 2021年03月13日
     * @param string| array $columns
     * @return void
     */
    public static function addIndex($columns)
    {
        self::getTable()->addIndex($columns, [
           'name' => self::$tableName . '_' . (is_string($columns) ? $columns : implode('_', $columns))
        ])->update();
    }

    /**
     * 添加全文索引
     *
     * @time 2021年03月13日
     * @param string| array $columns
     * @return void
     */
    public static function addFulltextIndex($columns)
    {
        self::getTable()->addIndex($columns, [
            'type' => 'fulltext',
            'name' => self::$tableName . '_' . (is_string($columns) ? $columns : implode('_', $columns))
        ])->update();
    }

    /**
     * 获取适配器
     *
     * @time 2021年03月04日
     * @return mixed
     */
    public static function getAdapter()
    {
        if (self::$adapter) {
            return self::$adapter;
        }

        $options = self::getDbConfig();

        $adapter = AdapterFactory::instance()->getAdapter($options['adapter'], $options);

        if ($adapter->hasOption('table_prefix') || $adapter->hasOption('table_suffix')) {
            $adapter = AdapterFactory::instance()->getWrapper('prefix', $adapter);
        }

        self::$adapter = $adapter;

        return $adapter;
    }

    /**
     * 获取数据库配置
     * @return array
     */
    protected static function getDbConfig(): array
    {
        $default = app()->config->get('database.default');

        $config = app()->config->get("database.connections.{$default}");

        if (0 == $config['deploy']) {
            $dbConfig = [
                'adapter'      => $config['type'],
                'host'         => $config['hostname'],
                'name'         => $config['database'],
                'user'         => $config['username'],
                'pass'         => $config['password'],
                'port'         => $config['hostport'],
                'charset'      => $config['charset'],
                'table_prefix' => $config['prefix'],
            ];
        } else {
            $dbConfig = [
                'adapter'      => explode(',', $config['type'])[0],
                'host'         => explode(',', $config['hostname'])[0],
                'name'         => explode(',', $config['database'])[0],
                'user'         => explode(',', $config['username'])[0],
                'pass'         => explode(',', $config['password'])[0],
                'port'         => explode(',', $config['hostport'])[0],
                'charset'      => explode(',', $config['charset'])[0],
                'table_prefix' => explode(',', $config['prefix'])[0],
            ];
        }

        $table = app()->config->get('database.migration_table', 'migrations');

        $dbConfig['default_migration_table'] = $dbConfig['table_prefix'] . $table;

        return $dbConfig;
    }
}