xref: /webtrees/app/Module/OpenStreetMap.php (revision 8d018ab2fe3b6881cab8124d97e1a69e0be79d32) 
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\I18N;
23
24/**
25 * Class OpenStreetMap - use maps within webtrees
26 */
27class OpenStreetMap extends AbstractModule implements ModuleMapProviderInterface
28{
29    use ModuleMapProviderTrait;
30
31    /**
32     * Name of the map provider.
33     *
34     * @return string
35     */
36    public function description(): string
37    {
38        $link = '<a href="https://www.openstreetmap.org" dir="ltr">www.openstreetmap.org</a>';
39
40        // I18N: %s is a link/URL
41        return I18N::translate('Create maps using %s.', $link);
42    }
43
44    /**
45     * Name of the map provider.
46     *
47     * @return string
48     */
49    public function title(): string
50    {
51        return I18N::translate('OpenStreetMap™');
52    }
53
54    /**
55     * Parameters to create a TileLayer in LeafletJs.
56     *
57     * @return array<object>
58     */
59    public function leafletJsTileLayers(): array
60    {
61        return [
62            (object) [
63                'attribution' => 'Map data ©<a href="https://www.openstreetmap.org">OpenStreetMap</a> contributors, <a href="https://creativecommons.org/licenses/by-sa/2.0">CC-BY-SA</a>',
64                'default'     => true,
65                'label'       => 'Mapnik',
66                'maxZoom'     => 19,
67                'minZoom'     => 2,
68                'subdomains'  => ['a', 'b', 'c'],
69                'url'         => 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
70            ],
71            (object) [
72                'attribution' => 'Map data ©<a href="https://www.openstreetmap.org">Karte hergestellt aus OpenStreetMap-Daten</a> contributors, <a href="https://creativecommons.org/licenses/by-sa/2.0">CC-BY-SA</a>',
73                'default'     => false,
74                'label'       => 'Deutsch',
75                'maxZoom'     => 18,
76                'minZoom'     => 2,
77                'subdomains'  => ['a', 'b', 'c'],
78                'url'         => 'https://{s}.tile.openstreetmap.de/tiles/osmde/{z}/{x}/{y}.png',
79            ],
80            (object) [
81                'attribution' => 'Map data ©<a href="https://www.openstreetmap.org">OpenStreetMap</a> contributors, <a href="https://creativecommons.org/licenses/by-sa/2.0">CC-BY-SA</a>',
82                'default'     => false,
83                'label'       => 'Français',
84                'maxZoom'     => 20,
85                'minZoom'     => 2,
86                'subdomains'  => ['a', 'b', 'c'],
87                'url'         => 'https://{s}.tile.openstreetmap.fr/osmfr/{z}/{x}/{y}.png',
88            ],
89        ];
90    }
91}
92