xref: /webtrees/app/Module/BingMaps.php (revision d1da5ba430762bd82a5d57bc40552492431d11ee) 
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\FlashMessages;
23use Fisharebest\Webtrees\I18N;
24use Psr\Http\Message\ResponseInterface;
25use Psr\Http\Message\ServerRequestInterface;
26
27use function redirect;
28
29/**
30 * Class BingMaps - use maps within webtrees
31 */
32class BingMaps extends AbstractModule implements ModuleConfigInterface, ModuleMapProviderInterface
33{
34    use ModuleConfigTrait;
35    use ModuleMapProviderTrait;
36
37    /**
38     * Name of the map provider.
39     *
40     * @return string
41     */
42    public function description(): string
43    {
44        $link = '<a href="https://www.bing.com/maps" dir="ltr">www.bing.com/maps</a>';
45
46        // I18N: %s is a link/URL
47        return I18N::translate('Create maps using %s.', $link);
48    }
49
50    /**
51     * Should this module be enabled when it is first installed?
52     *
53     * @return bool
54     */
55    public function isEnabledByDefault(): bool
56    {
57        return false;
58    }
59
60    /**
61     * @return ResponseInterface
62     */
63    public function getAdminAction(): ResponseInterface
64    {
65        $this->layout = 'layouts/administration';
66
67        $api_key = $this->getPreference('api_key');
68
69        return $this->viewResponse('modules/bing-maps/config', [
70            'api_key' => $api_key,
71            'title'   => $this->title(),
72        ]);
73    }
74
75    /**
76     * Name of the map provider.
77     *
78     * @return string
79     */
80    public function title(): string
81    {
82        return I18N::translate('Bing™ maps');
83    }
84
85    /**
86     * @param ServerRequestInterface $request
87     *
88     * @return ResponseInterface
89     */
90    public function postAdminAction(ServerRequestInterface $request): ResponseInterface
91    {
92        $params = (array) $request->getParsedBody();
93
94        $this->setPreference('api_key', $params['api_key'] ?? '');
95
96        FlashMessages::addMessage(I18N::translate('The preferences for the module “%s” have been updated.', $this->title()), 'success');
97
98        return redirect($this->getConfigLink());
99    }
100
101    /**
102     * Parameters to create a TileLayer in LeafletJs.
103     *
104     * @return array<object>
105     */
106    public function leafletJsTileLayers(): array
107    {
108        $api_key = $this->getPreference('api_key');
109
110        return [
111            (object) [
112                'bingMapsKey' => $api_key,
113                'default'     => false,
114                'imagerySet' => 'Aerial',
115                'label' => 'Aerial',
116            ],
117            (object) [
118                'bingMapsKey' => $api_key,
119                'default'     => false,
120                'imagerySet' => 'CanvasDark',
121                'label' => 'Dark',
122            ],
123            (object) [
124                'bingMapsKey' => $api_key,
125                'default'     => false,
126                'imagerySet' => 'CanvasGray',
127                'label' => 'Grey',
128            ],
129            (object) [
130                'bingMapsKey' => $api_key,
131                'default'     => true,
132                'imagerySet' => 'CanvasLight',
133                'label' => 'Light',
134            ],
135            (object) [
136                'bingMapsKey' => $api_key,
137                'default'     => false,
138                'imagerySet' => 'Road',
139                'label' => 'Road',
140            ],
141        ];
142    }
143}
144