xref: /webtrees/app/Elements/NamePieceSurname.php (revision d11be7027e34e3121be11cc025421873364403f9)
1c2ed51d1SGreg Roach<?php
2c2ed51d1SGreg Roach
3c2ed51d1SGreg Roach/**
4c2ed51d1SGreg Roach * webtrees: online genealogy
5*d11be702SGreg Roach * Copyright (C) 2023 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
22c2ed51d1SGreg Roachuse Fisharebest\Webtrees\Http\RequestHandlers\AutoCompleteSurname;
23c2ed51d1SGreg Roachuse Fisharebest\Webtrees\Tree;
24c2ed51d1SGreg Roach
25c2ed51d1SGreg Roachuse function e;
26c2ed51d1SGreg Roachuse function view;
27c2ed51d1SGreg Roach
28c2ed51d1SGreg Roach/**
29c2ed51d1SGreg Roach * NAME_PIECE_SUFFIX := {Size=1:30}
30c2ed51d1SGreg Roach * [ <NAME_PIECE> | <NAME_PIECE_SURNAME>, <NAME_PIECE> ]
31c2ed51d1SGreg Roach * Surname or family name. Different surnames are separated by a comma.
32c2ed51d1SGreg Roach */
33c2ed51d1SGreg Roachclass NamePieceSurname extends AbstractElement
34c2ed51d1SGreg Roach{
35ae0043b7SGreg Roach    protected const MAXIMUM_LENGTH = 30;
36c2ed51d1SGreg Roach
37c2ed51d1SGreg Roach    /**
38c2ed51d1SGreg Roach     * An edit control for this data.
39c2ed51d1SGreg Roach     *
40c2ed51d1SGreg Roach     * @param string $id
41c2ed51d1SGreg Roach     * @param string $name
42c2ed51d1SGreg Roach     * @param string $value
43c2ed51d1SGreg Roach     * @param Tree   $tree
44c2ed51d1SGreg Roach     *
45c2ed51d1SGreg Roach     * @return string
46c2ed51d1SGreg Roach     */
47c2ed51d1SGreg Roach    public function edit(string $id, string $name, string $value, Tree $tree): string
48c2ed51d1SGreg Roach    {
49c2ed51d1SGreg Roach        return
50c2ed51d1SGreg Roach            '<div class="input-group">' .
51d4786c66SGreg Roach            '<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) . '" />' .
52c2ed51d1SGreg Roach            view('edit/input-addon-keyboard', ['id' => $id]) .
53ab7d502dSGreg Roach            view('edit/input-addon-help', ['topic' => 'SURN']) .
54c2ed51d1SGreg Roach            '</div>';
55c2ed51d1SGreg Roach    }
56c2ed51d1SGreg Roach}
57