xref: /webtrees/app/Elements/HierarchicalRelationship.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 * <HIERARCHICAL_RELATIONSHIP>:= [POLI|RELI|GEOG|CULT]
28 * Used to differentiate political (administrative), religious, geographical
29 * or cultural associations. For the superior location object the details of
30 * its type are defined by the <TYPE_OF_LOCATION> in its record.
31 */
32class HierarchicalRelationship extends AbstractElement
33{
34    /**
35     * Convert a value to a canonical form.
36     *
37     * @param string $value
38     *
39     * @return string
40     */
41    public function canonical(string $value): string
42    {
43        return strtoupper(parent::canonical($value));
44    }
45
46
47    /**
48     * A list of controlled values for this element
49     *
50     * @return array<int|string,string>
51     */
52    public function values(): array
53    {
54        $values = [
55            ''     => '',
56            'POLI' => /* I18N: Type of location hierarchy */ I18N::translate('political'),
57            'RELI' => /* I18N: Type of location hierarchy */ I18N::translate('religious'),
58            'GEOG' => /* I18N: Type of location hierarchy */ I18N::translate('geographic'),
59            'CULT' => /* I18N: Type of location hierarchy */ I18N::translate('cultural'),
60        ];
61
62        uasort($values, I18N::comparator());
63
64        return $values;
65    }
66}
67