xref: /webtrees/app/Module/OpenStreetMap.php (revision e57829396e448d173bb4be808a8b9fd89548228b) 
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     * @return ResponseInterface
57     */
58    public function getAdminAction(): ResponseInterface
59    {
60        $this->layout = 'layouts/administration';
61
62        return $this->viewResponse('modules/openstreetmap/config', [
63            'title'   => $this->title(),
64        ]);
65    }
66
67    /**
68     * Parameters to create a TileLayer in LeafletJs.
69     *
70     * @return array<object>
71     */
72    public function leafletJsTileLayers(): array
73    {
74        return [
75            (object) [
76                '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>',
77                'default'     => true,
78                'label'       => 'Mapnik',
79                'maxZoom'     => 19,
80                'minZoom'     => 2,
81                'subdomains'  => ['a', 'b', 'c'],
82                'url'         => 'https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png',
83            ],
84            (object) [
85                '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>',
86                'default'     => false,
87                'label'       => 'Deutsch',
88                'maxZoom'     => 18,
89                'minZoom'     => 2,
90                'subdomains'  => ['a', 'b', 'c'],
91                'url'         => 'https://{s}.tile.openstreetmap.de/tiles/osmde/{z}/{x}/{y}.png',
92            ],
93            (object) [
94                '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>',
95                'default'     => false,
96                'label'       => 'Français',
97                'maxZoom'     => 20,
98                'minZoom'     => 2,
99                'subdomains'  => ['a', 'b', 'c'],
100                'url'         => 'https://{s}.tile.openstreetmap.fr/osmfr/{z}/{x}/{y}.png',
101            ],
102        ];
103    }
104}
105