xref: /webtrees/app/Module/MapGeoLocationGeonames.php (revision 2bcd31b392b0420599af17af8f32329019b8d05b) 
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;
24
25use Fisharebest\Webtrees\Site;
26use Psr\Http\Message\ResponseInterface;
27use Psr\Http\Message\ServerRequestInterface;
28
29use function redirect;
30use function view;
31
32/**
33 * Class MapLocationGeonames - use geonames to find locations
34 */
35class MapGeoLocationGeonames extends AbstractModule implements ModuleConfigInterface, ModuleMapGeoLocationInterface
36{
37    use ModuleConfigTrait;
38    use ModuleMapGeoLocationTrait;
39
40    /**
41     * Name of the map provider.
42     *
43     * @return string
44     */
45    public function title(): string
46    {
47        return /* I18N: https://www.geonames.org */ I18N::translate('GeoNames');
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        // This was a global setting before it became a module setting...
68        $default  = Site::getPreference('geonames');
69        $username = $this->getPreference('username', $default);
70
71        return $this->viewResponse('modules/geonames/config', [
72            'username' => $username,
73            'title'    => $this->title(),
74        ]);
75    }
76
77    /**
78     * @param ServerRequestInterface $request
79     *
80     * @return ResponseInterface
81     */
82    public function postAdminAction(ServerRequestInterface $request): ResponseInterface
83    {
84        $params = (array) $request->getParsedBody();
85
86        $this->setPreference('username', $params['username' ?? '']);
87
88        FlashMessages::addMessage(I18N::translate('The preferences for the module “%s” have been updated.', $this->title()), 'success');
89
90        return redirect($this->getConfigLink());
91    }
92}
93