xref: /webtrees/app/Elements/Form.php (revision 853f2b8ab920254b02a6cbbe9d6bf1f5c4486e2f)
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\Elements;
21
22use Fisharebest\Webtrees\I18N;
23use Fisharebest\Webtrees\Tree;
24
25/**
26 * GEDCOM_FORM := {Size=14:20}
27 * [ LINEAGE-LINKED ]
28 * The GEDCOM form used to construct this transmission. There maybe other forms
29 * used such as CommSoft's "EVENT_LINEAGE_LINKED" but these specifications
30 * define only the LINEAGE-LINKED Form. Systems will use this value to specify
31 * GEDCOM compatible with these specifications.
32 */
33class Form extends AbstractElement
34{
35    protected const MAXIMUM_LENGTH = 20;
36
37    /**
38     * Convert a value to a canonical form.
39     *
40     * @param string $value
41     *
42     * @return string
43     */
44    public function canonical(string $value): string
45    {
46        return strtoupper(parent::canonical($value));
47    }
48
49    /**
50     * Create a default value for this element.
51     *
52     * @param Tree $tree
53     *
54     * @return string
55     */
56    public function default(Tree $tree): string
57    {
58        return 'LINEAGE-LINKED';
59    }
60
61    /**
62     * A list of controlled values for this element
63     *
64     * @return array<int|string,string>
65     */
66    public function values(): array
67    {
68        return [
69            'LINEAGE-LINKED' => 'LINEAGE-LINKED',
70        ];
71    }
72}
73