xref: /webtrees/app/Module/ModuleDataFixInterface.php (revision f70bcff589628705e50ed72a6fc6cbad68558677) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2021 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
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Fisharebest\Webtrees\GedcomRecord;
23use Fisharebest\Webtrees\Tree;
24use Illuminate\Support\Collection;
25
26/**
27 * Interface ModuleDataFixInterface - Classes and libraries for module system
28 */
29interface ModuleDataFixInterface extends ModuleInterface
30{
31    /**
32     * Options form.
33     *
34     * @param Tree $tree
35     *
36     * @return string
37     */
38    public function fixOptions(Tree $tree): string;
39
40    /**
41     * A combined list of all records that might need fixing.
42     *
43     * @param Tree                 $tree
44     * @param array<string,string> $params
45     *
46     * @return Collection<object>
47     */
48    public function recordsToFix(Tree $tree, array $params): Collection;
49
50    /**
51     * Does a record need updating?
52     *
53     * @param GedcomRecord         $record
54     * @param array<string,string> $params
55     *
56     * @return bool
57     */
58    public function doesRecordNeedUpdate(GedcomRecord $record, array $params): bool;
59
60    /**
61     * Show the changes we would make
62     *
63     * @param GedcomRecord         $record
64     * @param array<string,string> $params
65     *
66     * @return string
67     */
68    public function previewUpdate(GedcomRecord $record, array $params): string;
69
70    /**
71     * Fix a record
72     *
73     * @param GedcomRecord         $record
74     * @param array<string,string> $params
75     *
76     * @return void
77     */
78    public function updateRecord(GedcomRecord $record, array $params): void;
79}
80