xref: /webtrees/app/Module/MapGeoLocationGeonames.php (revision 81b514b4672980e5db010e9d89b55eaf131e798f) 
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\FlashMessages;
23use Fisharebest\Webtrees\I18N;
24use Fisharebest\Webtrees\Site;
25use Fisharebest\Webtrees\Validator;
26use Psr\Http\Message\ResponseInterface;
27use Psr\Http\Message\ServerRequestInterface;
28
29use function redirect;
30
31/**
32 * Class MapLocationGeonames - use geonames to find locations
33 */
34class MapGeoLocationGeonames extends AbstractModule implements ModuleConfigInterface, ModuleMapGeoLocationInterface
35{
36    use ModuleConfigTrait;
37    use ModuleMapGeoLocationTrait;
38
39    /**
40     * Name of the map provider.
41     *
42     * @return string
43     */
44    public function title(): string
45    {
46        return /* I18N: https://www.geonames.org */ I18N::translate('GeoNames');
47    }
48
49    /**
50     * Should this module be enabled when it is first installed?
51     *
52     * @return bool
53     */
54    public function isEnabledByDefault(): bool
55    {
56        return false;
57    }
58
59    /**
60     * @return ResponseInterface
61     */
62    public function getAdminAction(): ResponseInterface
63    {
64        $this->layout = 'layouts/administration';
65
66        // This was a global setting before it became a module setting...
67        $default  = Site::getPreference('geonames');
68        $username = $this->getPreference('username', $default);
69
70        return $this->viewResponse('modules/geonames/config', [
71            'username' => $username,
72            'title'    => $this->title(),
73        ]);
74    }
75
76    /**
77     * @param ServerRequestInterface $request
78     *
79     * @return ResponseInterface
80     */
81    public function postAdminAction(ServerRequestInterface $request): ResponseInterface
82    {
83        $api_key = Validator::parsedBody($request)->string('username');
84
85        $this->setPreference('username', $api_key);
86
87        FlashMessages::addMessage(I18N::translate('The preferences for the module “%s” have been updated.', $this->title()), 'success');
88
89        return redirect($this->getConfigLink());
90    }
91}
92