xref: /webtrees/app/Elements/LdsBaptismDateStatus.php (revision c908635b89a84d0a06f38a4d07640639e838703f)
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 * LDS_BAPTISM_DATE_STATUS := {Size=5:10}
28 * [ CHILD | COMPLETED | EXCLUDED | PRE-1970 | STILLBORN | SUBMITTED | UNCLEARED ]
29 * A code indicating the status of an LDS baptism and confirmation date where:
30 * CHILD     = Died before becoming eight years old, baptism not required.
31 * COMPLETED = Completed but the date is not known.
32 * EXCLUDED  = Patron excluded this ordinance from being cleared in this submission.
33 * PRE-1970  = Ordinance is likely completed, another ordinance for this person
34 *             was converted from temple records of work completed before 1970,
35 *             therefore this ordinance is assumed to be complete until all
36 *             records are converted.
37 * STILLBORN = Stillborn, baptism not required.
38 * SUBMITTED = Ordinance was previously submitted.
39 * UNCLEARED = Data for clearing ordinance request was insufficient.
40 */
41class LdsBaptismDateStatus extends AbstractElement
42{
43    /**
44     * Convert a value to a canonical form.
45     *
46     * @param string $value
47     *
48     * @return string
49     */
50    public function canonical(string $value): string
51    {
52        return strtoupper(parent::canonical($value));
53    }
54
55    /**
56     * A list of controlled values for this element
57     *
58     * @return array<int|string,string>
59     */
60    public function values(): array
61    {
62        return [
63            ''          => '',
64            'CHILD'     => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
65                I18N::translate('Died as a child: exempt'),
66            'COMPLETED' => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
67                I18N::translate('Completed; date unknown'),
68            'EXCLUDED'  => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
69                I18N::translate('Excluded from this submission'),
70            'PRE-1970'  => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
71                I18N::translate('Completed before 1970; date not available'),
72            'STILLBORN' => /* I18N: LDS sealing status; see https://en.wikipedia.org/wiki/Sealing_(Mormonism) */
73                I18N::translate('Stillborn: exempt'),
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