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