xref: /webtrees/app/Elements/TextFromSource.php (revision 36de22acf6348b1059dac63e3cd19589574906ac)
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\Filter;
23use Fisharebest\Webtrees\Tree;
24
25/**
26 * TEXT_FROM_SOURCE := {Size=1:248}
27 * <TEXT>
28 * A verbatim copy of any description contained within the source. This indicates notes or text
29 * that are actually contained in the source document, not the submitter's opinion about the
30 * source. This should be, from the evidence point of view, "what the original record keeper
31 * said" as opposed to the researcher's interpretation. The word TEXT, in this case, means from
32 * the text which appeared in the source record including labels.
33 */
34class TextFromSource extends AbstractElement
35{
36    /**
37     * Convert a value to a canonical form.
38     *
39     * @param string $value
40     *
41     * @return string
42     */
43    public function canonical(string $value): string
44    {
45        // Browsers use MS-DOS line endings in multi-line data.
46        return strtr($value, ["\t" => ' ', "\r\n" => "\n", "\r" => "\n"]);
47    }
48
49    /**
50     * An edit control for this data.
51     *
52     * @param string $id
53     * @param string $name
54     * @param string $value
55     * @param Tree   $tree
56     *
57     * @return string
58     */
59    public function edit(string $id, string $name, string $value, Tree $tree): string
60    {
61        return $this->editTextArea($id, $name, $value);
62    }
63
64    /**
65     * Display the value of this type of element.
66     *
67     * @param string $value
68     * @param Tree   $tree
69     *
70     * @return string
71     */
72    public function value(string $value, Tree $tree): string
73    {
74        return Filter::formatText($value, $tree);
75    }
76}
77