xref: /webtrees/app/Elements/FamilyNonEvent.php (revision d11be7027e34e3121be11cc025421873364403f9) 
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;
23use Fisharebest\Webtrees\Registry;
24
25use function strtoupper;
26use function uasort;
27
28/**
29 * An event which never happened.
30 */
31class FamilyNonEvent extends AbstractElement
32{
33    protected const SUBTAGS = [
34        'DATE' => '0:1',
35        'NOTE' => '0:1',
36        'SOUR' => '0:1',
37    ];
38
39    /**
40     * Convert a value to a canonical form.
41     *
42     * @param string $value
43     *
44     * @return string
45     */
46    public function canonical(string $value): string
47    {
48        return strtoupper(parent::canonical($value));
49    }
50
51    /**
52     * A list of controlled values for this element
53     *
54     * @return array<int|string,string>
55     */
56    public function values(): array
57    {
58        $values = [
59            ''     => '',
60            'ANUL' => Registry::elementFactory()->make('FAM:ANUL')->label(),
61            'CENS' => Registry::elementFactory()->make('FAM:CENS')->label(),
62            'DIV'  => Registry::elementFactory()->make('FAM:DIV')->label(),
63            'DIVF' => Registry::elementFactory()->make('FAM:DIVF')->label(),
64            'ENGA' => Registry::elementFactory()->make('FAM:ENGA')->label(),
65            'MARB' => Registry::elementFactory()->make('FAM:MARB')->label(),
66            'MARC' => Registry::elementFactory()->make('FAM:MARC')->label(),
67            'MARL' => Registry::elementFactory()->make('FAM:MARL')->label(),
68            'MARS' => Registry::elementFactory()->make('FAM:MARS')->label(),
69            'MARR' => Registry::elementFactory()->make('FAM:MARR')->label(),
70        ];
71
72        uasort($values, I18N::comparator());
73
74        return $values;
75    }
76}
77