xref: /webtrees/app/Elements/NamePieceNickname.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\Tree;
23
24use function view;
25
26/**
27 * NAME_PIECE_NICKNAME := {Size=1:30}
28 * [ <NAME_PIECE> | <NAME_PIECE_NICKNAME>, <NAME_PIECE> ]
29 * A descriptive or familiar name used in connection with one's proper name.
30 */
31class NamePieceNickname extends AbstractElement
32{
33    protected const int MAXIMUM_LENGTH = 30;
34
35    /**
36     * An edit control for this data.
37     *
38     * @param string $id
39     * @param string $name
40     * @param string $value
41     * @param Tree   $tree
42     *
43     * @return string
44     */
45    public function edit(string $id, string $name, string $value, Tree $tree): string
46    {
47        return
48            '<div class="input-group">' .
49            parent::edit($id, $name, $value, $tree) .
50            view('edit/input-addon-keyboard', ['id' => $id]) .
51            '</div>';
52    }
53}
54