Completed
Pull Request — master (#112)
by Jeroen De
16:19 queued 06:22
created

SemanticMaps::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 3
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 1
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__ . '/SM_Settings.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
		$this->registerResourceModules();
85
86
		$this->registerGoogleMaps();
87
		$this->registerLeaflet();
88
		$this->registerOpenLayers();
89
90
		$this->mwGlobals['smwgResultFormats']['kml'] = SMKMLPrinter::class;
91
92
		$this->mwGlobals['wgHooks']['MappingServiceLoad'][] = function() {
93
			$this->mwGlobals['smwgResultAliases'][$this->mwGlobals['egMapsDefaultServices']['qp']][] = 'map';
94
		};
95
96
		// Internationalization
97
		$this->mwGlobals['wgMessagesDirs']['SemanticMaps'] = __DIR__ . '/i18n';
98
	}
99
100
	private function registerResourceModules() {
101
		$moduleTemplate = [
102
			'position' => 'bottom',
103
			'group' => 'ext.semanticmaps',
104
		];
105
106
		$this->mwGlobals['wgResourceModules']['ext.sm.forminputs'] = $moduleTemplate + [
107
			'dependencies' => [ 'ext.maps.coord' ],
108
			'localBasePath' => __DIR__ . '/src/forminputs',
109
			'remoteExtPath' => 'SemanticMaps/src/forminputs',
110
			'scripts' => [
111
				'jquery.mapforminput.js'
112
			],
113
			'messages' => [
114
				'semanticmaps_enteraddresshere',
115
				'semanticmaps-updatemap',
116
				'semanticmaps_lookupcoordinates',
117
				'semanticmaps-forminput-remove',
118
				'semanticmaps-forminput-add',
119
				'semanticmaps-forminput-locations'
120
			]
121
		];
122
123
		$this->mwGlobals['wgResourceModules']['ext.sm.common'] = $moduleTemplate + [
124
			'localBasePath' => __DIR__ . '/src',
125
			'remoteExtPath' => 'SemanticMaps/src',
126
			'scripts' => [
127
				'ext.sm.common.js'
128
			]
129
		];
130
	}
131
132
	private function registerGoogleMaps() {
133
		$moduleTemplate = [
134
			'localBasePath' => __DIR__ . '/src/services/GoogleMaps3',
135
			'remoteExtPath' => 'SemanticMaps/src/services/GoogleMaps3',
136
			'group' => 'ext.semanticmaps',
137
		];
138
139
		$this->mwGlobals['wgResourceModules']['ext.sm.fi.googlemaps3ajax'] = $moduleTemplate + [
140
				'dependencies' => [
141
					'ext.maps.googlemaps3',
142
					'ext.sm.common'
143
				],
144
				'scripts' => [
145
					'ext.sm.googlemaps3ajax.js'
146
				]
147
			];
148
149
		$this->mwGlobals['wgResourceModules']['ext.sm.fi.googlemaps3'] = $moduleTemplate + [
150
				'dependencies' => [
151
					'ext.sm.fi.googlemaps3.single',
152
				],
153
				'scripts' => [
154
					'ext.sm.googlemapsinput.js',
155
				],
156
			];
157
158
		$this->mwGlobals['wgResourceModules']['ext.sm.fi.googlemaps3.single'] = $moduleTemplate + [
159
				'dependencies' => [
160
					'ext.maps.googlemaps3',
161
					'ext.sm.forminputs',
162
				],
163
				'scripts' => [
164
					'jquery.googlemapsinput.js',
165
				],
166
				'messages' => [
167
				]
168
			];
169
170
		$this->mwGlobals['wgHooks']['MappingServiceLoad'][] = function() {
171
			/* @var MapsMappingService $googleMaps */
172
			$googleMaps = MapsMappingServices::getServiceInstance( 'googlemaps3' );
173
			$googleMaps->addResourceModules( array( 'ext.sm.fi.googlemaps3ajax' ) );
174
175
			$googleMaps->addFeature( 'fi', SMGoogleMaps3FormInput::class );
176
177
			SMMapPrinter::registerService( $googleMaps );
178
179
			$this->mwGlobals['smwgResultFormats'][$googleMaps->getName()] = SMMapPrinter::class;
180
			$this->mwGlobals['smwgResultAliases'][$googleMaps->getName()] = $googleMaps->getAliases();
181
		};
182
	}
183
184
	private function registerLeaflet() {
185
		$this->mwGlobals['wgResourceModules']['ext.sm.fi.leafletajax'] = [
186
			'localBasePath' => __DIR__ . '/src/services/Leaflet',
187
			'remoteExtPath' => 'SemanticMaps/src/services/Leaflet',
188
			'group' => 'ext.semanticmaps',
189
			'dependencies' => [
190
				'ext.maps.leaflet',
191
				'ext.sm.common'
192
			],
193
			'scripts' => [
194
				'ext.sm.leafletajax.js'
195
			]
196
		];
197
198
		$this->mwGlobals['wgHooks']['MappingServiceLoad'][] = function() {
199
			/* @var MapsMappingService $leaflet */
200
			$leaflet = MapsMappingServices::getServiceInstance( 'leaflet' );
201
			$leaflet->addResourceModules( array( 'ext.sm.fi.leafletajax' ) );
202
203
			SMMapPrinter::registerService( $leaflet );
204
205
			$this->mwGlobals['smwgResultFormats'][$leaflet->getName()] = SMMapPrinter::class;
206
			$this->mwGlobals['smwgResultAliases'][$leaflet->getName()] = $leaflet->getAliases();
207
		};
208
	}
209
210
	private function registerOpenLayers() {
211
		$this->mwGlobals['wgResourceModules']['ext.sm.fi.openlayersajax'] = [
212
			'localBasePath' => __DIR__ . '/src/services/OpenLayers',
213
			'remoteExtPath' => 'SemanticMaps/src/services/OpenLayers',
214
			'group' => 'ext.semanticmaps',
215
			'dependencies' => [
216
				'ext.maps.openlayers',
217
				'ext.sm.common'
218
			],
219
			'scripts' => [
220
				'ext.sm.openlayersajax.js'
221
			]
222
		];
223
224
		$this->mwGlobals['wgHooks']['MappingServiceLoad'][] = function() {
225
			/* @var MapsMappingService $openLayers */
226
			$openLayers = MapsMappingServices::getServiceInstance( 'openlayers' );
227
			$openLayers->addResourceModules( array( 'ext.sm.fi.openlayersajax' ) );
228
229
			SMMapPrinter::registerService( $openLayers );
230
231
			$this->mwGlobals['smwgResultFormats'][$openLayers->getName()] = SMMapPrinter::class;
232
			$this->mwGlobals['smwgResultAliases'][$openLayers->getName()] = $openLayers->getAliases();
233
		};
234
	}
235
236
	/**
237
	 * @since 3.4
238
	 *
239
	 * @return string|null
240
	 */
241
	public static function getVersion() {
242
		return SM_VERSION;
243
	}
244
245
}
246