xref: /webtrees/app/Elements/RoleInEvent.php (revision 1f03f305b30749e7d31ed9bca11cc7793dcf4294)
1c2ed51d1SGreg Roach<?php
2c2ed51d1SGreg Roach
3c2ed51d1SGreg Roach/**
4c2ed51d1SGreg Roach * webtrees: online genealogy
55bfc6897SGreg Roach * Copyright (C) 2022 webtrees development team
6c2ed51d1SGreg Roach * This program is free software: you can redistribute it and/or modify
7c2ed51d1SGreg Roach * it under the terms of the GNU General Public License as published by
8c2ed51d1SGreg Roach * the Free Software Foundation, either version 3 of the License, or
9c2ed51d1SGreg Roach * (at your option) any later version.
10c2ed51d1SGreg Roach * This program is distributed in the hope that it will be useful,
11c2ed51d1SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of
12c2ed51d1SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13c2ed51d1SGreg Roach * GNU General Public License for more details.
14c2ed51d1SGreg Roach * You should have received a copy of the GNU General Public License
15c2ed51d1SGreg Roach * along with this program. If not, see <https://www.gnu.org/licenses/>.
16c2ed51d1SGreg Roach */
17c2ed51d1SGreg Roach
18c2ed51d1SGreg Roachdeclare(strict_types=1);
19c2ed51d1SGreg Roach
20c2ed51d1SGreg Roachnamespace Fisharebest\Webtrees\Elements;
21c2ed51d1SGreg Roach
22*1f03f305SGreg Roachuse Fisharebest\Webtrees\I18N;
23*1f03f305SGreg Roach
24c2ed51d1SGreg Roach/**
25c2ed51d1SGreg Roach * ROLE_IN_EVENT := {Size=1:15}
26c2ed51d1SGreg Roach * [ CHIL | HUSB | WIFE | MOTH | FATH | SPOU | (<ROLE_DESCRIPTOR>) ]
27c2ed51d1SGreg Roach * Indicates what role this person played in the event that is being cited in this context. For
28c2ed51d1SGreg Roach * example, if you cite a child's birth record as the source of the mother's name, the value for
29c2ed51d1SGreg Roach * this field is "MOTH." If you describe the groom of a marriage, the role is "HUSB." If the role
30c2ed51d1SGreg Roach * is something different than one of the six relationship role tags listed above then enclose the
31c2ed51d1SGreg Roach * role name within matching parentheses.
32c2ed51d1SGreg Roach */
33c2ed51d1SGreg Roachclass RoleInEvent extends AbstractElement
34c2ed51d1SGreg Roach{
35ae0043b7SGreg Roach    protected const MAXIMUM_LENGTH = 15;
36*1f03f305SGreg Roach
37*1f03f305SGreg Roach    /**
38*1f03f305SGreg Roach     * A list of controlled values for this element
39*1f03f305SGreg Roach     *
40*1f03f305SGreg Roach     * @return array<int|string,string>
41*1f03f305SGreg Roach     */
42*1f03f305SGreg Roach    public function values(): array
43*1f03f305SGreg Roach    {
44*1f03f305SGreg Roach        return [
45*1f03f305SGreg Roach            ''     => '',
46*1f03f305SGreg Roach            'CHIL' => I18N::translate('child'),
47*1f03f305SGreg Roach            'HUSB' => I18N::translate('husband'),
48*1f03f305SGreg Roach            'WIFE' => I18N::translate('wife'),
49*1f03f305SGreg Roach            'MOTH' => I18N::translate('mother'),
50*1f03f305SGreg Roach            'FATH' => I18N::translate('father'),
51*1f03f305SGreg Roach            'SPOU' => I18N::translate('spouse'),
52*1f03f305SGreg Roach        ];
53*1f03f305SGreg Roach    }
54c2ed51d1SGreg Roach}
55