xref: /webtrees/app/Elements/LdsChildSealingDateStatus.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 strtoupper;
25
26/**
27 * LDS_BAPTISM_DATE_STATUS := {Size=5:10}
28 * [ BIC | COMPLETED | EXCLUDED | DNS | PRE-1970 | STILLBORN | SUBMITTED | UNCLEARED ]
29 * BIC       = Born in the covenant receiving blessing of child to parent sealing.
30 * EXCLUDED  = Patron excluded this ordinance from being cleared in this submission.
31 * PRE-1970  = (See pre-1970 under LDS_BAPTISM_DATE_STATUS on page 51.)
32 * STILLBORN = Stillborn, baptism not required.
33 * SUBMITTED = Ordinance was previously submitted.
34 * UNCLEARED = Data for clearing ordinance request was insufficient.
35 */
36class LdsChildSealingDateStatus extends AbstractElement
37{
38    /**
39     * Convert a value to a canonical form.
40     *
41     * @param string $value
42     *
43     * @return string
44     */
45    public function canonical(string $value): string
46    {
47        return strtoupper(parent::canonical($value));
48    }
49
50    /**
51     * A list of controlled values for this element
52     *
53     * @return array<int|string,string>
54     */
55    public function values(): array
56    {
57        return [
58            ''          => '',
59            'BIC'       => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
60                I18N::translate('Born in the covenant'),
61            'EXCLUDED'  => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
62                I18N::translate('Excluded from this submission'),
63            'PRE-1970'  => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
64                I18N::translate('Completed before 1970; date not available'),
65            'STILLBORN' => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
66                I18N::translate('Stillborn: exempt'),
67            'SUBMITTED' => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
68                I18N::translate('Submitted but not yet cleared'),
69            'UNCLEARED' => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
70                I18N::translate('Uncleared: insufficient data'),
71        ];
72    }
73}
74