xref: /webtrees/app/Elements/LdsEndowmentDateStatus.php (revision b11cdcd45131b1585d66693fab363cfeb18c51a4)
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 * LDS_ENDOWMENT_DATE_STATUS := {Size=5:10}
28 * [ CHILD | COMPLETED | EXCLUDED | PRE-1970 | STILLBORN | SUBMITTED | UNCLEARED ]
29 * A code indicating the status of an LDS endowment ordinance where:
30 * CHILD     = Died before eight years old.
31 * COMPLETED = Completed but the date is not known.
32 * EXCLUDED  = Patron excluded this ordinance from being cleared in this submission.
33 * PRE-1970  = (See pre-1970 under LDS_BAPTISM_DATE_STATUS on page 51.)
34 * STILLBORN = Stillborn, baptism not required.
35 * SUBMITTED = Ordinance was previously submitted.
36 * UNCLEARED = Data for clearing ordinance request was insufficient.
37 */
38class LdsEndowmentDateStatus extends AbstractElement
39{
40    protected const SUBTAGS = [
41        'DATE' => '0:1',
42    ];
43
44    /**
45     * Convert a value to a canonical form.
46     *
47     * @param string $value
48     *
49     * @return string
50     */
51    public function canonical(string $value): string
52    {
53        return strtoupper(parent::canonical($value));
54    }
55
56    /**
57     * A list of controlled values for this element
58     *
59     * @return array<int|string,string>
60     */
61    public function values(): array
62    {
63        return [
64            ''          => '',
65            /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
66            'CHILD'     => I18N::translate('Died as a child: exempt'),
67            /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
68            'COMPLETED' => I18N::translate('Completed; date unknown'),
69            /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
70            'EXCLUDED'  => I18N::translate('Excluded from this submission'),
71            /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
72            'PRE-1970'  => I18N::translate('Completed before 1970; date not available'),
73            /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
74            'STILLBORN' => I18N::translate('Stillborn: exempt'),
75            /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
76            'SUBMITTED' => I18N::translate('Submitted but not yet cleared'),
77            /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
78            'UNCLEARED' => I18N::translate('Uncleared: insufficient data'),
79        ];
80    }
81}
82