xref: /webtrees/app/Elements/NamePieceSurnamePrefix.php (revision b11cdcd45131b1585d66693fab363cfeb18c51a4)
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\Tree;
23
24use function view;
25
26/**
27 * NAME_PIECE_SUFFIX := {Size=1:30}
28 * [ <NAME_PIECE> | <NAME_PIECE_SURNAME_PREFIX>, <NAME_PIECE> ]
29 * Surname prefix or article used in a family name. Different surname articles are separated by a
30 * comma, for example in the name "de la Cruz", this value would be "de, la".
31 */
32class NamePieceSurnamePrefix extends AbstractElement
33{
34    protected const MAXIMUM_LENGTH = 30;
35
36    /**
37     * An edit control for this data.
38     *
39     * @param string $id
40     * @param string $name
41     * @param string $value
42     * @param Tree   $tree
43     *
44     * @return string
45     */
46    public function edit(string $id, string $name, string $value, Tree $tree): string
47    {
48        return
49            '<div class="input-group">' .
50            parent::edit($id, $name, $value, $tree) .
51            view('edit/input-addon-keyboard', ['id' => $id]) .
52            '</div>';
53    }
54}
55