Passed
Push — dbal ( a67a72...c31592 )
by Greg
08:19
created

ForeignKey::onDeleteCascade()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 0
dl 0
loc 3
rs 10
c 0
b 0
f 0
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
class ForeignKey
23
{
24
    private ReferentialAction $on_delete = ReferentialAction::NO_ACTION;
25
    private ReferentialAction $on_update = ReferentialAction::NO_ACTION;
26
27
    public function __construct(public readonly array $local_columns, public readonly string $foreign_table, public readonly array $foreign_columns)
28
    {
29
    }
30
31
    /**
32
     * @param ReferentialAction $on_delete
33
     *
34
     * @return $this
35
     */
36
    public function onDelete(ReferentialAction $on_delete): static
37
    {
38
        $this->on_delete = $on_delete;
39
40
        return $this;
41
    }
42
43
    /**
44
     * @return $this
45
     */
46
    public function onDeleteCascade(): static
47
    {
48
        return $this->onDelete(ReferentialAction::CASCADE);
49
    }
50
51
    /**
52
     * @return $this
53
     */
54
    public function onDeleteSetNull(): static
55
    {
56
        return $this->onDelete(ReferentialAction::SET_NULL);
57
    }
58
59
    /**
60
     * @param ReferentialAction $on_update
61
     *
62
     * @return $this
63
     */
64
    public function onUpdate(ReferentialAction $on_update): static
65
    {
66
        $this->on_update = $on_update;
67
68
        return $this;
69
    }
70
71
    /**
72
     * @return $this
73
     */
74
    public function onUpdateCascade(): static
75
    {
76
        return $this->onDelete(ReferentialAction::CASCADE);
77
    }
78
}
79