blob: 35941640d83297d37a93d3da35947c0d837a5f42 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2026 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Fact;
use Fisharebest\Webtrees\I18N;
use function e;
/**
* Trait ModuleMapLinkTrait - default implementation of ModuleMapLinkInterface
*/
trait ModuleMapLinkTrait
{
public function title(): string
{
return $this->providerName() . ' — ' . I18N::translate('Map link');
}
public function description(): string
{
return I18N::translate('Show the location of an event on an external map.');
}
/**
* @param Fact $fact
*
* @return string
*/
public function mapLink(Fact $fact): string
{
if ($this->isMapAvailableForLocation($fact)) {
$icon = $this->icon();
$url = $this->mapUrl($fact);
$title = I18N::translate('View this location using %s', $this->providerName());
return '<a href="' . e($url) . '" rel="nofollow" target="_top" title="' . $title . '">' . $icon . '</a>';
}
return '';
}
/**
* Name of the map provider.
*
* @return string
*/
protected function providerName(): string
{
return 'example.com';
}
/**
* @param Fact $fact
*
* @return bool
*/
protected function isMapAvailableForLocation(Fact $fact): bool
{
return $fact->latitude() !== null && $fact->longitude() !== null;
}
/**
* @return string
*/
protected function icon(): string
{
return 'icon';
}
/**
* @param Fact $fact
*
* @return string
*/
protected function mapUrl(Fact $fact): string
{
return 'https://example.com';
}
}
|
