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