xref: /webtrees/app/Elements/DemographicDataType.php (revision 5a8afed46297e8105e3e5a33ce37e6a8e88bc79d)
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 * <TYPE_OF_DEMOGRAPHICAL_DATA>:= {Size=1:35}
28 * Type the demographic data for a place.
29 * [ HSHO | CITI ] means: household | resident
30 */
31class DemographicDataType extends AbstractElement
32{
33    /**
34     * Convert a value to a canonical form.
35     *
36     * @param string $value
37     *
38     * @return string
39     */
40    public function canonical(string $value): string
41    {
42        return strtoupper(parent::canonical($value));
43    }
44
45    /**
46     * A list of controlled values for this element
47     *
48     * @return array<int|string,string>
49     */
50    public function values(): array
51    {
52        $values = [
53            ''     => '',
54            'HSHO' => /* I18N: Type of demographic data */ I18N::translate('household'),
55            'CITI' => /* I18N: Type of demographic data */ I18N::translate('citizen'),
56        ];
57
58        uasort($values, I18N::comparator());
59
60        return $values;
61    }
62}
63