xref: /webtrees/app/Elements/SexValue.php (revision b13a72db028c9d47e5a3437c318773ad07d13be0) 
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;
23use Fisharebest\Webtrees\Tree;
24
25use function strtoupper;
26use function view;
27
28/**
29 * SEX_VALUE := {Size=1:7}
30 * A code that indicates the sex of the individual
31 */
32class SexValue 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     * Create a default value for this element.
48     *
49     * @param Tree $tree
50     *
51     * @return string
52     */
53    public function default(Tree $tree): string
54    {
55        return 'U';
56    }
57
58    /**
59     * An edit control for this data.
60     *
61     * @param string $id
62     * @param string $name
63     * @param string $value
64     * @param Tree   $tree
65     *
66     * @return string
67     */
68    public function edit(string $id, string $name, string $value, Tree $tree): string
69    {
70        return view('components/radios-inline', [
71            'name'     => $name,
72            'options'  => $this->values(),
73            'selected' => $value,
74        ]);
75    }
76
77    /**
78     * A list of controlled values for this element
79     *
80     * @return array<int|string,string>
81     */
82    public function values(): array
83    {
84        return [
85            'M' => I18N::translate('Male'),
86            'F' => I18N::translate('Female'),
87            'U' => I18N::translateContext('unknown gender', 'Unknown'),
88        ];
89    }
90}
91