UserTreeSetting::execute()   F
last analyzed

Complexity

Conditions 19
Paths 18

Size

Total Lines 160
Code Lines 96

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 19
eloc 96
nc 18
nop 2
dl 0
loc 160
rs 3.7006
c 0
b 0
f 0

How to fix   Long Method    Complexity   

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) 2025 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\Cli\Commands;
21
22
use Fisharebest\Webtrees\DB;
0 ignored issues
show
Bug introduced by
The type Fisharebest\Webtrees\DB was not found. Maybe you did not declare it correctly or list all dependencies?

The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:

filter:
    dependency_paths: ["lib/*"]

For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths

Loading history...
23
use Symfony\Component\Console\Helper\Table;
24
use Symfony\Component\Console\Input\InputArgument;
25
use Symfony\Component\Console\Input\InputInterface;
26
use Symfony\Component\Console\Input\InputOption;
27
use Symfony\Component\Console\Output\OutputInterface;
28
use Symfony\Component\Console\Style\SymfonyStyle;
29
30
final class UserTreeSetting extends AbstractCommand
31
{
32
    protected function configure(): void
33
    {
34
        $this
35
            ->setName(name: 'user-tree-setting')
36
            ->setDescription(description: 'Configure user-tree settings')
37
            ->addOption(name: 'list', shortcut: 'l', mode: InputOption::VALUE_NONE, description: 'List user-tree settings (optionally filtered by setting name)')
38
            ->addOption(name: 'delete', shortcut: 'd', mode: InputOption::VALUE_NONE, description: 'Delete a user-tree setting')
39
            ->addArgument(name: 'user-name', mode: InputArgument::REQUIRED, description: 'The user to update')
40
            ->addArgument(name: 'tree-name', mode: InputArgument::REQUIRED, description: 'The tree to update')
41
            ->addArgument(name: 'setting-name', mode: InputArgument::OPTIONAL, description: 'The setting to update')
42
            ->addArgument(name: 'setting-value', mode: InputArgument::OPTIONAL, description: 'The new value of the setting.');
43
    }
44
45
    protected function execute(InputInterface $input, OutputInterface $output): int
46
    {
47
        $quiet  = $this->boolOption(input: $input, name: 'quiet');
48
        $list   = $this->boolOption(input: $input, name: 'list');
49
        $delete = $this->boolOption(input: $input, name: 'delete');
50
51
        /** @var string $user_name */
52
        $user_name = $input->getArgument(name: 'user-name');
53
54
        /** @var string $tree_name */
55
        $tree_name = $input->getArgument(name: 'tree-name');
56
57
        /** @var string|null $setting_name */
58
        $setting_name = $input->getArgument(name: 'setting-name');
59
60
        /** @var string|null $setting_value */
61
        $setting_value = $input->getArgument(name: 'setting-value');
62
63
        $io = new SymfonyStyle(input: $input, output: $output);
64
65
        $user_id = DB::table('user')
66
            ->where(column: 'user_name', operator: '=', value: $user_name)
67
            ->value(column: 'user_id');
68
69
        if ($user_id === null) {
70
            $io->error(message: 'User ‘' . $user_name . '’ not found.');
71
72
            return self::FAILURE;
73
        }
74
75
        $tree_id = DB::table('gedcom')
76
            ->where(column: 'gedcom_name', operator: '=', value: $tree_name)
77
            ->value(column: 'gedcom_id');
78
79
        if ($tree_id === null) {
80
            $io->error(message: 'Tree ‘' . $tree_name . '’ not found.');
81
82
            return self::FAILURE;
83
        }
84
85
        if ($list) {
86
            if ($delete) {
87
                $io->error(message: 'Cannot specify --list and --delete together.');
88
89
                return self::FAILURE;
90
            }
91
92
            if ($setting_value !== null) {
93
                $io->error(message: 'Cannot specify --list and a new value together.');
94
95
                return self::FAILURE;
96
            }
97
98
            $table = new Table(output: $output);
99
            $table->setHeaders(headers: ['Setting name', 'Setting value']);
100
101
            /** @var array<object{setting_name:string,setting_value:string}> $settings */
102
            $settings = DB::table(table: 'user_gedcom_setting')
103
                ->where(column: 'user_id', operator: '=', value: $user_id)
104
                ->where(column: 'gedcom_id', operator: '=', value: $tree_id)
105
                ->orderBy(column: 'setting_name')
106
                ->select(columns: ['setting_name', 'setting_value'])
107
                ->get()
108
                ->all();
109
110
            foreach ($settings as $setting) {
111
                if ($setting_name === null || str_contains(haystack: $setting->setting_name, needle: $setting_name)) {
112
                    $table->addRow(row: [$setting->setting_name, $setting->setting_value]);
113
                }
114
            }
115
116
            $table->render();
117
118
            return self::SUCCESS;
119
        }
120
121
        /** @var string|null $old_setting_value */
122
        $old_setting_value = DB::table('user_gedcom_setting')
123
            ->where(column: 'user_id', operator: '=', value: $user_id)
124
            ->where(column: 'gedcom_id', operator: '=', value: $tree_id)
125
            ->where(column: 'setting_name', operator: '=', value: $setting_name)
126
            ->value(column: 'setting_value');
127
128
        if ($delete) {
129
            if ($setting_name === null) {
130
                $io->error(message: 'Setting name must be specified for --delete.');
131
132
                return self::FAILURE;
133
            }
134
135
            if ($setting_value !== null) {
136
                $io->error(message: 'Cannot specify --delete and a new value together.');
137
138
                return self::FAILURE;
139
            }
140
141
            if ($old_setting_value === null) {
142
                $io->warning(message: 'User-tree setting ‘' . $setting_name . '’ not found.  Nothing to delete.');
143
            } else {
144
                DB::table('user_gedcom_setting')
145
                    ->where(column: 'user_id', operator: '=', value: $user_id)
146
                    ->where(column: 'gedcom_id', operator: '=', value: $tree_id)
147
                    ->where('setting_name', '=', $setting_name)
148
                    ->delete();
149
150
                $io->success(message: 'User-tree setting ‘' . $setting_name . '’ deleted.  Previous value was ‘' . $old_setting_value . '’.');
151
            }
152
153
            return self::SUCCESS;
154
        }
155
156
157
        if ($setting_name === null) {
158
            $io->error(message: 'A setting name is required, unless the --list option is used.');
159
160
            return self::FAILURE;
161
        }
162
163
        if ($setting_value === null) {
164
            if ($old_setting_value === null) {
165
                $io->info(message: 'User-tree setting ‘' . $setting_name . '’ is not currently set.');
166
            } elseif ($quiet) {
167
                $verbosity = $io->getVerbosity();
168
                $io->setVerbosity(level: OutputInterface::VERBOSITY_NORMAL);
169
                $io->writeln(messages: $old_setting_value);
170
                $io->setVerbosity(level: $verbosity);
171
            } else {
172
                $io->info(message: 'User-tree setting ‘' . $setting_name . '’ is currently set to ‘' . $old_setting_value . '’.');
173
            }
174
175
            return self::SUCCESS;
176
        }
177
178
        if ($old_setting_value === $setting_value) {
179
            $io->warning(message: 'User-tree setting ' . $setting_name . ' is already set to ' . $setting_value);
180
181
            return self::SUCCESS;
182
        }
183
184
        if ($old_setting_value === null) {
185
            DB::table(table: 'user_gedcom_setting')
186
                ->insert(values: [
187
                    'user_id'       => $user_id,
188
                    'gedcom_id'     => $tree_id,
189
                    'setting_name'  => $setting_name,
190
                    'setting_value' => $setting_value,
191
                ]);
192
193
            $io->success(message: 'User-tree setting ‘' . $setting_name . '’ was created as ‘' . $setting_value . '’.');
194
        } else {
195
            DB::table(table: 'user_gedcom_setting')
196
                ->where(column: 'user_id', operator: '=', value: $user_id)
197
                ->where(column: 'gedcom_id', operator: '=', value: $tree_id)
198
                ->where(column: 'setting_name', operator: '=', value: $setting_name)
199
                ->update(values: ['setting_value' => $setting_value]);
200
201
            $io->success(message: 'User-tree setting ‘' . $setting_name . '’ was changed from ‘' . $old_setting_value . '’ to ‘' . $setting_value . '’.');
202
        }
203
204
        return self::SUCCESS;
205
    }
206
}
207