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