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

EsriMaps::description()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 6
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 2
c 1
b 0
f 0
nc 1
nop 0
dl 0
loc 6
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\I18N;
23
24
/**
25
 * Class EsriMaps - use maps within webtrees
26
 */
27
class EsriMaps 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('Esri 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.esri.com" dir="ltr">maps.esri.com</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
     * LeafletJS definitions for the layer
66
     *
67
     * @return object
68
     */
69
    public function layerData(): object
70
    {
71
        return (object) [
72
            'title'  => 'Esri/Arcgis',
73
            'help'   => '<a href="https://developers.arcgis.com/pricing">Esri/Arcgis</a>',
74
            'user'   => (object) [],
75
            'common' => [
76
                'url' => 'https://server.arcgisonline.com/ArcGIS/rest/services/{variant}/MapServer/tile/{z}/{y}/{x}',
77
            ],
78
            'styles' => [
79
                (object) [
80
                    'title'      => 'WorldStreetMap',
81
                    'parameters' => (object) [
82
                        'attribution' => 'Tiles &copy; Esri &mdash; Source: Esri, DeLorme, NAVTEQ, USGS, Intermap, iPC, NRCAN, Esri Japan, METI, Esri China (Hong Kong), Esri (Thailand), TomTom, 2012',
83
                        'variant'     => 'World_Street_Map',
84
                        'maxZoom'     => 18,
85
                    ],
86
                ],
87
                (object) [
88
                    'title'      => 'WorldTopoMap',
89
                    'parameters' => (object) [
90
                        'attribution' => 'Tiles &copy; Esri &mdash; Esri, DeLorme, NAVTEQ, TomTom, Intermap, iPC, USGS, FAO, NPS, NRCAN, GeoBase, Kadaster NL, Ordnance Survey, Esri Japan, METI, Esri China (Hong Kong), and the GIS User Community',
91
                        'variant'     => 'World_Topo_Map',
92
                        'maxZoom'     => 19,
93
                    ],
94
                ],
95
            ],
96
        ];
97
    }
98
}
99