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