xref: /webtrees/app/Elements/NationalIdNumber.php (revision 81b514b4672980e5db010e9d89b55eaf131e798f)
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
22/**
23 * NATIONAL_ID_NUMBER := {Size=1:30}
24 * A nationally-controlled number assigned to an individual. Commonly known
25 * national numbers should be assigned their own tag, such as SSN for U.S.
26 * Social Security Number. The use of the IDNO tag requires a subordinate TYPE
27 * tag to identify what kind of number is being stored.
28 * For example:
29 * n IDNO 43-456-1899
30 * +1 TYPE Canadian Health Registration
31 */
32class NationalIdNumber extends AbstractElement
33{
34    protected const MAXIMUM_LENGTH = 30;
35
36    protected const SUBTAGS = [
37        'TYPE'  => '0:1',
38        'DATE'  => '0:1',
39        'PLAC'  => '0:1',
40        'ADDR'  => '0:1:?',
41        'EMAIL' => '0:1:?',
42        'WWW'   => '0:1:?',
43        'PHON'  => '0:1:?',
44        'FAX'   => '0:1:?',
45        'CAUS'  => '0:1:?',
46        'AGNC'  => '0:1',
47        'RELI'  => '0:1:?',
48        'NOTE'  => '0:M',
49        'OBJE'  => '0:M',
50        'SOUR'  => '0:M',
51        'RESN'  => '0:1',
52    ];
53}
54