Completed
Push — master ( 57deb3...27bbfa )
by Jeroen De
03:31
created

LeafletService::getResourceModules()   B

Complexity

Conditions 7
Paths 32

Size

Total Lines 27

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 10
CRAP Score 8.1426

Importance

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