xref: /webtrees/app/Module/ModuleMapLinkTrait.php (revision a020b8bd22327c55a48db9cc18431b6152b701c4) 
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\Module;
21
22use Fisharebest\Webtrees\Fact;
23use Fisharebest\Webtrees\I18N;
24
25use function e;
26
27/**
28 * Trait ModuleMapLinkTrait - default implementation of ModuleMapLinkInterface
29 */
30trait ModuleMapLinkTrait
31{
32    /**
33     * How should this module be identified in the control panel, etc.?
34     *
35     * @return string
36     */
37    public function title(): string
38    {
39        return $this->providerName() . ' — ' . I18N::translate('Map link');
40    }
41
42    /**
43     * A sentence describing what this module does.
44     *
45     * @return string
46     */
47    public function description(): string
48    {
49        return I18N::translate('Show the location of an event on an external map.');
50    }
51
52    /**
53     * @param Fact $fact
54     *
55     * @return string
56     */
57    public function mapLink(Fact $fact): string
58    {
59        if ($this->isMapAvailableForLocation($fact)) {
60            $icon  = $this->icon();
61            $url   = $this->mapUrl($fact);
62            $title = I18N::translate('View this location using %s', $this->providerName());
63
64            return '<a href="' . e($url) . '" rel="nofollow" target="_top" title="' . $title . '">' . $icon . '</a>';
65        }
66
67        return '';
68    }
69
70    /**
71     * Name of the map provider.
72     *
73     * @return string
74     */
75    protected function providerName(): string
76    {
77        return 'example.com';
78    }
79
80    /**
81     * @param Fact $fact
82     *
83     * @return bool
84     */
85    protected function isMapAvailableForLocation(Fact $fact): bool
86    {
87        return $fact->latitude() !== null && $fact->longitude() !== null;
88    }
89
90    /**
91     * @return string
92     */
93    protected function icon(): string
94    {
95        return 'icon';
96    }
97
98    /**
99     * @param Fact $fact
100     *
101     * @return string
102     */
103    protected function mapUrl(/** @scrutinizer ignore-unused */ Fact $fact): string
104    {
105        return 'https://example.com';
106    }
107}
108