xref: /webtrees/app/Elements/SubmitterText.php (revision c4943cff72f95a28fbb9404e3c20b169ff098e5c)
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
24/**
25 * SUBMITTER_TEXT:= {Size=1:248}
26 * Comments or opinions from the submitter.
27 */
28class SubmitterText extends AbstractElement
29{
30    /**
31     * Convert a value to a canonical form.
32     *
33     * @param string $value
34     *
35     * @return string
36     */
37    public function canonical(string $value): string
38    {
39        // Browsers use MS-DOS line endings in multi-line data.
40        return strtr($value, ["\t" => ' ', "\r\n" => "\n", "\r" => "\n"]);
41    }
42
43    /**
44     * An edit control for this data.
45     *
46     * @param string $id
47     * @param string $name
48     * @param string $value
49     * @param Tree   $tree
50     *
51     * @return string
52     */
53    public function edit(string $id, string $name, string $value, Tree $tree): string
54    {
55        return $this->editTextArea($id, $name, $value);
56    }
57}
58