SchemaGenerator::getFields() - Code Metrics - Inspection of "Generate MySQL tinyInteger and boolean based on co..." - kitloong/laravel-migrations-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 4.x ( 0f520e...4acd94 )

by Kit Loong

created 2020-04-04 17:40 UTC

SchemaGenerator::getFields() A

↳ Parent: SchemaGenerator

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php
/**
 * Created by PhpStorm.
 * User: liow.kitloong
 */

namespace KitLoong\MigrationsGenerator\Generators;

use Doctrine\DBAL\Schema\Table;
use Doctrine\DBAL\Types\Type;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
use KitLoong\MigrationsGenerator\MigrationGeneratorSetting;
use KitLoong\MigrationsGenerator\Types\DoubleType;
use KitLoong\MigrationsGenerator\Types\EnumType;
use KitLoong\MigrationsGenerator\Types\GeometryCollectionType;
use KitLoong\MigrationsGenerator\Types\GeometryType;
use KitLoong\MigrationsGenerator\Types\IpAddressType;
use KitLoong\MigrationsGenerator\Types\JsonbType;
use KitLoong\MigrationsGenerator\Types\LineStringType;
use KitLoong\MigrationsGenerator\Types\LongTextType;
use KitLoong\MigrationsGenerator\Types\MacAddressType;
use KitLoong\MigrationsGenerator\Types\MediumIntegerType;
use KitLoong\MigrationsGenerator\Types\MediumTextType;
use KitLoong\MigrationsGenerator\Types\MultiLineStringType;
use KitLoong\MigrationsGenerator\Types\MultiPointType;
use KitLoong\MigrationsGenerator\Types\MultiPolygonType;
use KitLoong\MigrationsGenerator\Types\PointType;
use KitLoong\MigrationsGenerator\Types\PolygonType;
use KitLoong\MigrationsGenerator\Types\SetType;
use KitLoong\MigrationsGenerator\Types\TimestampType;
use KitLoong\MigrationsGenerator\Types\TimestampTzType;
use KitLoong\MigrationsGenerator\Types\TimeTzType;
use KitLoong\MigrationsGenerator\Types\TinyIntegerType;
use KitLoong\MigrationsGenerator\Types\UUIDType;
use KitLoong\MigrationsGenerator\Types\YearType;
use Xethron\MigrationsGenerator\Generators\ForeignKeyGenerator;

class SchemaGenerator
{
    /**
     * @var \Doctrine\DBAL\Schema\AbstractSchemaManager
     */
    private $schema;

    /**
     * @var FieldGenerator
     */
    private $fieldGenerator;

    /**
     * @var ForeignKeyGenerator
     */
    private $foreignKeyGenerator;

    private $indexGenerator;

    /**
     * @var string
     */
    protected $database;

    /**
     * @var bool
     */
    private $ignoreIndexNames;

    /**
     * @var bool
     */
    private $ignoreForeignKeyNames;

    /**
     * Custom doctrine type
     * ['class', 'name', 'type']
     * @see registerCustomDoctrineType()
     *
     * @var array
     */
    private static $customDoctrineTypes = [
        [DoubleType::class, 'double', 'double'],
        [EnumType::class, 'enum', 'enum'],
        [GeometryType::class, 'geometry', 'geometry'],
        [GeometryCollectionType::class, 'geometrycollection', 'geometrycollection'],
        [LineStringType::class, 'linestring', 'linestring'],
        [LongTextType::class, 'longtext', 'longtext'],
        [MediumIntegerType::class, 'mediumint', 'mediumint'],
        [MediumTextType::class, 'mediumtext', 'mediumtext'],
        [MultiLineStringType::class, 'multilinestring', 'multilinestring'],
        [MultiPointType::class, 'multipoint', 'multipoint'],
        [MultiPolygonType::class, 'multipolygon', 'multipolygon'],
        [PointType::class, 'point', 'point'],
        [PolygonType::class, 'polygon', 'polygon'],
        [SetType::class, 'set', 'set'],
        [TimestampType::class, 'timestamp', 'timestamp'],
        [TinyIntegerType::class, 'tinyint', 'tinyint'],
        [UUIDType::class, 'uuid', 'uuid'],
        [YearType::class, 'year', 'year'],

        // Postgres types
        [IpAddressType::class, 'ipaddress', 'inet'],
        [JsonbType::class, 'jsonb', 'jsonb'],
        [MacAddressType::class, 'macaddress', 'macaddr'],
        [TimeTzType::class, 'timetz', 'timetz'],
        [TimestampTzType::class, 'timestamptz', 'timestamptz'],
    ];

    public function __construct(
        FieldGenerator $fieldGenerator,
        IndexGenerator $indexGenerator,
        ForeignKeyGenerator $foreignKeyGenerator
    ) {
        $this->fieldGenerator = $fieldGenerator;
        $this->indexGenerator = $indexGenerator;
        $this->foreignKeyGenerator = $foreignKeyGenerator;
    }

    /**
     * @param  string  $database
     * @param  bool  $ignoreIndexNames
     * @param  bool  $ignoreForeignKeyNames
     * @throws \Doctrine\DBAL\DBALException
     */
    public function initialize(string $database, bool $ignoreIndexNames, bool $ignoreForeignKeyNames)
    {
        foreach (self::$customDoctrineTypes as $doctrineType) {
            $this->registerCustomDoctrineType(...$doctrineType);

        }

        /** @var \Doctrine\DBAL\Connection $connection */
        $connection = DB::connection($database)->getDoctrineConnection();

        $connection->getDatabasePlatform()->registerDoctrineTypeMapping('bit', 'boolean');
        $connection->getDatabasePlatform()->registerDoctrineTypeMapping('json', 'json');

        /** @var MigrationGeneratorSetting $setting */
        $setting = resolve(MigrationGeneratorSetting::class);

        switch ($setting->getPlatform()) {
            case Platform::POSTGRESQL:
                $connection->getDatabasePlatform()->registerDoctrineTypeMapping('_text', 'text');
                $connection->getDatabasePlatform()->registerDoctrineTypeMapping('_int4', 'integer');
                $connection->getDatabasePlatform()->registerDoctrineTypeMapping('_numeric', 'float');
                $connection->getDatabasePlatform()->registerDoctrineTypeMapping('cidr', 'string');
                break;
            default:
        }

        $this->schema = $connection->getSchemaManager();

        $this->ignoreIndexNames = $ignoreIndexNames;
        $this->ignoreForeignKeyNames = $ignoreForeignKeyNames;
    }

    /**
     * @return string[]
     */
    public function getTables(): array
    {
        return $this->schema->listTableNames();
    }

    public function getTable(string $tableName): Table
    {
        return $this->schema->listTableDetails($tableName);
    }

    /**
     * @param  Table  $table
     * @return array|\Illuminate\Support\Collection[]
     * [
     *  'single' => Collection of single column indexes, with column name as key
     *  'multi' => Collection of multi columns indexes
     * ]
     */
    public function getIndexes(Table $table): array
    {
        return $this->indexGenerator->generate($table, $this->ignoreIndexNames);
    }

    public function getFields(Table $table, Collection $singleColIndexes): array
    {
        return $this->fieldGenerator->generate($table, $singleColIndexes);
    }

    public function getForeignKeyConstraints(string $table): array
    {
        return $this->foreignKeyGenerator->generate($table, $this->schema, $this->ignoreForeignKeyNames);
    }

    /**
     * Register custom doctrineType
     * Will override if exists
     *
     * @param $class
     * @param $name
     * @param $type
     * @throws \Doctrine\DBAL\DBALException
     */
    public function registerCustomDoctrineType($class, $name, $type)
    {
        /** @var MigrationGeneratorSetting $setting */
        $setting = resolve(MigrationGeneratorSetting::class);

        if (!Type::hasType($name)) {
            Type::addType($name, $class);
        } else {
            Type::overrideType($name, $class);
        }

        $setting->getDatabasePlatform()
            ->registerDoctrineTypeMapping($type, $name);
    }
}


1			<?php
2			/**
3			* Created by PhpStorm.
4			* User: liow.kitloong
5			*/
6
7			namespace KitLoong\MigrationsGenerator\Generators;
8
9			use Doctrine\DBAL\Schema\Table;
10			use Doctrine\DBAL\Types\Type;
11			use Illuminate\Support\Collection;
12			use Illuminate\Support\Facades\DB;
13			use KitLoong\MigrationsGenerator\MigrationGeneratorSetting;
14			use KitLoong\MigrationsGenerator\Types\DoubleType;
15			use KitLoong\MigrationsGenerator\Types\EnumType;
16			use KitLoong\MigrationsGenerator\Types\GeometryCollectionType;
17			use KitLoong\MigrationsGenerator\Types\GeometryType;
18			use KitLoong\MigrationsGenerator\Types\IpAddressType;
19			use KitLoong\MigrationsGenerator\Types\JsonbType;
20			use KitLoong\MigrationsGenerator\Types\LineStringType;
21			use KitLoong\MigrationsGenerator\Types\LongTextType;
22			use KitLoong\MigrationsGenerator\Types\MacAddressType;
23			use KitLoong\MigrationsGenerator\Types\MediumIntegerType;
24			use KitLoong\MigrationsGenerator\Types\MediumTextType;
25			use KitLoong\MigrationsGenerator\Types\MultiLineStringType;
26			use KitLoong\MigrationsGenerator\Types\MultiPointType;
27			use KitLoong\MigrationsGenerator\Types\MultiPolygonType;
28			use KitLoong\MigrationsGenerator\Types\PointType;
29			use KitLoong\MigrationsGenerator\Types\PolygonType;
30			use KitLoong\MigrationsGenerator\Types\SetType;
31			use KitLoong\MigrationsGenerator\Types\TimestampType;
32			use KitLoong\MigrationsGenerator\Types\TimestampTzType;
33			use KitLoong\MigrationsGenerator\Types\TimeTzType;
34			use KitLoong\MigrationsGenerator\Types\TinyIntegerType;
35			use KitLoong\MigrationsGenerator\Types\UUIDType;
36			use KitLoong\MigrationsGenerator\Types\YearType;
37			use Xethron\MigrationsGenerator\Generators\ForeignKeyGenerator;
38
39			class SchemaGenerator
40			{
41			/**
42			* @var \Doctrine\DBAL\Schema\AbstractSchemaManager
43			*/
44			private $schema;
45
46			/**
47			* @var FieldGenerator
48			*/
49			private $fieldGenerator;
50
51			/**
52			* @var ForeignKeyGenerator
53			*/
54			private $foreignKeyGenerator;
55
56			private $indexGenerator;
57
58			/**
59			* @var string
60			*/
61			protected $database;
62
63			/**
64			* @var bool
65			*/
66			private $ignoreIndexNames;
67
68			/**
69			* @var bool
70			*/
71			private $ignoreForeignKeyNames;
72
73			/**
74			* Custom doctrine type
75			* ['class', 'name', 'type']
76			* @see registerCustomDoctrineType()
77			*
78			* @var array
79			*/
80			private static $customDoctrineTypes = [
81			[DoubleType::class, 'double', 'double'],
82			[EnumType::class, 'enum', 'enum'],
83			[GeometryType::class, 'geometry', 'geometry'],
84			[GeometryCollectionType::class, 'geometrycollection', 'geometrycollection'],
85			[LineStringType::class, 'linestring', 'linestring'],
86			[LongTextType::class, 'longtext', 'longtext'],
87			[MediumIntegerType::class, 'mediumint', 'mediumint'],
88			[MediumTextType::class, 'mediumtext', 'mediumtext'],
89			[MultiLineStringType::class, 'multilinestring', 'multilinestring'],
90			[MultiPointType::class, 'multipoint', 'multipoint'],
91			[MultiPolygonType::class, 'multipolygon', 'multipolygon'],
92			[PointType::class, 'point', 'point'],
93			[PolygonType::class, 'polygon', 'polygon'],
94			[SetType::class, 'set', 'set'],
95			[TimestampType::class, 'timestamp', 'timestamp'],
96			[TinyIntegerType::class, 'tinyint', 'tinyint'],
97			[UUIDType::class, 'uuid', 'uuid'],
98			[YearType::class, 'year', 'year'],
99
100			// Postgres types
101			[IpAddressType::class, 'ipaddress', 'inet'],
102			[JsonbType::class, 'jsonb', 'jsonb'],
103			[MacAddressType::class, 'macaddress', 'macaddr'],
104			[TimeTzType::class, 'timetz', 'timetz'],
105			[TimestampTzType::class, 'timestamptz', 'timestamptz'],
106			];
107
108			public function __construct(
109			FieldGenerator $fieldGenerator,
110			IndexGenerator $indexGenerator,
111			ForeignKeyGenerator $foreignKeyGenerator
112			) {
113			$this->fieldGenerator = $fieldGenerator;
114			$this->indexGenerator = $indexGenerator;
115			$this->foreignKeyGenerator = $foreignKeyGenerator;
116			}
117
118			/**
119			* @param string $database
120			* @param bool $ignoreIndexNames
121			* @param bool $ignoreForeignKeyNames
122			* @throws \Doctrine\DBAL\DBALException
123			*/
124			public function initialize(string $database, bool $ignoreIndexNames, bool $ignoreForeignKeyNames)
125			{
126			foreach (self::$customDoctrineTypes as $doctrineType) {
127			$this->registerCustomDoctrineType(...$doctrineType);
			0 ignored issues – show Bug introduced 2020-04-04 17:42 UTC by Report Bug Copy Issue Report The call to `registerCustomDoctrineType()` misses some required arguments starting with `$name`. Loading history...
128			}
129
130			/** @var \Doctrine\DBAL\Connection $connection */
131			$connection = DB::connection($database)->getDoctrineConnection();
132
133			$connection->getDatabasePlatform()->registerDoctrineTypeMapping('bit', 'boolean');
134			$connection->getDatabasePlatform()->registerDoctrineTypeMapping('json', 'json');
135
136			/** @var MigrationGeneratorSetting $setting */
137			$setting = resolve(MigrationGeneratorSetting::class);
138
139			switch ($setting->getPlatform()) {
140			case Platform::POSTGRESQL:
141			$connection->getDatabasePlatform()->registerDoctrineTypeMapping('_text', 'text');
142			$connection->getDatabasePlatform()->registerDoctrineTypeMapping('_int4', 'integer');
143			$connection->getDatabasePlatform()->registerDoctrineTypeMapping('_numeric', 'float');
144			$connection->getDatabasePlatform()->registerDoctrineTypeMapping('cidr', 'string');
145			break;
146			default:
147			}
148
149			$this->schema = $connection->getSchemaManager();
150
151			$this->ignoreIndexNames = $ignoreIndexNames;
152			$this->ignoreForeignKeyNames = $ignoreForeignKeyNames;
153			}
154
155			/**
156			* @return string[]
157			*/
158			public function getTables(): array
159			{
160			return $this->schema->listTableNames();
161			}
162
163			public function getTable(string $tableName): Table
164			{
165			return $this->schema->listTableDetails($tableName);
166			}
167
168			/**
169			* @param Table $table
170			* @return array\|\Illuminate\Support\Collection[]
171			* [
172			* 'single' => Collection of single column indexes, with column name as key
173			* 'multi' => Collection of multi columns indexes
174			* ]
175			*/
176			public function getIndexes(Table $table): array
177			{
178			return $this->indexGenerator->generate($table, $this->ignoreIndexNames);
179			}
180
181			public function getFields(Table $table, Collection $singleColIndexes): array
182			{
183			return $this->fieldGenerator->generate($table, $singleColIndexes);
184			}
185
186			public function getForeignKeyConstraints(string $table): array
187			{
188			return $this->foreignKeyGenerator->generate($table, $this->schema, $this->ignoreForeignKeyNames);
189			}
190
191			/**
192			* Register custom doctrineType
193			* Will override if exists
194			*
195			* @param $class
196			* @param $name
197			* @param $type
198			* @throws \Doctrine\DBAL\DBALException
199			*/
200			public function registerCustomDoctrineType($class, $name, $type)
201			{
202			/** @var MigrationGeneratorSetting $setting */
203			$setting = resolve(MigrationGeneratorSetting::class);
204
205			if (!Type::hasType($name)) {
206			Type::addType($name, $class);
207			} else {
208			Type::overrideType($name, $class);
209			}
210
211			$setting->getDatabasePlatform()
212			->registerDoctrineTypeMapping($type, $name);
213			}
214			}
215

kitloong / laravel-migrations-generator

Push — 4.x ( 0f520e...4acd94 )

SchemaGenerator::getFields() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like