xref: /webtrees/app/Elements/NamePiecePrefix.php (revision 67cf9a45054a643ca0b20b35b3cbb1cf82fec9b9)
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
24use function e;
25use function view;
26
27/**
28 * NAME_PIECE_PREFIX := {Size=1:30}
29 * [ <NAME_PIECE> | <NAME_PIECE_PREFIX>, <NAME_PIECE> ]
30 * Non indexing name piece that appears preceding the given name and surname parts. Different name
31 * prefix parts are separated by a comma.
32 * For example:
33 * Lt. Cmndr. Joseph /Allen/ jr.
34 * In this example Lt. Cmndr. is considered as the name prefix portion.
35 */
36class NamePiecePrefix extends AbstractElement
37{
38    protected const MAXIMUM_LENGTH = 30;
39
40    /**
41     * An edit control for this data.
42     *
43     * @param string $id
44     * @param string $name
45     * @param string $value
46     * @param Tree   $tree
47     *
48     * @return string
49     */
50    public function edit(string $id, string $name, string $value, Tree $tree): string
51    {
52        return
53            '<div class="input-group">' .
54            parent::edit($id, $name, $value, $tree) .
55            view('edit/input-addon-keyboard', ['id' => $id]) .
56            '</div>';
57    }
58}
59