Passed
Push — dbal ( 026bc1...48a0a9 )
by Greg
23:44 queued 16:44
created

WebtreesSchema::__construct()   B

Complexity

Conditions 1
Paths 1

Size

Total Lines 68
Code Lines 59

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 59
c 1
b 0
f 0
nc 1
nop 1
dl 0
loc 68
rs 8.8945

How to fix   Long Method   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
/**
4
 * webtrees: online genealogy
5
 * Copyright (C) 2022 webtrees development team
6
 * This program is free software: you can redistribute it and/or modify
7
 * it under the terms of the GNU General Public License as published by
8
 * the Free Software Foundation, either version 3 of the License, or
9
 * (at your option) any later version.
10
 * This program is distributed in the hope that it will be useful,
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
 * GNU General Public License for more details.
14
 * You should have received a copy of the GNU General Public License
15
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16
 */
17
18
declare(strict_types=1);
19
20
namespace Fisharebest\Webtrees;
21
22
use Closure;
23
use Doctrine\DBAL\DriverManager;
24
use Doctrine\DBAL\Schema\Schema;
25
use Doctrine\DBAL\Schema\SchemaConfig;
26
use Doctrine\DBAL\Schema\SchemaException;
27
use Doctrine\DBAL\Types\Types;
28
use ErrorException;
29
use Fisharebest\Webtrees\Factories\CacheFactory;
30
use Fisharebest\Webtrees\Factories\CalendarDateFactory;
31
use Fisharebest\Webtrees\Factories\ElementFactory;
32
use Fisharebest\Webtrees\Factories\EncodingFactory;
33
use Fisharebest\Webtrees\Factories\FamilyFactory;
34
use Fisharebest\Webtrees\Factories\FilesystemFactory;
35
use Fisharebest\Webtrees\Factories\GedcomRecordFactory;
36
use Fisharebest\Webtrees\Factories\HeaderFactory;
37
use Fisharebest\Webtrees\Factories\ImageFactory;
38
use Fisharebest\Webtrees\Factories\IndividualFactory;
39
use Fisharebest\Webtrees\Factories\LocationFactory;
40
use Fisharebest\Webtrees\Factories\MarkdownFactory;
41
use Fisharebest\Webtrees\Factories\MediaFactory;
42
use Fisharebest\Webtrees\Factories\NoteFactory;
43
use Fisharebest\Webtrees\Factories\RepositoryFactory;
44
use Fisharebest\Webtrees\Factories\ResponseFactory;
45
use Fisharebest\Webtrees\Factories\RouteFactory;
46
use Fisharebest\Webtrees\Factories\SharedNoteFactory;
47
use Fisharebest\Webtrees\Factories\SlugFactory;
48
use Fisharebest\Webtrees\Factories\SourceFactory;
49
use Fisharebest\Webtrees\Factories\SubmissionFactory;
50
use Fisharebest\Webtrees\Factories\SubmitterFactory;
51
use Fisharebest\Webtrees\Factories\SurnameTraditionFactory;
52
use Fisharebest\Webtrees\Factories\TimeFactory;
53
use Fisharebest\Webtrees\Factories\TimestampFactory;
54
use Fisharebest\Webtrees\Factories\IdFactory;
55
use Fisharebest\Webtrees\Factories\XrefFactory;
56
use Fisharebest\Webtrees\GedcomFilters\GedcomEncodingFilter;
57
use Fisharebest\Webtrees\Http\Middleware\BadBotBlocker;
58
use Fisharebest\Webtrees\Http\Middleware\BaseUrl;
59
use Fisharebest\Webtrees\Http\Middleware\BootModules;
60
use Fisharebest\Webtrees\Http\Middleware\CheckForMaintenanceMode;
61
use Fisharebest\Webtrees\Http\Middleware\CheckForNewVersion;
62
use Fisharebest\Webtrees\Http\Middleware\ClientIp;
63
use Fisharebest\Webtrees\Http\Middleware\CompressResponse;
64
use Fisharebest\Webtrees\Http\Middleware\ContentLength;
65
use Fisharebest\Webtrees\Http\Middleware\DoHousekeeping;
66
use Fisharebest\Webtrees\Http\Middleware\EmitResponse;
67
use Fisharebest\Webtrees\Http\Middleware\HandleExceptions;
68
use Fisharebest\Webtrees\Http\Middleware\LoadRoutes;
69
use Fisharebest\Webtrees\Http\Middleware\NoRouteFound;
70
use Fisharebest\Webtrees\Http\Middleware\ReadConfigIni;
71
use Fisharebest\Webtrees\Http\Middleware\RegisterGedcomTags;
72
use Fisharebest\Webtrees\Http\Middleware\Router;
73
use Fisharebest\Webtrees\Http\Middleware\SecurityHeaders;
74
use Fisharebest\Webtrees\Http\Middleware\UpdateDatabaseSchema;
75
use Fisharebest\Webtrees\Http\Middleware\UseDatabase;
76
use Fisharebest\Webtrees\Http\Middleware\UseLanguage;
77
use Fisharebest\Webtrees\Http\Middleware\UseSession;
78
use Fisharebest\Webtrees\Http\Middleware\UseTheme;
79
use Fisharebest\Webtrees\Http\Middleware\UseTransaction;
80
use Illuminate\Container\Container;
81
use Illuminate\Database\Capsule\Manager as DB;
82
use Illuminate\Database\Schema\Blueprint;
83
use Middleland\Dispatcher;
84
use Nyholm\Psr7\Factory\Psr17Factory;
85
use Nyholm\Psr7Server\ServerRequestCreator;
86
use Psr\Container\ContainerInterface;
87
use Psr\Http\Message\ResponseFactoryInterface;
88
use Psr\Http\Message\ResponseInterface;
89
use Psr\Http\Message\ServerRequestFactoryInterface;
90
use Psr\Http\Message\ServerRequestInterface;
91
use Psr\Http\Message\StreamFactoryInterface;
92
use Psr\Http\Message\UploadedFileFactoryInterface;
93
use Psr\Http\Message\UriFactoryInterface;
94
use Psr\Http\Server\MiddlewareInterface;
95
96
use function date_default_timezone_set;
97
use function error_reporting;
98
use function is_string;
99
use function mb_internal_encoding;
100
use function set_error_handler;
101
use function stream_filter_register;
102
103
use const E_ALL;
104
use const E_DEPRECATED;
105
use const E_USER_DEPRECATED;
106
107
/**
108
 * Definitions for the webtrees database.
109
 */
110
class WebtreesSchema extends  Schema
111
{
112
    private const OPTIONS = [
113
        'charset'   => 'utf8mb4',
114
        'collation' => 'utf8mb4_unicode_ci',
115
    ];
116
    
117
    /**
118
     * @param string $prefix
119
     *
120
     * @throws SchemaException
121
     */
122
    public function __construct(string $prefix)
123
    {
124
        parent::__construct();
125
126
        $gedcom = $this->createTable($prefix . 'gedcom');
127
        $gedcom->addColumn('gedcom_id', Types::INTEGER, ['autoincrement' => true]);
128
        $gedcom->addColumn('gedcom_name', Types::STRING, ['length' => 255]);
129
        $gedcom->addColumn('sort_order', Types::INTEGER, ['default' => 0]);
130
        $gedcom->setPrimaryKey(['gedcom_id']);
131
        $gedcom->addUniqueIndex(['gedcom_name']);
132
        $gedcom->addIndex(['sort_order']);
133
134
        $gedcom_setting = $this->createTable($prefix . 'gedcom_setting');
135
        $gedcom_setting->addColumn('gedcom_id', Types::INTEGER);
136
        $gedcom_setting->addColumn('setting_name', Types::STRING, ['length' => 32]);
137
        $gedcom_setting->addColumn('setting_value', Types::STRING, ['length' => 255, 'platformOptions' => self::OPTIONS]);
138
        $gedcom_setting->setPrimaryKey(['gedcom_id', 'setting_name']);
139
        $gedcom_setting->addForeignKeyConstraint($gedcom, ['gedcom_id'], ['gedcom_id'], ['onDelete' => 'CASCADE', 'onUpdate' => 'CASCADE']);
140
141
        $site_setting = $this->createTable($prefix . 'site_setting');
142
        $site_setting->addColumn('setting_name', Types::STRING, ['length' => 32]);
143
        $site_setting->addColumn('setting_value', Types::STRING, ['length' => 2000, 'platformOptions' => self::OPTIONS]);
144
        $site_setting->setPrimaryKey(['setting_name']);
145
146
        $user = $this->createTable($prefix . 'user');
147
        $user->addColumn('user_id', Types::INTEGER, ['autoincrement' => true]);
148
        $user->addColumn('user_name', Types::STRING, ['length' => 32]);
149
        $user->addColumn('real_name', Types::STRING, ['length' => 64]);
150
        $user->addColumn('email', Types::STRING, ['length' => 64]);
151
        $user->addColumn('password', Types::STRING, ['length' => 128]);
152
        $user->setPrimaryKey(['user_id']);
153
        $user->addUniqueIndex(['user_name']);
154
        $user->addUniqueIndex(['email']);
155
156
        $user_gedcom_setting = $this->createTable($prefix . 'user_gedcom_setting');
157
        $user_gedcom_setting->addOption('charset', 'utf8mb4');
158
        $user_gedcom_setting->addOption('collation', 'utf8mb4_bin');
159
        $user_gedcom_setting->addOption('create_options', self::OPTIONS);
160
        $user_gedcom_setting->addColumn('user_id', Types::INTEGER);
161
        $user_gedcom_setting->addColumn('gedcom_id', Types::INTEGER);
162
        $user_gedcom_setting->addColumn('setting_name', Types::STRING, ['length' => 32]);
163
        $user_gedcom_setting->addColumn('setting_value', Types::STRING, ['length' => 255]);
164
        $user_gedcom_setting->setPrimaryKey(['user_id', 'gedcom_id', 'setting_name']);
165
        $user_gedcom_setting->addIndex(['gedcom_id']);
166
        $user_gedcom_setting->addForeignKeyConstraint($gedcom, ['gedcom_id'], ['gedcom_id'], ['onDelete' => 'CASCADE', 'onUpdate' => 'CASCADE']);
167
        $user_gedcom_setting->addForeignKeyConstraint($user, ['user_id'], ['user_id'], ['onDelete' => 'CASCADE', 'onUpdate' => 'CASCADE']);
168
169
        $user_setting = $this->createTable($prefix . 'user_setting');
170
        $user_setting->addColumn('user_id', Types::INTEGER);
171
        $user_setting->addColumn('setting_name', Types::STRING, ['length' => 32]);
172
        $user_setting->addColumn('setting_value', Types::STRING, ['length' => 255, 'platformOptions' => self::OPTIONS]);
173
        $user_setting->setPrimaryKey(['user_id', 'setting_name']);
174
        $user_setting->addForeignKeyConstraint($user, ['user_id'], ['user_id'], ['onDelete' => 'CASCADE', 'onUpdate' => 'CASCADE']);
175
176
        $schema_config = new SchemaConfig();
177
        $schema_config->setDefaultTableOptions(['create_options' => self::OPTIONS]);
178
        $user = $this->createTable($prefix . 'users');
179
        $user->addOption('charset', 'utf8mb4');
180
        $user->addOption('collation', 'utf8mb4_unicode_bin');
181
        $user->addOption('engine', 'memory');
182
        $user->addColumn('user_id', Types::INTEGER, ['autoincrement' => true]);
183
        $user->addColumn('user_name', Types::STRING, ['length' => 32]);
184
        $user->addColumn('real_name', Types::STRING, ['length' => 64]);
185
        $user->addColumn('email', Types::STRING, ['length' => 64]);
186
        $user->addColumn('password', Types::STRING, ['length' => 128]);
187
        $user->setPrimaryKey(['user_id']);
188
        $user->addUniqueIndex(['user_name']);
189
        $user->addUniqueIndex(['email']);
190
    }
191
192
    public function migrate(): array {
193
        $connection = DriverManager::getConnection([
194
            'dbname' => 'webtrees',
195
            'user' => 'root',
196
            'password' => 'secret1234',
197
            'host' => 'localhost',
198
            'driver' => 'pdo_mysql',
199
        ]);
200
201
        $platform = $connection->getDatabasePlatform();
202
203
        // Existing databases may have enum columns.
204
        $platform->registerDoctrineTypeMapping('enum', 'string');
205
206
        $schema_manager = $connection->createSchemaManager();
207
        $comparator = $schema_manager->createComparator();
208
        $difference = $comparator->compareSchemas($schema_manager->createSchema(), $this);
209
        $queries = $difference->toSql($platform);
210
        foreach ($queries as $query) {
211
            echo '<p>' . $query . '</p>';
212
        }
213
        exit;
0 ignored issues
show
Best Practice introduced by
Using exit here is not recommended.

In general, usage of exit should be done with care and only when running in a scripting context like a CLI script.

Loading history...
214
215
        return $queries;
0 ignored issues
show
Unused Code introduced by
return $queries is not reachable.

This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.

Unreachable code is most often the result of return, die or exit statements that have been added for debug purposes.

function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

In the above example, the last return false will never be executed, because a return statement has already been met in every possible execution path.

Loading history...
216
    }
217
}
218