MapBox::leafletJsTileLayers() - Code Metrics - Inspection of "Working on GEDCOM elements" - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 4b9394...9b940a )

by Greg

created 2021-04-28 15:01 UTC

MapBox::leafletJsTileLayers() B

↳ Parent: MapBox

Complexity

Conditions	1
Paths	1

Size

Total Lines	69
Code Lines	62

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	62
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	69
rs	8.829

How to fix Long Method

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2021 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Module;

use Fisharebest\Webtrees\FlashMessages;
use Fisharebest\Webtrees\I18N;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

use function redirect;

/**
 * Class MapBox - use maps within webtrees
 */
class MapBox extends AbstractModule implements ModuleConfigInterface, ModuleMapProviderInterface
{
    use ModuleConfigTrait;
    use ModuleMapProviderTrait;

    /**
     * Name of the map provider.
     *
     * @return string
     */
    public function description(): string
    {
        $link = '<a href="https://www.mapbox.com" dir="ltr">www.mapbox.com</a>';

        // I18N: %s is a link/URL
        return I18N::translate('Create maps using %s.', $link);
    }

    /**
     * Should this module be enabled when it is first installed?
     *
     * @return bool
     */
    public function isEnabledByDefault(): bool
    {
        return false;
    }

    /**
     * @return ResponseInterface
     */
    public function getAdminAction(): ResponseInterface
    {
        $this->layout = 'layouts/administration';

        $api_key = $this->getPreference('api_key');

        return $this->viewResponse('modules/mapbox/config', [
            'api_key' => $api_key,
            'title'   => $this->title(),
        ]);
    }

    /**
     * Name of the map provider.
     *
     * @return string
     */
    public function title(): string
    {
        return I18N::translate('Mapbox');
    }

    /**
     * @param ServerRequestInterface $request
     *
     * @return ResponseInterface
     */
    public function postAdminAction(ServerRequestInterface $request): ResponseInterface
    {
        $params = (array) $request->getParsedBody();

        $this->setPreference('api_key', $params['api_key'] ?? '');

        FlashMessages::addMessage(I18N::translate('The preferences for the module “%s” have been updated.', $this->title()), 'success');

        return redirect($this->getConfigLink());
    }

    /**
     * Parameters to create a TileLayer in LeafletJs.
     *
     * @return array<object>
     */
    public function leafletJsTileLayers(): array
    {
        $api_key = $this->getPreference('api_key');

        return [
            (object) [
                'accessToken' => $api_key,
                'attribution' => '©<a href="https://www.mapbox.com/about/maps">Mapbox</a> ©<a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> <strong><a href="https://www.mapbox.com/map-feedback">Improve this map</a></strong>',
                'default'     => false,
                'id'          => 'dark-v10',
                'label'       => 'Dark',
                'maxZoom'     => 20,
                'minZoom'     => 2,
                'subdomains'  => ['a', 'b', 'c', 'd'],
                'tileSize'    => 512,
                'url'         => 'https://api.mapbox.com/styles/v1/mapbox/{id}/tiles/{z}/{x}/{y}?access_token={accessToken}',
                'zoomOffset'  => -1,
            ],
            (object) [
                'accessToken' => $api_key,
                'attribution' => '©<a href="https://www.mapbox.com/about/maps">Mapbox</a> ©<a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> <strong><a href="https://www.mapbox.com/map-feedback">Improve this map</a></strong>',
                'default'     => true,
                'id'          => 'light-v10',
                'label'       => 'Light',
                'maxZoom'     => 20,
                'minZoom'     => 2,
                'subdomains'  => ['a', 'b', 'c', 'd'],
                'tileSize'    => 512,
                'url'         => 'https://api.mapbox.com/styles/v1/mapbox/{id}/tiles/{z}/{x}/{y}?access_token={accessToken}',
                'zoomOffset'  => -1,
            ],
            (object) [
                'accessToken' => $api_key,
                'attribution' => '©<a href="https://www.mapbox.com/about/maps">Mapbox</a> ©<a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> <strong><a href="https://www.mapbox.com/map-feedback">Improve this map</a></strong>',
                'default'     => false,
                'id'          => 'outdoors-v11',
                'label'       => 'Outdoors',
                'maxZoom'     => 20,
                'minZoom'     => 2,
                'subdomains'  => ['a', 'b', 'c', 'd'],
                'tileSize'    => 512,
                'url'         => 'https://api.mapbox.com/styles/v1/mapbox/{id}/tiles/{z}/{x}/{y}?access_token={accessToken}',
                'zoomOffset'  => -1,
            ],
            (object) [
                'accessToken' => $api_key,
                'attribution' => '©<a href="https://www.mapbox.com/about/maps">Mapbox</a> ©<a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> <strong><a href="https://www.mapbox.com/map-feedback">Improve this map</a></strong>',
                'default'     => false,
                'id'          => 'satellite-v9',
                'label'       => 'Satellite',
                'maxZoom'     => 20,
                'minZoom'     => 2,
                'subdomains'  => ['a', 'b', 'c', 'd'],
                'tileSize'    => 512,
                'url'         => 'https://api.mapbox.com/styles/v1/mapbox/{id}/tiles/{z}/{x}/{y}?access_token={accessToken}',
                'zoomOffset'  => -1,
            ],
            (object) [
                'accessToken' => $api_key,
                'attribution' => '©<a href="https://www.mapbox.com/about/maps">Mapbox</a> ©<a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> <strong><a href="https://www.mapbox.com/map-feedback">Improve this map</a></strong>',
                'default'     => false,
                'id'          => 'streets-v11',
                'label'       => 'Streets',
                'maxZoom'     => 20,
                'minZoom'     => 2,
                'subdomains'  => ['a', 'b', 'c', 'd'],
                'tileSize'    => 512,
                'url'         => 'https://api.mapbox.com/styles/v1/mapbox/{id}/tiles/{z}/{x}/{y}?access_token={accessToken}',
                'zoomOffset'  => -1,
            ],
        ];
    }
}


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 MapBox - use maps within webtrees
31			*/
32			class MapBox 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.mapbox.com" dir="ltr">www.mapbox.com</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/mapbox/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('Mapbox');
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			* Parameters to create a TileLayer in LeafletJs.
103			*
104			* @return array<object>
105			*/
106			public function leafletJsTileLayers(): array
107			{
108			$api_key = $this->getPreference('api_key');
109
110			return [
111			(object) [
112			'accessToken' => $api_key,
113			'attribution' => '©<a href="https://www.mapbox.com/about/maps">Mapbox</a> ©<a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> <strong><a href="https://www.mapbox.com/map-feedback">Improve this map</a></strong>',
114			'default' => false,
115			'id' => 'dark-v10',
116			'label' => 'Dark',
117			'maxZoom' => 20,
118			'minZoom' => 2,
119			'subdomains' => ['a', 'b', 'c', 'd'],
120			'tileSize' => 512,
121			'url' => 'https://api.mapbox.com/styles/v1/mapbox/{id}/tiles/{z}/{x}/{y}?access_token={accessToken}',
122			'zoomOffset' => -1,
123			],
124			(object) [
125			'accessToken' => $api_key,
126			'attribution' => '©<a href="https://www.mapbox.com/about/maps">Mapbox</a> ©<a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> <strong><a href="https://www.mapbox.com/map-feedback">Improve this map</a></strong>',
127			'default' => true,
128			'id' => 'light-v10',
129			'label' => 'Light',
130			'maxZoom' => 20,
131			'minZoom' => 2,
132			'subdomains' => ['a', 'b', 'c', 'd'],
133			'tileSize' => 512,
134			'url' => 'https://api.mapbox.com/styles/v1/mapbox/{id}/tiles/{z}/{x}/{y}?access_token={accessToken}',
135			'zoomOffset' => -1,
136			],
137			(object) [
138			'accessToken' => $api_key,
139			'attribution' => '©<a href="https://www.mapbox.com/about/maps">Mapbox</a> ©<a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> <strong><a href="https://www.mapbox.com/map-feedback">Improve this map</a></strong>',
140			'default' => false,
141			'id' => 'outdoors-v11',
142			'label' => 'Outdoors',
143			'maxZoom' => 20,
144			'minZoom' => 2,
145			'subdomains' => ['a', 'b', 'c', 'd'],
146			'tileSize' => 512,
147			'url' => 'https://api.mapbox.com/styles/v1/mapbox/{id}/tiles/{z}/{x}/{y}?access_token={accessToken}',
148			'zoomOffset' => -1,
149			],
150			(object) [
151			'accessToken' => $api_key,
152			'attribution' => '©<a href="https://www.mapbox.com/about/maps">Mapbox</a> ©<a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> <strong><a href="https://www.mapbox.com/map-feedback">Improve this map</a></strong>',
153			'default' => false,
154			'id' => 'satellite-v9',
155			'label' => 'Satellite',
156			'maxZoom' => 20,
157			'minZoom' => 2,
158			'subdomains' => ['a', 'b', 'c', 'd'],
159			'tileSize' => 512,
160			'url' => 'https://api.mapbox.com/styles/v1/mapbox/{id}/tiles/{z}/{x}/{y}?access_token={accessToken}',
161			'zoomOffset' => -1,
162			],
163			(object) [
164			'accessToken' => $api_key,
165			'attribution' => '©<a href="https://www.mapbox.com/about/maps">Mapbox</a> ©<a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a> <strong><a href="https://www.mapbox.com/map-feedback">Improve this map</a></strong>',
166			'default' => false,
167			'id' => 'streets-v11',
168			'label' => 'Streets',
169			'maxZoom' => 20,
170			'minZoom' => 2,
171			'subdomains' => ['a', 'b', 'c', 'd'],
172			'tileSize' => 512,
173			'url' => 'https://api.mapbox.com/styles/v1/mapbox/{id}/tiles/{z}/{x}/{y}?access_token={accessToken}',
174			'zoomOffset' => -1,
175			],
176			];
177			}
178			}
179

fisharebest / webtrees

Push — develop ( 4b9394...9b940a )

MapBox::leafletJsTileLayers() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like