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