Schema::point() - Code Metrics - Inspection of "Create a new database abstraction layer" - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dbal ( 18ae5a...530d2d )

by Greg

created 2023-01-23 19:24 UTC

Schema::point() A

↳ Parent: Schema

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2022 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\DB\Schema;

/**
 * A collection tables, and factory methods for creating them.
 */
class Schema
{
    /** @var array<Table> */
    private array $tables;

    /**
     * @param array<Table> $tables
     */
    public function __construct(array $tables = []) {
        foreach ($tables as $table) {
            $this->tables[$table->getName()] = $table;
        }
    }

    /**
     * @return array<Table>
     */
    public function getTables(): array
    {
        return $this->tables;
    }

    /**
     * @param string                                                         $name
     * @param array<ColumnInterface|PrimaryKey|UniqueIndex|Index|ForeignKey> $components
     *
     * @return Table
     */
    public static function table(string $name, array $components): Table
    {
        return new Table(name: $name, components: $components);
    }

    /**
     * @param string $name
     *
     * @return IntegerColumn
     */
    public static function bigInteger(string $name): IntegerColumn
    {
        return new IntegerColumn(name: $name, bits: 64);
    }

    /**
     * @param string $name
     * @param int    $length
     *
     * @return BinaryColumn
     */
    public static function binary(string $name, int $length): BinaryColumn
    {
        return new BinaryColumn(name: $name, length: $length, varying: false);
    }

    /**
     * @param string $name
     * @param int    $bits
     *
     * @return IntegerColumn
     */
    public static function bit(string $name, int $bits = 1): IntegerColumn
    {
        return new IntegerColumn(name: $name, bits: $bits);
    }

    /**
     * @param string $name
     * @param int    $length
     *
     * @return BlobColumn
     */
    public static function blob(string $name, int $length = 4): BlobColumn
    {
        return new BlobColumn(name: $name, length: $length);
    }

    /**
     * @param string $name
     *
     * @return BooleanColumn
     */
    public static function boolean(string $name): BooleanColumn
    {
        return new BooleanColumn(name: $name);
    }

    /**
     * @param string $name
     * @param int    $length
     *
     * @return CharacterColumn
     */
    public static function char(string $name, int $length): CharacterColumn
    {
        return new CharacterColumn(name: $name, length: $length, varying: false, national: false);
    }

    /**
     * @param string $name
     *
     * @return DateColumn
     */
    public static function date(string $name): DateColumn
    {
        return new DateColumn(name: $name);
    }

    /**
     * @param string $name
     * @param int    $length
     *
     * @return DatetimeColumn
     */
    public static function datetime(string $name, int $length = 0): DatetimeColumn
    {
        return new DatetimeColumn(name: $name, length: $length);
    }

    /**
     * @param string $name
     * @param int    $precision
     * @param int    $scale
     *
     * @return DecimalColumn
     */
    public static function decimal(string $name, int $precision, int $scale): DecimalColumn
    {
        return new DecimalColumn(name: $name, precision: $precision, scale: $scale);
    }

    /**
     * @param string $name
     * @param int    $precision_bits
     *
     * @return FloatColumn
     */
    public static function double(string $name, int $precision_bits = 53): FloatColumn
    {
        return new FloatColumn(name: $name, precision_bits: $precision_bits);
    }

    /**
     * @param string        $name
     * @param array<string> $values
     *
     * @return EnumColumn
     */
    public static function enum(string $name, array $values): EnumColumn
    {
        return new EnumColumn(name: $name, values: $values);
    }

    /**
     * @param string $name
     * @param int    $precision_bits
     *
     * @return FloatColumn
     */
    public static function float(string $name, int $precision_bits = 23): FloatColumn
    {
        return new FloatColumn(name: $name, precision_bits: $precision_bits);
    }

    /**
     * @param string $name
     * @param int    $srid
     *
     * @return GeometryColumn
     */
    public static function geometry(string $name, int $srid = 0): GeometryColumn
    {
        return new GeometryColumn(name: $name, srid: $srid);
    }

    /**
     * @param string $name
     * @param int    $srid
     *
     * @return GeometrycollectionColumn
     */
    public static function geometrycollection(string $name, int $srid = 0): GeometrycollectionColumn
    {
        return new GeometrycollectionColumn(name: $name, srid: $srid);
    }

    /**
     * @param string $name
     * @param int    $bits
     *
     * @return IntegerColumn
     */
    public static function integer(string $name, int $bits = 32): IntegerColumn
    {
        return new IntegerColumn(name: $name, bits: $bits);
    }

    /**
     * @param string $name
     *
     * @return JsonColumn
     */
    public static function json(string $name): JsonColumn
    {
        return new JsonColumn(name: $name);
    }

    /**
     * @param string $name
     * @param int    $srid
     *
     * @return LinestringColumn
     */
    public static function linestring(string $name, int $srid = 0): LinestringColumn
    {
        return new LinestringColumn(name: $name, srid: $srid);
    }

    /**
     * @param string $name
     *
     * @return IntegerColumn
     */
    public static function mediumInteger(string $name): IntegerColumn
    {
        return new IntegerColumn(name: $name, bits: 24);
    }

    /**
     * @param string $name
     * @param int    $srid
     *
     * @return MultilinestringColumn
     */
    public static function multilinestring(string $name, int $srid = 0): MultilinestringColumn
    {
        return new MultilinestringColumn(name: $name, srid: $srid);
    }

    /**
     * @param string $name
     * @param int    $srid
     *
     * @return MultipointColumn
     */
    public static function multipoint(string $name, int $srid = 0): MultipointColumn
    {
        return new MultipointColumn(name: $name, srid: $srid);
    }

    /**
     * @param string $name
     * @param int    $srid
     *
     * @return MultipolygonColumn
     */
    public static function multipolygon(string $name, int $srid = 0): MultipolygonColumn
    {
        return new MultipolygonColumn(name: $name, srid: $srid);
    }

    /**
     * @param string $name
     * @param int    $length
     *
     * @return CharacterColumn
     */
    public static function nChar(string $name, int $length): CharacterColumn
    {
        return new CharacterColumn(name: $name, length: $length, varying: false, national: true);
    }

    /**
     * @param string $name
     * @param int    $length
     *
     * @return CharacterColumn
     */
    public static function nVarchar(string $name, int $length): CharacterColumn
    {
        return new CharacterColumn(name: $name, length: $length, varying: true, national: true);
    }

    /**
     * @param string $name
     * @param int    $srid
     *
     * @return PointColumn
     */
    public static function point(string $name, int $srid = 0): PointColumn
    {
        return new PointColumn(name: $name, srid: $srid);
    }

    /**
     * @param string $name
     * @param int    $srid
     *
     * @return PolygonColumn
     */
    public static function polygon(string $name, int $srid = 0): PolygonColumn
    {
        return new PolygonColumn(name: $name, srid: $srid);
    }

    /**
     * @param string        $name
     * @param array<string> $values
     *
     * @return SetColumn
     */
    public static function set(string $name, array $values): SetColumn
    {
        return new SetColumn(name: $name, values: $values);
    }

    /**
     * @param string $name
     *
     * @return IntegerColumn
     */
    public static function smallInteger(string $name): IntegerColumn
    {
        return new IntegerColumn(name: $name, bits: 16);
    }

    /**
     * @param string $name
     * @param int    $length
     *
     * @return TextColumn
     */
    public static function text(string $name, int $length = 4): TextColumn
    {
        return new TextColumn(name: $name, length: $length);
    }

    /**
     * @param string $name
     *
     * @return TimeColumn
     */
    public static function time(string $name): TimeColumn
    {
        return new TimeColumn(name: $name);
    }

    /**
     * @param string $name
     * @param int    $length
     *
     * @return TimestampColumn
     */
    public static function timestamp(string $name, int $length = 0): TimestampColumn
    {
        return new TimestampColumn(name: $name, precision: $length);
    }

    /**
     * @param string $name
     *
     * @return IntegerColumn
     */
    public static function tinyInteger(string $name): IntegerColumn
    {
        return new IntegerColumn(name: $name, bits: 8);
    }

    /**
     * @param string $name
     *
     * @return UuidColumn
     */
    public static function uuid(string $name): UuidColumn
    {
        return new UuidColumn(name: $name);
    }

    /**
     * @param string $name
     * @param int    $length
     *
     * @return BinaryColumn
     */
    public static function varBinary(string $name, int $length): BinaryColumn
    {
        return new BinaryColumn(name: $name, length: $length, varying: true);
    }

    /**
     * @param string $name
     * @param int    $length
     *
     * @return CharacterColumn
     */
    public static function varchar(string $name, int $length): CharacterColumn
    {
        return new CharacterColumn(name: $name, length: $length, varying: true, national: false);
    }

    /**
     * @param string $name
     *
     * @return YearColumn
     */
    public static function year(string $name): YearColumn
    {
        return new YearColumn(name: $name);
    }

    /**
     * @param string|array<string> $columns
     * @param string               $name
     *
     * @return PrimaryKey
     */
    public static function primaryKey(string|array $columns, string $name = ''): PrimaryKey
    {
        return new PrimaryKey(name: $name, columns: (array) $columns);
    }

    /**
     * @param string|array<string> $columns
     * @param string               $name
     *
     * @return Index
     */
    public static function index(string|array $columns, string $name = ''): Index
    {
        return new Index(name: $name, columns: (array) $columns);
    }

    /**
     * @param string|array<string> $columns
     * @param string               $name
     *
     * @return UniqueIndex
     */
    public static function uniqueIndex(string|array $columns, string $name = ''): UniqueIndex
    {
        return new UniqueIndex(name: $name, columns: (array) $columns);
    }

    /**
     * @param string|array<string> $local_columns
     * @param string               $foreign_table
     * @param string|array<string> $foreign_columns
     * @param string               $name
     *
     * @return ForeignKey
     */
    public static function foreignKey(string|array $local_columns, string $foreign_table, string|array $foreign_columns = null, string $name = ''): ForeignKey
    {
        // If the foreign columns have the same name, we don't need to specify them.
        $foreign_columns ??= $local_columns;

        $local_columns   = (array) $local_columns;
        $foreign_columns = (array) $foreign_columns;

        return new ForeignKey(local_columns: $local_columns, foreign_table: $foreign_table, foreign_columns: $foreign_columns, name: $name);
    }
}


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\DB\Schema;
21
22			/**
23			* A collection tables, and factory methods for creating them.
24			*/
25			class Schema
26			{
27			/** @var array<Table> */
28			private array $tables;
29
30			/**
31			* @param array<Table> $tables
32			*/
33			public function __construct(array $tables = []) {
34			foreach ($tables as $table) {
35			$this->tables[$table->getName()] = $table;
36			}
37			}
38
39			/**
40			* @return array<Table>
41			*/
42			public function getTables(): array
43			{
44			return $this->tables;
45			}
46
47			/**
48			* @param string $name
49			* @param array<ColumnInterface\|PrimaryKey\|UniqueIndex\|Index\|ForeignKey> $components
50			*
51			* @return Table
52			*/
53			public static function table(string $name, array $components): Table
54			{
55			return new Table(name: $name, components: $components);
56			}
57
58			/**
59			* @param string $name
60			*
61			* @return IntegerColumn
62			*/
63			public static function bigInteger(string $name): IntegerColumn
64			{
65			return new IntegerColumn(name: $name, bits: 64);
66			}
67
68			/**
69			* @param string $name
70			* @param int $length
71			*
72			* @return BinaryColumn
73			*/
74			public static function binary(string $name, int $length): BinaryColumn
75			{
76			return new BinaryColumn(name: $name, length: $length, varying: false);
77			}
78
79			/**
80			* @param string $name
81			* @param int $bits
82			*
83			* @return IntegerColumn
84			*/
85			public static function bit(string $name, int $bits = 1): IntegerColumn
86			{
87			return new IntegerColumn(name: $name, bits: $bits);
88			}
89
90			/**
91			* @param string $name
92			* @param int $length
93			*
94			* @return BlobColumn
95			*/
96			public static function blob(string $name, int $length = 4): BlobColumn
97			{
98			return new BlobColumn(name: $name, length: $length);
99			}
100
101			/**
102			* @param string $name
103			*
104			* @return BooleanColumn
105			*/
106			public static function boolean(string $name): BooleanColumn
107			{
108			return new BooleanColumn(name: $name);
109			}
110
111			/**
112			* @param string $name
113			* @param int $length
114			*
115			* @return CharacterColumn
116			*/
117			public static function char(string $name, int $length): CharacterColumn
118			{
119			return new CharacterColumn(name: $name, length: $length, varying: false, national: false);
120			}
121
122			/**
123			* @param string $name
124			*
125			* @return DateColumn
126			*/
127			public static function date(string $name): DateColumn
128			{
129			return new DateColumn(name: $name);
130			}
131
132			/**
133			* @param string $name
134			* @param int $length
135			*
136			* @return DatetimeColumn
137			*/
138			public static function datetime(string $name, int $length = 0): DatetimeColumn
139			{
140			return new DatetimeColumn(name: $name, length: $length);
141			}
142
143			/**
144			* @param string $name
145			* @param int $precision
146			* @param int $scale
147			*
148			* @return DecimalColumn
149			*/
150			public static function decimal(string $name, int $precision, int $scale): DecimalColumn
151			{
152			return new DecimalColumn(name: $name, precision: $precision, scale: $scale);
153			}
154
155			/**
156			* @param string $name
157			* @param int $precision_bits
158			*
159			* @return FloatColumn
160			*/
161			public static function double(string $name, int $precision_bits = 53): FloatColumn
162			{
163			return new FloatColumn(name: $name, precision_bits: $precision_bits);
164			}
165
166			/**
167			* @param string $name
168			* @param array<string> $values
169			*
170			* @return EnumColumn
171			*/
172			public static function enum(string $name, array $values): EnumColumn
173			{
174			return new EnumColumn(name: $name, values: $values);
175			}
176
177			/**
178			* @param string $name
179			* @param int $precision_bits
180			*
181			* @return FloatColumn
182			*/
183			public static function float(string $name, int $precision_bits = 23): FloatColumn
184			{
185			return new FloatColumn(name: $name, precision_bits: $precision_bits);
186			}
187
188			/**
189			* @param string $name
190			* @param int $srid
191			*
192			* @return GeometryColumn
193			*/
194			public static function geometry(string $name, int $srid = 0): GeometryColumn
195			{
196			return new GeometryColumn(name: $name, srid: $srid);
197			}
198
199			/**
200			* @param string $name
201			* @param int $srid
202			*
203			* @return GeometrycollectionColumn
204			*/
205			public static function geometrycollection(string $name, int $srid = 0): GeometrycollectionColumn
206			{
207			return new GeometrycollectionColumn(name: $name, srid: $srid);
208			}
209
210			/**
211			* @param string $name
212			* @param int $bits
213			*
214			* @return IntegerColumn
215			*/
216			public static function integer(string $name, int $bits = 32): IntegerColumn
217			{
218			return new IntegerColumn(name: $name, bits: $bits);
219			}
220
221			/**
222			* @param string $name
223			*
224			* @return JsonColumn
225			*/
226			public static function json(string $name): JsonColumn
227			{
228			return new JsonColumn(name: $name);
229			}
230
231			/**
232			* @param string $name
233			* @param int $srid
234			*
235			* @return LinestringColumn
236			*/
237			public static function linestring(string $name, int $srid = 0): LinestringColumn
238			{
239			return new LinestringColumn(name: $name, srid: $srid);
240			}
241
242			/**
243			* @param string $name
244			*
245			* @return IntegerColumn
246			*/
247			public static function mediumInteger(string $name): IntegerColumn
248			{
249			return new IntegerColumn(name: $name, bits: 24);
250			}
251
252			/**
253			* @param string $name
254			* @param int $srid
255			*
256			* @return MultilinestringColumn
257			*/
258			public static function multilinestring(string $name, int $srid = 0): MultilinestringColumn
259			{
260			return new MultilinestringColumn(name: $name, srid: $srid);
261			}
262
263			/**
264			* @param string $name
265			* @param int $srid
266			*
267			* @return MultipointColumn
268			*/
269			public static function multipoint(string $name, int $srid = 0): MultipointColumn
270			{
271			return new MultipointColumn(name: $name, srid: $srid);
272			}
273
274			/**
275			* @param string $name
276			* @param int $srid
277			*
278			* @return MultipolygonColumn
279			*/
280			public static function multipolygon(string $name, int $srid = 0): MultipolygonColumn
281			{
282			return new MultipolygonColumn(name: $name, srid: $srid);
283			}
284
285			/**
286			* @param string $name
287			* @param int $length
288			*
289			* @return CharacterColumn
290			*/
291			public static function nChar(string $name, int $length): CharacterColumn
292			{
293			return new CharacterColumn(name: $name, length: $length, varying: false, national: true);
294			}
295
296			/**
297			* @param string $name
298			* @param int $length
299			*
300			* @return CharacterColumn
301			*/
302			public static function nVarchar(string $name, int $length): CharacterColumn
303			{
304			return new CharacterColumn(name: $name, length: $length, varying: true, national: true);
305			}
306
307			/**
308			* @param string $name
309			* @param int $srid
310			*
311			* @return PointColumn
312			*/
313			public static function point(string $name, int $srid = 0): PointColumn
314			{
315			return new PointColumn(name: $name, srid: $srid);
316			}
317
318			/**
319			* @param string $name
320			* @param int $srid
321			*
322			* @return PolygonColumn
323			*/
324			public static function polygon(string $name, int $srid = 0): PolygonColumn
325			{
326			return new PolygonColumn(name: $name, srid: $srid);
327			}
328
329			/**
330			* @param string $name
331			* @param array<string> $values
332			*
333			* @return SetColumn
334			*/
335			public static function set(string $name, array $values): SetColumn
336			{
337			return new SetColumn(name: $name, values: $values);
338			}
339
340			/**
341			* @param string $name
342			*
343			* @return IntegerColumn
344			*/
345			public static function smallInteger(string $name): IntegerColumn
346			{
347			return new IntegerColumn(name: $name, bits: 16);
348			}
349
350			/**
351			* @param string $name
352			* @param int $length
353			*
354			* @return TextColumn
355			*/
356			public static function text(string $name, int $length = 4): TextColumn
357			{
358			return new TextColumn(name: $name, length: $length);
359			}
360
361			/**
362			* @param string $name
363			*
364			* @return TimeColumn
365			*/
366			public static function time(string $name): TimeColumn
367			{
368			return new TimeColumn(name: $name);
369			}
370
371			/**
372			* @param string $name
373			* @param int $length
374			*
375			* @return TimestampColumn
376			*/
377			public static function timestamp(string $name, int $length = 0): TimestampColumn
378			{
379			return new TimestampColumn(name: $name, precision: $length);
380			}
381
382			/**
383			* @param string $name
384			*
385			* @return IntegerColumn
386			*/
387			public static function tinyInteger(string $name): IntegerColumn
388			{
389			return new IntegerColumn(name: $name, bits: 8);
390			}
391
392			/**
393			* @param string $name
394			*
395			* @return UuidColumn
396			*/
397			public static function uuid(string $name): UuidColumn
398			{
399			return new UuidColumn(name: $name);
400			}
401
402			/**
403			* @param string $name
404			* @param int $length
405			*
406			* @return BinaryColumn
407			*/
408			public static function varBinary(string $name, int $length): BinaryColumn
409			{
410			return new BinaryColumn(name: $name, length: $length, varying: true);
411			}
412
413			/**
414			* @param string $name
415			* @param int $length
416			*
417			* @return CharacterColumn
418			*/
419			public static function varchar(string $name, int $length): CharacterColumn
420			{
421			return new CharacterColumn(name: $name, length: $length, varying: true, national: false);
422			}
423
424			/**
425			* @param string $name
426			*
427			* @return YearColumn
428			*/
429			public static function year(string $name): YearColumn
430			{
431			return new YearColumn(name: $name);
432			}
433
434			/**
435			* @param string\|array<string> $columns
436			* @param string $name
437			*
438			* @return PrimaryKey
439			*/
440			public static function primaryKey(string\|array $columns, string $name = ''): PrimaryKey
441			{
442			return new PrimaryKey(name: $name, columns: (array) $columns);
443			}
444
445			/**
446			* @param string\|array<string> $columns
447			* @param string $name
448			*
449			* @return Index
450			*/
451			public static function index(string\|array $columns, string $name = ''): Index
452			{
453			return new Index(name: $name, columns: (array) $columns);
454			}
455
456			/**
457			* @param string\|array<string> $columns
458			* @param string $name
459			*
460			* @return UniqueIndex
461			*/
462			public static function uniqueIndex(string\|array $columns, string $name = ''): UniqueIndex
463			{
464			return new UniqueIndex(name: $name, columns: (array) $columns);
465			}
466
467			/**
468			* @param string\|array<string> $local_columns
469			* @param string $foreign_table
470			* @param string\|array<string> $foreign_columns
471			* @param string $name
472			*
473			* @return ForeignKey
474			*/
475			public static function foreignKey(string\|array $local_columns, string $foreign_table, string\|array $foreign_columns = null, string $name = ''): ForeignKey
476			{
477			// If the foreign columns have the same name, we don't need to specify them.
478			$foreign_columns ??= $local_columns;
479
480			$local_columns = (array) $local_columns;
481			$foreign_columns = (array) $foreign_columns;
482
483			return new ForeignKey(local_columns: $local_columns, foreign_table: $foreign_table, foreign_columns: $foreign_columns, name: $name);
484			}
485			}
486

fisharebest / webtrees

Push — dbal ( 18ae5a...530d2d )

Schema::point() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like