xref: /webtrees/app/Elements/MarriageType.php (revision ac71572d8462e396ed5a307f05b29381e49f9e6e)
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\I18N;
23
24use function strtoupper;
25
26/**
27 * MARR:TYPE
28 */
29class MarriageType extends AbstractElement
30{
31    public const VALUE_CIVIL     = 'CIVIL';
32    public const VALUE_PARTNERS  = 'PARTNERS';
33    public const VALUE_RELIGIOUS = 'RELIGIOUS';
34
35    /**
36     * Convert a value to a canonical form.
37     * GEDCOM 5.5EL uses 'RELI' and 'CIVIL'
38     *
39     * @param string $value
40     *
41     * @return string
42     */
43    public function canonical(string $value): string
44    {
45        $value = strtoupper(parent::canonical($value));
46
47        $canonical = [
48            'RELI' => 'RELIGIOUS'
49        ];
50
51        return $canonical[$value] ?? $value;
52    }
53
54    /**
55     * A list of controlled values for this element.
56     *
57     * @return array<int|string,string>
58     */
59    public function values(): array
60    {
61        return [
62            ''                    => '',
63            self::VALUE_CIVIL     => I18N::translate('Civil marriage'),
64            self::VALUE_PARTNERS  => I18N::translate('Registered partnership'),
65            self::VALUE_RELIGIOUS => I18N::translate('Religious marriage'),
66
67        ];
68    }
69}
70