Passed
Push — master ( 439fb6...d97c97 )
by Greg
07:03
created

MultimediaFileReference::value()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 9
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 4
nc 2
nop 2
dl 0
loc 9
rs 10
c 0
b 0
f 0
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
18
declare(strict_types=1);
19
20
namespace Fisharebest\Webtrees\Elements;
21
22
use Fisharebest\Webtrees\Tree;
23
24
use function preg_match;
25
use function strpos;
26
use function trim;
27
28
/**
29
 * MULTIMEDIA_FILE_REFERENCE := {Size=1:30}
30
 * A complete local or remote file reference to the auxiliary data to be linked
31
 * to the GEDCOM context. Remote reference would include a network address
32
 * where the multimedia data may be obtained.
33
 */
34
class MultimediaFileReference extends AbstractElement
35
{
36
    protected const SUBTAGS = [
37
        'FORM' => '0:1',
38
        'TITL' => '0:1',
39
    ];
40
41
    /**
42
     * Convert a value to a canonical form.
43
     *
44
     * @param string $value
45
     *
46
     * @return string
47
     */
48
    public function canonical(string $value): string
49
    {
50
        // Leading/trailing/multiple spaces are valid in filenames.
51
        return strtr($value, ["\t" => ' ', "\r" => ' ', "\n" => ' ']);
52
    }
53
54
    /**
55
     * Display the value of this type of element.
56
     *
57
     * @param string $value
58
     * @param Tree   $tree
59
     *
60
     * @return string
61
     */
62
    public function value(string $value, Tree $tree): string
63
    {
64
        $canonical = $this->canonical($value);
65
66
        if (preg_match(static::REGEX_URL, $canonical)) {
67
            return '<a href="' . e($canonical) . '">' . e($canonical) . '</a>';
68
        }
69
70
        return parent::value($value, $tree);
71
    }
72
}
73