xref: /webtrees/app/Elements/AddressLine.php (revision a153042268d32ae98310fb9723000d635c1952c6)
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\Tree;
23
24/**
25 * ADDRESS_LINE := {Size=1:60}
26 * Typically used to define a mailing address of an individual when used
27 * subordinate to a RESIdent tag. When it is used subordinate to an event tag
28 * it is the address of the place where the event took place. The address
29 * lines usually contain the addressee’s name and other street and city
30 * information so that it forms an address that meets mailing requirements.
31 */
32class AddressLine extends AbstractElement
33{
34    protected const MAXIMUM_LENGTH = 60;
35
36    protected const SUBTAGS = [
37        'ADR1' => '0:1:?',
38        'ADR2' => '0:1:?',
39        'ADR3' => '0:1:?',
40        'CITY' => '0:1:?',
41        'CTRY' => '0:1:?',
42        'POST' => '0:1:?',
43        'STAE' => '0:1:?',
44    ];
45
46    /**
47     * Convert a value to a canonical form.
48     *
49     * @param string $value
50     *
51     * @return string
52     */
53    public function canonical(string $value): string
54    {
55        return $this->canonicalText($value);
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 $this->editTextArea($id, $name, $value);
71    }
72}
73