xref: /webtrees/app/Elements/LdsSpouseSealingDateStatus.php (revision 2ebcf907ed34213f816592af04e6c160335d6311)
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
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Elements;
21
22use Fisharebest\Webtrees\I18N;
23
24use function strtr;
25
26/**
27 * LDS_BAPTISM_DATE_STATUS := {Size=5:10}
28 * [ CANCELED | COMPLETED | DNS | EXCLUDED | DNS/CAN | PRE-1970 | SUBMITTED | UNCLEARED ]
29 * CANCELED  = Canceled and considered invalid.
30 * COMPLETED = Completed but the date is not known.
31 * DNS       = This ordinance is not authorized.
32 * EXCLUDED  = Patron excluded this ordinance from being cleared in this submission.
33 * DNS/CAN   = This ordinance is not authorized, previous sealing cancelled.
34 * PRE-1970  = (See pre-1970 under LDS_BAPTISM_DATE_STATUS on page 51.)
35 * SUBMITTED = Ordinance was previously submitted.
36 * UNCLEARED = Data for clearing ordinance request was insufficient.
37 */
38class LdsSpouseSealingDateStatus extends AbstractElement
39{
40    /**
41     * Convert a value to a canonical form.
42     * Some applications use the British spelling instead of the US spelling.
43     *
44     * @param string $value
45     *
46     * @return string
47     */
48    public function canonical(string $value): string
49    {
50        return strtr(strtoupper(parent::canonical($value)), ['CANCELLED' => 'CANCELED']);
51    }
52
53    /**
54     * A list of controlled values for this element
55     *
56     * @return array<int|string,string>
57     */
58    public function values(): array
59    {
60        return [
61            ''          => '',
62            'CANCELED'  => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
63                I18N::translate('Sealing canceled (divorce)'),
64            'COMPLETED' => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
65                I18N::translate('Completed; date unknown'),
66            'DNS'       => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
67                I18N::translate('Do not seal: unauthorized'),
68            'DNS/CAN'   => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
69                I18N::translate('Do not seal, previous sealing canceled'),
70            'EXCLUDED'  => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
71                I18N::translate('Excluded from this submission'),
72            'PRE-1970'  => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
73                I18N::translate('Completed before 1970; date not available'),
74            'SUBMITTED' => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
75                I18N::translate('Submitted but not yet cleared'),
76            'UNCLEARED' => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
77                I18N::translate('Uncleared: insufficient data'),
78        ];
79    }
80}
81