Completed
Push — develop ( 4b9394...9b940a )
by Greg
10:11
created

OrdnanceSurveyHistoricMaps::layerData()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 16
Code Lines 14

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 14
c 1
b 0
f 0
nc 1
nop 0
dl 0
loc 16
rs 9.7998
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\I18N;
23
24
/**
25
 * Class OrdnanceSurvey - use maps within webtrees
26
 */
27
class OrdnanceSurveyHistoricMaps extends AbstractModule implements ModuleMapProviderInterface
28
{
29
    use ModuleMapProviderTrait;
30
31
    /**
32
     * Name of the map provider.
33
     *
34
     * @return string
35
     */
36
    public function title(): string
37
    {
38
        return I18N::translate('Ordnance Survey historic maps');
39
    }
40
41
    /**
42
     * Name of the map provider.
43
     *
44
     * @return string
45
     */
46
    public function description(): string
47
    {
48
        $link = '<a href="https://maps.nls.uk/projects/api" dir="ltr">maps.nls.uk/projects/api</a>';
49
50
        // I18N: %s is a link/URL
51
        return I18N::translate('Create maps using %s.', $link);
52
    }
53
54
    /**
55
     * Should this module be enabled when it is first installed?
56
     *
57
     * @return bool
58
     */
59
    public function isEnabledByDefault(): bool
60
    {
61
        return false;
62
    }
63
64
    /**
65
     * Parameters to create a TileLayer in LeafletJs.
66
     *
67
     * @return array<object>
68
     */
69
    public function leafletJsTileLayers(): array
70
    {
71
        return [
72
            (object) [
73
                'attribution' => 'Historical Maps Layer, 1919-1947 from the <a href="http://maps.nls.uk/projects/api">NLS Maps API</a>',
74
                'bounds'      => [[49.852539, -7.793077], [60.894042, 1.790425]],
75
                'default'     => true,
76
                'label'       => 'Historic map of Great Britain',
77
                'maxZoom'     => 17,
78
                'minZoom'     => 2,
79
                'subdomains'  => ['0', '1', '2', '3'],
80
                'url'         => 'http://nls-{s}.tileserver.com/nls/{z}/{x}/{y}.jpg',
81
            ],
82
        ];
83
    }
84
}
85