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