Completed
Push — master ( d608ce...3d2c98 )
by Greg
07:35
created

FamilyStatusText::canonical()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 10
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 2
eloc 5
c 1
b 0
f 0
nc 2
nop 1
dl 0
loc 10
rs 10
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
18
declare(strict_types=1);
19
20
namespace Fisharebest\Webtrees\Elements;
21
22
use Fisharebest\Webtrees\I18N;
23
24
use function array_key_exists;
25
use function strtoupper;
26
27
/**
28
 * For Gedcom-L
29
 * Programs with internal data fields "not married" or "never married" or a data field
30
 * "Status", should introduce a user-defined tag _STAT directly below of FAM:
31
 * _STAT can have the following values:
32
 * <STATUS_TEXT>:= [NOT MARRIED | NEVER MARRIED | UNKNOWN |<plain text of the user>]
33
 */
34
class FamilyStatusText extends AbstractElement
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
        $value = parent::canonical($value);
46
        $upper = strtoupper($value);
47
48
        if (array_key_exists($upper, $this->values())) {
49
            return $upper;
50
        }
51
52
        return $value;
53
    }
54
55
    /**
56
     * A list of controlled values for this element
57
     *
58
     * @return array<int|string,string>
59
     */
60
    public function values(): array
61
    {
62
        return [
63
            ''              => '',
64
            'NOT MARRIED'   => I18N::translate('Not married'),
65
            'NEVER MARRIED' => I18N::translate('Never married'),
66
            'UNKNOWN'       => I18N::translate('Unknown'),
67
        ];
68
    }
69
}
70