xref: /webtrees/app/Module/MapGeoLocationOpenRouteService.php (revision 30e63383b10bafff54347985dcdbd10c40c33f62) 
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 MapLocationOpenRouteService - use geonames to find locations
31 */
32class MapGeoLocationOpenRouteService extends AbstractModule implements ModuleConfigInterface, ModuleMapGeoLocationInterface
33{
34    use ModuleConfigTrait;
35    use ModuleMapGeoLocationTrait;
36
37    /**
38     * Name of the map provider.
39     *
40     * @return string
41     */
42    public function title(): string
43    {
44        return /* I18N: https://openrouteservice.org */ I18N::translate('OpenRouteService');
45    }
46
47    /**
48     * Should this module be enabled when it is first installed?
49     *
50     * @return bool
51     */
52    public function isEnabledByDefault(): bool
53    {
54        return false;
55    }
56
57    /**
58     * @return ResponseInterface
59     */
60    public function getAdminAction(): ResponseInterface
61    {
62        $this->layout = 'layouts/administration';
63
64        return $this->viewResponse('modules/openrouteservice/config', [
65            'api_key' => $this->getPreference('api_key'),
66            'title'   => $this->title(),
67        ]);
68    }
69
70    /**
71     * @param ServerRequestInterface $request
72     *
73     * @return ResponseInterface
74     */
75    public function postAdminAction(ServerRequestInterface $request): ResponseInterface
76    {
77        $params = (array) $request->getParsedBody();
78
79        $this->setPreference('api_key', $params['api_key' ?? '']);
80
81        FlashMessages::addMessage(I18N::translate('The preferences for the module “%s” have been updated.', $this->title()), 'success');
82
83        return redirect($this->getConfigLink());
84    }
85}
86