xref: /webtrees/app/Elements/NamePieceSurname.php (revision e873f434551745f888937263ff89e80db3b0f785)
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\Http\RequestHandlers\AutoCompleteSurname;
23use Fisharebest\Webtrees\Tree;
24
25use function e;
26use function view;
27
28/**
29 * NAME_PIECE_SUFFIX := {Size=1:30}
30 * [ <NAME_PIECE> | <NAME_PIECE_SURNAME>, <NAME_PIECE> ]
31 * Surname or family name. Different surnames are separated by a comma.
32 */
33class NamePieceSurname extends AbstractElement
34{
35    protected const int MAXIMUM_LENGTH = 30;
36
37    /**
38     * An edit control for this data.
39     *
40     * @param string $id
41     * @param string $name
42     * @param string $value
43     * @param Tree   $tree
44     *
45     * @return string
46     */
47    public function edit(string $id, string $name, string $value, Tree $tree): string
48    {
49        return
50            '<div class="input-group">' .
51            '<input data-wt-autocomplete-url="' . e(route(AutoCompleteSurname::class, ['tree' => $tree->name()])) . '" autocomplete="off" class="form-control" dir="auto" type="text" id="' . e($id) . '" name="' . e($name) . '" value="' . e($value) . '" />' .
52            view('edit/input-addon-keyboard', ['id' => $id]) .
53            view('edit/input-addon-help', ['topic' => 'SURN']) .
54            '</div>';
55    }
56}
57