xref: /webtrees/app/Elements/MarriageType.php (revision e873f434551745f888937263ff89e80db3b0f785)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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 string VALUE_CIVIL      = 'CIVIL';
32    public const string VALUE_COMMON_LAW = 'COMMON LAW';
33    public const string VALUE_PARTNERS  = 'PARTNERS';
34    public const string VALUE_RELIGIOUS = 'RELIGIOUS';
35
36    /**
37     * Convert a value to a canonical form.
38     * GEDCOM 5.5EL uses 'RELI' for 'Religious marriage' (RELIGIOUS)
39     */
40    public function canonical(string $value): string
41    {
42        $value = strtoupper(parent::canonical($value));
43
44        $canonical = [
45            'RELI' => self::VALUE_RELIGIOUS,
46        ];
47
48        return $canonical[$value] ?? $value;
49    }
50
51    /**
52     * A list of controlled values for this element.
53     *
54     * @return array<int|string,string>
55     */
56    public function values(): array
57    {
58        return [
59            ''                     => '',
60            self::VALUE_CIVIL      => I18N::translate('Civil marriage'),
61            self::VALUE_COMMON_LAW => I18N::translate('Common-law marriage'),
62            self::VALUE_PARTNERS   => I18N::translate('Registered partnership'),
63            self::VALUE_RELIGIOUS  => I18N::translate('Religious marriage'),
64        ];
65    }
66}
67