xref: /webtrees/app/Module/ModuleMapLinkTrait.php (revision e873f434551745f888937263ff89e80db3b0f785) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2023 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    public function description(): string
43    {
44        return I18N::translate('Show the location of an event on an external map.');
45    }
46
47    /**
48     * @param Fact $fact
49     *
50     * @return string
51     */
52    public function mapLink(Fact $fact): string
53    {
54        if ($this->isMapAvailableForLocation($fact)) {
55            $icon  = $this->icon();
56            $url   = $this->mapUrl($fact);
57            $title = I18N::translate('View this location using %s', $this->providerName());
58
59            return '<a href="' . e($url) . '" rel="nofollow" target="_top" title="' . $title . '">' . $icon . '</a>';
60        }
61
62        return '';
63    }
64
65    /**
66     * Name of the map provider.
67     *
68     * @return string
69     */
70    protected function providerName(): string
71    {
72        return 'example.com';
73    }
74
75    /**
76     * @param Fact $fact
77     *
78     * @return bool
79     */
80    protected function isMapAvailableForLocation(Fact $fact): bool
81    {
82        return $fact->latitude() !== null && $fact->longitude() !== null;
83    }
84
85    /**
86     * @return string
87     */
88    protected function icon(): string
89    {
90        return 'icon';
91    }
92
93    /**
94     * @param Fact $fact
95     *
96     * @return string
97     */
98    protected function mapUrl(Fact $fact): string
99    {
100        return 'https://example.com';
101    }
102}
103