LeafletService::getJsImageLayers() - Code Metrics - Inspection of "Merge pull request #612 from JeroenDeDauw/image-ba..." - JeroenDeDauw/Maps - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ac04d7...17d87f )

by Jeroen De

created 2020-04-02 21:24 UTC

LeafletService::getJsImageLayers() A

↳ Parent: LeafletService

Complexity

Conditions	4
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
dl	0
loc	16
ccs	0
cts	0
cp	0
rs	9.7333
c	0
b	0
f	0
cc	4
nc	3
nop	1
crap	20

<?php

declare( strict_types = 1 );

namespace Maps;

use Html;
use ParamProcessor\ParameterTypes;
use ParamProcessor\ProcessingResult;

/**
 * @licence GNU GPL v2+
 */
class LeafletService implements MappingService {

	private $addedDependencies = [];

	public function getName(): string {
		return 'leaflet';
	}

	public function getAliases(): array {
		return [ 'leafletmaps', 'leaflet' ]; // TODO: main name should not be in here?
	}

	public function getParameterInfo(): array {
		$params = MapsFunctions::getCommonParameters();

		$params['zoom'] = [
			'type' => ParameterTypes::INTEGER,
			'range' => [ 0, 20 ],
			'default' => false,
			'message' => 'maps-par-zoom'
		];

		$params['defzoom'] = [
			'type' => ParameterTypes::INTEGER,
			'range' => [ 0, 20 ],
			'default' => self::getDefaultZoom(),
			'message' => 'maps-leaflet-par-defzoom'
		];

		$params['layers'] = [
			'aliases' => 'layer',
			'type' => 'string',
			'islist' => true,
			'values' => array_keys( $GLOBALS['egMapsLeafletAvailableLayers'], true, true ),
			'default' => $GLOBALS['egMapsLeafletLayers'],
			'message' => 'maps-leaflet-par-layers',
		];

		$params['image layers'] = [
			'aliases' => [ 'image layer', 'imagelayers', 'imagelayer' ],
			'type' => 'string',
			'islist' => true,
			'default' => [],
			'message' => 'maps-leaflet-par-image-layers',
		];

		$params['overlays'] = [
			'aliases' => [ 'overlaylayers' ],
			'type' => ParameterTypes::STRING,
			'islist' => true,
			'values' => array_keys( $GLOBALS['egMapsLeafletAvailableOverlayLayers'], true, true ),
			'default' => $GLOBALS['egMapsLeafletOverlayLayers'],
			'message' => 'maps-leaflet-par-overlaylayers',
		];

		$params['resizable'] = [
			'type' => ParameterTypes::BOOLEAN,
			'default' => $GLOBALS['egMapsResizableByDefault'],
			'message' => 'maps-par-resizable'
		];

		$params['fullscreen'] = [
			'aliases' => [ 'enablefullscreen' ],
			'type' => ParameterTypes::BOOLEAN,
			'default' => false,
			'message' => 'maps-par-enable-fullscreen',
		];

		$params['scrollwheelzoom'] = [
			'aliases' => [ 'scrollzoom' ],
			'type' => ParameterTypes::BOOLEAN,
			'default' => true,
			'message' => 'maps-par-scrollwheelzoom',
		];

		$params['cluster'] = [
			'aliases' => [ 'markercluster' ],
			'type' => ParameterTypes::BOOLEAN,
			'default' => false,
			'message' => 'maps-par-markercluster',
		];

		$params['clustermaxzoom'] = [
			'type' => ParameterTypes::INTEGER,
			'default' => 20,
			'message' => 'maps-par-clustermaxzoom',
		];

		$params['clusterzoomonclick'] = [
			'type' => ParameterTypes::BOOLEAN,
			'default' => true,
			'message' => 'maps-par-clusterzoomonclick',
		];

		$params['clustermaxradius'] = [
			'type' => ParameterTypes::INTEGER,
			'default' => 80,
			'message' => 'maps-par-maxclusterradius',
		];

		$params['clusterspiderfy'] = [
			'type' => ParameterTypes::BOOLEAN,
			'default' => true,
			'message' => 'maps-leaflet-par-clusterspiderfy',
		];

		$params['geojson'] = [
			'type' => ParameterTypes::STRING,
			'default' => '',
			'message' => 'maps-displaymap-par-geojson',
		];

		$params['clicktarget'] = [
			'type' => ParameterTypes::STRING,
			'default' => '',
			'message' => 'maps-leaflet-par-clicktarget',
		];

		return $params;
	}

	/**
	 * @since 3.0
	 */
	public function getDefaultZoom() {
		return $GLOBALS['egMapsLeafletZoom'];
	}

	public function newMapId(): string {
		static $mapsOnThisPage = 0;

		$mapsOnThisPage++;

		return 'map_leaflet_' . $mapsOnThisPage;
	}

	public function getResourceModules( array $params ): array {
		$modules = [];

		$modules[] = 'ext.maps.leaflet.loader';

		if ( $params['resizable'] ) {
			$modules[] = 'ext.maps.resizable';
		}

		if ( $params['cluster'] ) {
			$modules[] = 'ext.maps.leaflet.markercluster';
		}

		if ( $params['fullscreen'] ) {
			$modules[] = 'ext.maps.leaflet.fullscreen';
		}

		if ( array_key_exists( 'geojson', $params ) ) {
			$modules[] = 'ext.maps.leaflet.editor';
		}

		if ( array_key_exists( 'ajaxquery', $params ) && $params['ajaxquery'] !== '' ) {
			$modules[] = 'ext.maps.leaflet.leafletajax';
		}

		return $modules;
	}

	public function getDependencyHtml( array $params ): string {
		$dependencies = [];

		// Only add dependencies that have not yet been added.
		foreach ( $this->getDependencies( $params ) as $dependency ) {
			if ( !in_array( $dependency, $this->addedDependencies ) ) {
				$dependencies[] = $dependency;
				$this->addedDependencies[] = $dependency;
			}
		}

		// If there are dependencies, put them all together in a string, otherwise return false.
		return $dependencies !== [] ? implode( '', $dependencies ) : false;
	}

	private function getDependencies( array $params ): array {
		$leafletPath = $GLOBALS['wgScriptPath'] . '/extensions/Maps/resources/lib/leaflet';

		return array_merge(
			[
				Html::linkedStyle( "$leafletPath/leaflet.css" ),
			],
			$this->getLayerDependencies( $params )
		);
	}

	private function getLayerDependencies( array $params ) {
		global $egMapsLeafletLayerDependencies, $egMapsLeafletAvailableLayers,
			   $egMapsLeafletLayersApiKeys;

		$layerDependencies = [];

		foreach ( $params['layers'] as $layerName ) {
			if ( array_key_exists( $layerName, $egMapsLeafletAvailableLayers )
				&& $egMapsLeafletAvailableLayers[$layerName]
				&& array_key_exists( $layerName, $egMapsLeafletLayersApiKeys )
				&& array_key_exists( $layerName, $egMapsLeafletLayerDependencies ) ) {
				$layerDependencies[] = '<script src="' . $egMapsLeafletLayerDependencies[$layerName] .
					$egMapsLeafletLayersApiKeys[$layerName] . '"></script>';
			}
		}

		return array_unique( $layerDependencies );
	}

	public function processingResultToMapParams( ProcessingResult $processingResult ): array {
		return $this->processedParamsToMapParams( $processingResult->getParameterArray() );
	}

	public function processedParamsToMapParams( array $params ): array {
		if ( $params['geojson'] !== '' ) {
			$fetcher = MapsFactory::globalInstance()->newGeoJsonFetcher();

			$result = $fetcher->fetch( $params['geojson'] );

			$params['geojson'] = $result->getContent();
			$params['GeoJsonSource'] = $result->getTitleValue() === null ? null : $result->getTitleValue()->getText();
			$params['GeoJsonRevisionId'] = $result->getRevisionId();
		}

		$params['imageLayers'] = $this->getJsImageLayers( $params['image layers'] );

		return $params;
	}

	private function getJsImageLayers( array $imageLayers ) {
		$jsImageLayers = [];

		foreach ( $imageLayers as $imageLayer ) {
			$url = MapsFactory::globalInstance()->getFileUrlFinder()->getUrlForFileName( $imageLayer );

			if ( $url !== $imageLayer && trim( $url ) !== '' ) {
				$jsImageLayers[] = [
					'name' => $imageLayer,
					'url' => $url
				];
			}
		}

		return $jsImageLayers;
	}

}


1		<?php
2
3		declare( strict_types = 1 );
4
5		namespace Maps;
6
7		use Html;
8		use ParamProcessor\ParameterTypes;
9		use ParamProcessor\ProcessingResult;
10
11		/**
12		* @licence GNU GPL v2+
13		*/
14		class LeafletService implements MappingService {
15
16	26	private $addedDependencies = [];
17	26
18		public function getName(): string {
19		return 'leaflet';
20	24	}
21	24
22		public function getAliases(): array {
23		return [ 'leafletmaps', 'leaflet' ]; // TODO: main name should not be in here?
24	18	}
25	18
26		public function getParameterInfo(): array {
27	18	$params = MapsFunctions::getCommonParameters();
28
29		$params['zoom'] = [
30		'type' => ParameterTypes::INTEGER,
31		'range' => [ 0, 20 ],
32		'default' => false,
33		'message' => 'maps-par-zoom'
34	18	];
35	18
36		$params['defzoom'] = [
37	18	'type' => ParameterTypes::INTEGER,
38	18	'range' => [ 0, 20 ],
39		'default' => self::getDefaultZoom(),
40		'message' => 'maps-leaflet-par-defzoom'
41	18	];
42	18
43	18	$params['layers'] = [
44	18	'aliases' => 'layer',
45	18	'type' => 'string',
46	18	'islist' => true,
47		'values' => array_keys( $GLOBALS['egMapsLeafletAvailableLayers'], true, true ),
48		'default' => $GLOBALS['egMapsLeafletLayers'],
49		'message' => 'maps-leaflet-par-layers',
50	18	];
51	18
52		$params['image layers'] = [
53	18	'aliases' => [ 'image layer', 'imagelayers', 'imagelayer' ],
54	18	'type' => 'string',
55	18	'islist' => true,
56		'default' => [],
57		'message' => 'maps-leaflet-par-image-layers',
58		];
59	18
60	18	$params['overlays'] = [
61	18	'aliases' => [ 'overlaylayers' ],
62	18	'type' => ParameterTypes::STRING,
63		'islist' => true,
64		'values' => array_keys( $GLOBALS['egMapsLeafletAvailableOverlayLayers'], true, true ),
65	18	'default' => $GLOBALS['egMapsLeafletOverlayLayers'],
66		'message' => 'maps-leaflet-par-overlaylayers',
67		];
68
69		$params['resizable'] = [
70		'type' => ParameterTypes::BOOLEAN,
71		'default' => $GLOBALS['egMapsResizableByDefault'],
72	18	'message' => 'maps-par-resizable'
73		];
74
75		$params['fullscreen'] = [
76		'aliases' => [ 'enablefullscreen' ],
77		'type' => ParameterTypes::BOOLEAN,
78		'default' => false,
79	18	'message' => 'maps-par-enable-fullscreen',
80		];
81
82		$params['scrollwheelzoom'] = [
83		'aliases' => [ 'scrollzoom' ],
84		'type' => ParameterTypes::BOOLEAN,
85		'default' => true,
86	18	'message' => 'maps-par-scrollwheelzoom',
87		];
88
89		$params['cluster'] = [
90		'aliases' => [ 'markercluster' ],
91		'type' => ParameterTypes::BOOLEAN,
92	18	'default' => false,
93		'message' => 'maps-par-markercluster',
94		];
95
96		$params['clustermaxzoom'] = [
97		'type' => ParameterTypes::INTEGER,
98	18	'default' => 20,
99		'message' => 'maps-par-clustermaxzoom',
100		];
101
102		$params['clusterzoomonclick'] = [
103		'type' => ParameterTypes::BOOLEAN,
104	18	'default' => true,
105		'message' => 'maps-par-clusterzoomonclick',
106		];
107
108		$params['clustermaxradius'] = [
109		'type' => ParameterTypes::INTEGER,
110	18	'default' => 80,
111		'message' => 'maps-par-maxclusterradius',
112		];
113
114		$params['clusterspiderfy'] = [
115		'type' => ParameterTypes::BOOLEAN,
116	18	'default' => true,
117		'message' => 'maps-leaflet-par-clusterspiderfy',
118		];
119
120		$params['geojson'] = [
121		'type' => ParameterTypes::STRING,
122	18	'default' => '',
123		'message' => 'maps-displaymap-par-geojson',
124		];
125
126		$params['clicktarget'] = [
127		'type' => ParameterTypes::STRING,
128	18	'default' => '',
129	18	'message' => 'maps-leaflet-par-clicktarget',
130		];
131
132	18	return $params;
133	18	}
134
135	18	/**
136		* @since 3.0
137	18	*/
138		public function getDefaultZoom() {
139		return $GLOBALS['egMapsLeafletZoom'];
140	18	}
141	18
142		public function newMapId(): string {
143	18	static $mapsOnThisPage = 0;
144
145	18	$mapsOnThisPage++;
146
147		return 'map_leaflet_' . $mapsOnThisPage;
148		}
149	18
150		public function getResourceModules( array $params ): array {
151		$modules = [];
152
153	18	$modules[] = 'ext.maps.leaflet.loader';
154
155		if ( $params['resizable'] ) {
156		$modules[] = 'ext.maps.resizable';
157	18	}
158	18
159		if ( $params['cluster'] ) {
160		$modules[] = 'ext.maps.leaflet.markercluster';
161	18	}
162
163		if ( $params['fullscreen'] ) {
164		$modules[] = 'ext.maps.leaflet.fullscreen';
165	18	}
166
167		if ( array_key_exists( 'geojson', $params ) ) {
168	18	$modules[] = 'ext.maps.leaflet.editor';
169	18	}
170
171		if ( array_key_exists( 'ajaxquery', $params ) && $params['ajaxquery'] !== '' ) {
172	18	$modules[] = 'ext.maps.leaflet.leafletajax';
173	18	}
174	1
175	1	return $modules;
176		}
177
178		public function getDependencyHtml( array $params ): string {
179		$dependencies = [];
180	18
181		// Only add dependencies that have not yet been added.
182		foreach ( $this->getDependencies( $params ) as $dependency ) {
183	18	if ( !in_array( $dependency, $this->addedDependencies ) ) {
184	18	$dependencies[] = $dependency;
185		$this->addedDependencies[] = $dependency;
186	18	}
187		}
188	18
189		// If there are dependencies, put them all together in a string, otherwise return false.
190	18	return $dependencies !== [] ? implode( '', $dependencies ) : false;
191		}
192
193		private function getDependencies( array $params ): array {
194	18	$leafletPath = $GLOBALS['wgScriptPath'] . '/extensions/Maps/resources/lib/leaflet';
195	18
196	18	return array_merge(
197		[
198	18	Html::linkedStyle( "$leafletPath/leaflet.css" ),
199		],
200	18	$this->getLayerDependencies( $params )
201	18	);
202	18	}
203	18
204	18	private function getLayerDependencies( array $params ) {
205		global $egMapsLeafletLayerDependencies, $egMapsLeafletAvailableLayers,
206		$egMapsLeafletLayersApiKeys;
207
208		$layerDependencies = [];
209
210	18	foreach ( $params['layers'] as $layerName ) {
211		if ( array_key_exists( $layerName, $egMapsLeafletAvailableLayers )
212		&& $egMapsLeafletAvailableLayers[$layerName]
213	16	&& array_key_exists( $layerName, $egMapsLeafletLayersApiKeys )
214	16	&& array_key_exists( $layerName, $egMapsLeafletLayerDependencies ) ) {
215		$layerDependencies[] = '<script src="' . $egMapsLeafletLayerDependencies[$layerName] .
216		$egMapsLeafletLayersApiKeys[$layerName] . '"></script>';
217	18	}
218	18	}
219	3
220		return array_unique( $layerDependencies );
221	3	}
222
223	3	public function processingResultToMapParams( ProcessingResult $processingResult ): array {
224	3	return $this->processedParamsToMapParams( $processingResult->getParameterArray() );
225	3	}
226
227		public function processedParamsToMapParams( array $params ): array {
228	18	if ( $params['geojson'] !== '' ) {
229		$fetcher = MapsFactory::globalInstance()->newGeoJsonFetcher();
230
231		$result = $fetcher->fetch( $params['geojson'] );
232
233		$params['geojson'] = $result->getContent();
234		$params['GeoJsonSource'] = $result->getTitleValue() === null ? null : $result->getTitleValue()->getText();
235		$params['GeoJsonRevisionId'] = $result->getRevisionId();
236		}
237
238		$params['imageLayers'] = $this->getJsImageLayers( $params['image layers'] );
239
240		return $params;
241		}
242
243		private function getJsImageLayers( array $imageLayers ) {
244		$jsImageLayers = [];
245
246		foreach ( $imageLayers as $imageLayer ) {
247		$url = MapsFactory::globalInstance()->getFileUrlFinder()->getUrlForFileName( $imageLayer );
248
249		if ( $url !== $imageLayer && trim( $url ) !== '' ) {
250		$jsImageLayers[] = [
251		'name' => $imageLayer,
252		'url' => $url
253		];
254		}
255		}
256
257		return $jsImageLayers;
258		}
259
260		}
261

JeroenDeDauw / Maps

Push — master ( ac04d7...17d87f )

LeafletService::getJsImageLayers() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like