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