summaryrefslogtreecommitdiff
path: root/app/Elements/Form.php
blob: 7d5a4cb923d710012c4aa1f7a20a91d5e0e93713 (plain)
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
<?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\Elements;

use Fisharebest\Webtrees\Tree;

/**
 * GEDCOM_FORM := {Size=14:20}
 * [ LINEAGE-LINKED ]
 * The GEDCOM form used to construct this transmission. There maybe other forms
 * used such as CommSoft's "EVENT_LINEAGE_LINKED" but these specifications
 * define only the LINEAGE-LINKED Form. Systems will use this value to specify
 * GEDCOM compatible with these specifications.
 */
class Form extends AbstractElement
{
    protected const int MAXIMUM_LENGTH = 20;

    /**
     * Convert a value to a canonical form.
     *
     * @param string $value
     *
     * @return string
     */
    public function canonical(string $value): string
    {
        return strtoupper(parent::canonical($value));
    }

    /**
     * Create a default value for this element.
     *
     * @param Tree $tree
     *
     * @return string
     */
    public function default(Tree $tree): string
    {
        return 'LINEAGE-LINKED';
    }

    /**
     * A list of controlled values for this element
     *
     * @return array<int|string,string>
     */
    public function values(): array
    {
        return [
            'LINEAGE-LINKED' => 'LINEAGE-LINKED',
        ];
    }
}