Completed
Push — develop ( c3a705...4b9394 )
by Greg
11:16
created

BingMaps::isEnabledByDefault()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 1
c 1
b 0
f 0
nc 1
nop 0
dl 0
loc 3
rs 10
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
18
declare(strict_types=1);
19
20
namespace Fisharebest\Webtrees\Module;
21
22
use Fisharebest\Webtrees\FlashMessages;
23
use Fisharebest\Webtrees\I18N;
24
use Psr\Http\Message\ResponseInterface;
25
use Psr\Http\Message\ServerRequestInterface;
26
27
use function redirect;
28
29
/**
30
 * Class BingMaps - use maps within webtrees
31
 */
32
class 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
     * LeafletJS definitions for the layer
103
     *
104
     * @return object
105
     */
106
    public function layerData(): object
107
    {
108
        $api_key = $this->getPreference('api_key');
109
110
        return (object) [
111
            'title'  => 'Bing™ Maps',
112
            'user'   => (object) [
113
                'bingMapsKey' => $api_key,
114
            ],
115
            'common' => [
116
                'help' => '<a href="https://www.bingmapsportal.com">Bing Maps Dev center</a>',
117
            ],
118
            'styles' => [
119
                (object) [
120
                    'title'      => 'Aerial',
121
                    'parameters' => (object) [
122
                        'imagerySet' => 'Aerial',
123
                    ],
124
                ],
125
                (object) [
126
                    'title'      => 'CanvasDark',
127
                    'parameters' => (object) [
128
                        'imagerySet' => 'CanvasDark',
129
                    ],
130
                ],
131
                (object) [
132
                    'title'      => 'CanvasGray',
133
                    'parameters' => (object) [
134
                        'imagerySet' => 'CanvasGray',
135
                    ],
136
                ],
137
                (object) [
138
                    'title'      => 'CanvasLight',
139
                    'parameters' => (object) [
140
                        'imagerySet' => 'CanvasLight',
141
                    ],
142
                ],
143
                (object) [
144
                    'title'      => 'Road',
145
                    'parameters' => (object) [
146
                        'imagerySet' => 'Road',
147
                    ],
148
                ],
149
            ],
150
        ];
151
    }
152
}
153