Completed
Push — master ( cebfe9...116ae5 )
by Jeroen De
11s
created

SemanticMaps::initExtension()   B

Complexity

Conditions 1
Paths 1

Size

Total Lines 24
Code Lines 16

Duplication

Lines 0
Ratio 0 %

Importance

Changes 3
Bugs 1 Features 0
Metric Value
c 3
b 1
f 0
dl 0
loc 24
rs 8.9713
cc 1
eloc 16
nc 1
nop 0
1
<?php
0 ignored issues
show
Coding Style Compatibility introduced by
For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 34 and the first side effect is on line 11.

The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.

The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.

To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.

Loading history...
2
3
/**
4
 * Initialization file for the Semantic Maps extension.
5
 *
6
 * @licence GNU GPL v2+
7
 * @author Jeroen De Dauw < [email protected] >
8
 */
9
10
if ( !defined( 'MEDIAWIKI' ) ) {
11
	die( 'Not an entry point.' );
12
}
13
14
if ( defined( 'SM_VERSION' ) ) {
15
	// Do not initialize more than once.
16
	return 1;
17
}
18
19
if ( version_compare( $GLOBALS['wgVersion'], '1.23c', '<' ) ) {
20
	throw new Exception(
21
		'This version of Semantic Maps requires MediaWiki 1.23 or above; use Semantic Maps 3.3.x for older versions.'
22
		. ' See https://github.com/SemanticMediaWiki/SemanticMaps/blob/master/INSTALL.md for more info.'
23
	);
24
}
25
26
if ( !defined( 'Maps_VERSION' ) && is_readable( __DIR__ . '/vendor/autoload.php' ) ) {
27
	include_once( __DIR__ . '/vendor/autoload.php' );
28
}
29
30
if ( !defined( 'Maps_VERSION' ) ) {
31
	throw new Exception( 'You need to have Maps installed in order to use Semantic Maps' );
32
}
33
34
define( 'SM_VERSION', '3.4.0-alpha' );
35
36
require_once __DIR__ . '/DefaultSettings.php';
37
38
SemanticMaps::newFromMediaWikiGlobals( $GLOBALS )->initExtension();
39
40
$GLOBALS['wgExtensionFunctions'][] = function() {
41
	// Hook for initializing the Geographical Data types.
42
	$GLOBALS['wgHooks']['SMW::DataType::initTypes'][] = 'SemanticMapsHooks::initGeoDataTypes';
43
44
	// Hook for defining the default query printer for queries that ask for geographical coordinates.
45
	$GLOBALS['wgHooks']['SMWResultFormat'][] = 'SemanticMapsHooks::addGeoCoordsDefaultFormat';
46
47
	// Hook for adding a Semantic Maps links to the Admin Links extension.
48
	$GLOBALS['wgHooks']['AdminLinks'][] = 'SemanticMapsHooks::addToAdminLinks';
49
50
	$GLOBALS['wgHooks']['sfFormPrinterSetup'][] = 'SemanticMaps\FormInputsSetup::run';
51
};
52
53
/**
54
 * @codeCoverageIgnore
55
 */
56
class SemanticMaps {
57
58
	private $mwGlobals;
59
60
	public static function newFromMediaWikiGlobals( array &$mwGlobals ) {
61
		return new self( $mwGlobals );
62
	}
63
64
	private function __construct( array &$mwGlobals ) {
65
		$this->mwGlobals =& $mwGlobals;
66
	}
67
68
	/**
69
	 * @since 3.4
70
	 */
71
	public function initExtension() {
72
		$this->mwGlobals['wgExtensionCredits']['semantic'][] = [
73
			'path' => __FILE__,
74
			'name' => 'Semantic Maps',
75
			'version' => SM_VERSION,
76
			'author' => [
77
				'[https://www.mediawiki.org/wiki/User:Jeroen_De_Dauw Jeroen De Dauw]'
78
			],
79
			'url' => 'https://github.com/SemanticMediaWiki/SemanticMaps/blob/master/README.md#semantic-maps',
80
			'descriptionmsg' => 'semanticmaps-desc',
81
			'license-name'   => 'GPL-2.0+'
82
		];
83
84
		include_once __DIR__ . '/src/queryprinters/SM_QueryPrinters.php';
85
86
		$this->registerResourceModules();
87
88
		$this->registerGoogleMaps();
89
		$this->registerLeaflet();
90
		$this->registerOpenLayers();
91
92
		// Internationalization
93
		$this->mwGlobals['wgMessagesDirs']['SemanticMaps'] = __DIR__ . '/i18n';
94
	}
95
96
	private function registerResourceModules() {
97
		$moduleTemplate = [
98
			'position' => 'bottom',
99
			'group' => 'ext.semanticmaps',
100
		];
101
102
		$this->mwGlobals['wgResourceModules']['ext.sm.forminputs'] = $moduleTemplate + [
103
			'dependencies' => [ 'ext.maps.coord' ],
104
			'localBasePath' => __DIR__ . '/src/forminputs',
105
			'remoteExtPath' => 'SemanticMaps/src/forminputs',
106
			'scripts' => [
107
				'jquery.mapforminput.js'
108
			],
109
			'messages' => [
110
				'semanticmaps_enteraddresshere',
111
				'semanticmaps-updatemap',
112
				'semanticmaps_lookupcoordinates',
113
				'semanticmaps-forminput-remove',
114
				'semanticmaps-forminput-add',
115
				'semanticmaps-forminput-locations'
116
			]
117
		];
118
119
		$this->mwGlobals['wgResourceModules']['ext.sm.common'] = $moduleTemplate + [
120
			'localBasePath' => __DIR__ . '/src',
121
			'remoteExtPath' => 'SemanticMaps/src',
122
			'scripts' => [
123
				'ext.sm.common.js'
124
			]
125
		];
126
	}
127
128
	private function registerGoogleMaps() {
129
		$moduleTemplate = [
130
			'localBasePath' => __DIR__ . '/src/services/GoogleMaps3',
131
			'remoteExtPath' => 'SemanticMaps/src/services/GoogleMaps3',
132
			'group' => 'ext.semanticmaps',
133
		];
134
135
		$this->mwGlobals['wgResourceModules']['ext.sm.fi.googlemaps3ajax'] = $moduleTemplate + [
136
				'dependencies' => [
137
					'ext.maps.googlemaps3',
138
					'ext.sm.common'
139
				],
140
				'scripts' => [
141
					'ext.sm.googlemaps3ajax.js'
142
				]
143
			];
144
145
		$this->mwGlobals['wgResourceModules']['ext.sm.fi.googlemaps3'] = $moduleTemplate + [
146
				'dependencies' => [
147
					'ext.sm.fi.googlemaps3.single',
148
				],
149
				'scripts' => [
150
					'ext.sm.googlemapsinput.js',
151
				],
152
			];
153
154
		$this->mwGlobals['wgResourceModules']['ext.sm.fi.googlemaps3.single'] = $moduleTemplate + [
155
				'dependencies' => [
156
					'ext.maps.googlemaps3',
157
					'ext.sm.forminputs',
158
				],
159
				'scripts' => [
160
					'jquery.googlemapsinput.js',
161
				],
162
				'messages' => [
163
				]
164
			];
165
166
		$this->mwGlobals['wgHooks']['MappingServiceLoad'][] = function() {
167
			global $wgAutoloadClasses;
168
169
			$wgAutoloadClasses['SMGoogleMaps3FormInput'] = __DIR__ . '/SM_GoogleMaps3FormInput.php';
170
171
			MapsMappingServices::registerServiceFeature( 'googlemaps3', 'qp', 'SMMapPrinter' );
172
			MapsMappingServices::registerServiceFeature( 'googlemaps3', 'fi', 'SMGoogleMaps3FormInput' );
173
174
			/* @var MapsMappingService $googleMaps */
175
			$googleMaps = MapsMappingServices::getServiceInstance( 'googlemaps3' );
176
			$googleMaps->addResourceModules( array( 'ext.sm.fi.googlemaps3ajax' ) );
177
178
			return true;
179
		};
180
	}
181
182
	private function registerLeaflet() {
183
		$this->mwGlobals['wgResourceModules']['ext.sm.fi.leafletajax'] = [
184
			'localBasePath' => __DIR__ . '/src/services/Leaflet',
185
			'remoteExtPath' => 'SemanticMaps/src/services/Leaflet',
186
			'group' => 'ext.semanticmaps',
187
			'dependencies' => [
188
				'ext.maps.leaflet',
189
				'ext.sm.common'
190
			],
191
			'scripts' => [
192
				'ext.sm.leafletajax.js'
193
			]
194
		];
195
196
		$this->mwGlobals['wgHooks']['MappingServiceLoad'][] = function() {
197
			MapsMappingServices::registerServiceFeature( 'leaflet', 'qp', 'SMMapPrinter' );
198
199
			/* @var MapsMappingService $leaflet */
200
			$leaflet = MapsMappingServices::getServiceInstance( 'leaflet' );
201
			$leaflet->addResourceModules( array( 'ext.sm.fi.leafletajax' ) );
202
203
			return true;
204
		};
205
	}
206
207
	private function registerOpenLayers() {
208
		$this->mwGlobals['wgResourceModules']['ext.sm.fi.openlayersajax'] = [
209
			'localBasePath' => __DIR__ . '/src/services/OpenLayers',
210
			'remoteExtPath' => 'SemanticMaps/src/services/OpenLayers',
211
			'group' => 'ext.semanticmaps',
212
			'dependencies' => [
213
				'ext.maps.openlayers',
214
				'ext.sm.common'
215
			],
216
			'scripts' => [
217
				'ext.sm.openlayersajax.js'
218
			]
219
		];
220
221
		$this->mwGlobals['wgHooks']['MappingServiceLoad'][] = function() {
222
			MapsMappingServices::registerServiceFeature( 'openlayers', 'qp', 'SMMapPrinter' );
223
224
			/* @var MapsMappingService $openlayers */
225
			$openlayers = MapsMappingServices::getServiceInstance( 'openlayers' );
226
			$openlayers->addResourceModules( array( 'ext.sm.fi.openlayersajax' ) );
227
228
			return true;
229
		};
230
	}
231
232
	/**
233
	 * @since 3.4
234
	 *
235
	 * @return string|null
236
	 */
237
	public static function getVersion() {
238
		return SM_VERSION;
239
	}
240
241
}
242