xref: /webtrees/app/Elements/MultimediaFileReference.php (revision 10e0649788c8d7d4974d81c048ca2b225df8f22e) 
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\I18N;
23use Fisharebest\Webtrees\Tree;
24
25use function view;
26
27/**
28 * MULTIMEDIA_FILE_REFERENCE := {Size=1:30}
29 * A complete local or remote file reference to the auxiliary data to be linked
30 * to the GEDCOM context. Remote reference would include a network address
31 * where the multimedia data may be obtained.
32 */
33class MultimediaFileReference extends AbstractElement
34{
35    protected const SUBTAGS = [
36        'FORM' => '0:1',
37        'TITL' => '0:1',
38    ];
39
40    /**
41     * Convert a value to a canonical form.
42     *
43     * @param string $value
44     *
45     * @return string
46     */
47    public function canonical(string $value): string
48    {
49        // Leading/trailing/multiple spaces are valid in filenames.
50        return strtr($value, ["\t" => '', "\r" => '', "\n" => '']);
51    }
52
53    /**
54     * Should we collapse the children of this element when editing?
55     *
56     * @return bool
57     */
58    public function collapseChildren(): bool
59    {
60        return true;
61    }
62
63    /**
64     * An edit control for this data.
65     *
66     * @param string $id
67     * @param string $name
68     * @param string $value
69     * @param Tree   $tree
70     *
71     * @return string
72     */
73    public function edit(string $id, string $name, string $value, Tree $tree): string
74    {
75        $icon    = view('icons/warning');
76        $warning = I18N::translate('If you modify the filename, you should also rename the file.');
77
78        return parent::edit($id, $name, $value, $tree) . '<div class="alert alert-warning mb-0">' . $icon . ' ' . $warning . '</div>';
79    }
80
81    /**
82     * Display the value of this type of element.
83     *
84     * @param string $value
85     * @param Tree   $tree
86     *
87     * @return string
88     */
89    public function value(string $value, Tree $tree): string
90    {
91        return $this->valueLink($value);
92    }
93}
94