xref: /webtrees/app/Elements/MultimediaFileReference.php (revision 5bfc689774bb9a6401271c4ed15a6d50652c991b)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2022 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 * MULTIMEDIA_FILE_REFERENCE := {Size=1:30}
26 * A complete local or remote file reference to the auxiliary data to be linked
27 * to the GEDCOM context. Remote reference would include a network address
28 * where the multimedia data may be obtained.
29 */
30class MultimediaFileReference extends AbstractElement
31{
32    protected const SUBTAGS = [
33        'FORM' => '0:1',
34        'TITL' => '0:1',
35    ];
36
37    /**
38     * Convert a value to a canonical form.
39     *
40     * @param string $value
41     *
42     * @return string
43     */
44    public function canonical(string $value): string
45    {
46        // Leading/trailing/multiple spaces are valid in filenames.
47        return strtr($value, ["\t" => '', "\r" => '', "\n" => '']);
48    }
49
50    /**
51     * Display the value of this type of element.
52     *
53     * @param string $value
54     * @param Tree   $tree
55     *
56     * @return string
57     */
58    public function value(string $value, Tree $tree): string
59    {
60        return $this->valueLink($value);
61    }
62}
63