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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
<?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\Contracts;
use Fisharebest\Webtrees\Tree;
/**
* A GEDCOM element is a tag/primitive in a GEDCOM file.
*/
interface ElementInterface
{
/**
* Convert a value to a canonical form.
*
* @param string $value
*
* @return string
*/
public function canonical(string $value): string;
/**
* Should we collapse the children of this element when editing?
*
* @return bool
*/
public function collapseChildren(): bool;
/**
* Create a default value for this element.
*
* @param Tree $tree
*
* @return string
*/
public function default(Tree $tree): string;
/**
* An edit control for this data.
*
* @param string $id
* @param string $name
* @param string $value
* @param Tree $tree
*
* @return string
*/
public function edit(string $id, string $name, string $value, Tree $tree): string;
/**
* Escape @ signs in a GEDCOM export.
*
* @param string $value
*
* @return string
*/
public function escape(string $value): string;
/**
* Name for this GEDCOM primitive.
*
* @return string
*/
public function label(): string;
/**
* Create a label/value pair for this element.
*
* @param string $value
* @param Tree $tree
*
* @return string
*/
public function labelValue(string $value, Tree $tree): string;
/**
* Set, remove or replace a subtag.
*
* @param string $subtag
* @param string $repeat
* @param string $before
*
* @return void
*/
public function subtag(string $subtag, string $repeat, string $before = ''): void;
/**
* @return array<string,string>
*/
public function subtags(): array;
/**
* Display the value of this type of element.
*
* @param string $value
* @param Tree $tree
*
* @return string
*/
public function value(string $value, Tree $tree): string;
/**
* A list of controlled values for this element
*
* @return array<int|string,string>
*/
public function values(): array;
}
|
