MapsFactory::getParamDefinitionFactory() - Code Metrics - Inspection of "Add MapsFactory::getParamDefinitionFactory" - JeroenDeDauw/Maps - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — newparam ( 7a21d8...9f04a0 )

by Jeroen De

created 2019-07-29 17:23 UTC

MapsFactory::getParamDefinitionFactory() A

↳ Parent: MapsFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	1

Importance

Changes

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

<?php

declare( strict_types = 1 );

namespace Maps;

use DataValues\Geo\Parsers\LatLongParser;
use FileFetcher\Cache\Factory as CacheFactory;
use FileFetcher\FileFetcher;
use Jeroen\SimpleGeocoder\Geocoder;
use Jeroen\SimpleGeocoder\Geocoders\Decorators\CoordinateFriendlyGeocoder;
use Jeroen\SimpleGeocoder\Geocoders\FileFetchers\GeoNamesGeocoder;
use Jeroen\SimpleGeocoder\Geocoders\FileFetchers\GoogleGeocoder;
use Jeroen\SimpleGeocoder\Geocoders\FileFetchers\NominatimGeocoder;
use Jeroen\SimpleGeocoder\Geocoders\NullGeocoder;
use Maps\DataAccess\CachingGeocoder;
use Maps\DataAccess\JsonFileParser;
use Maps\DataAccess\MapsFileFetcher;
use Maps\DataAccess\MediaWikiFileUrlFinder;
use Maps\DataAccess\PageContentFetcher;
use Maps\MediaWiki\ParserHooks\DisplayMapFunction;
use Maps\Presentation\CoordinateFormatter;
use Maps\Presentation\WikitextParsers\CircleParser;
use Maps\Presentation\WikitextParsers\DistanceParser;
use Maps\Presentation\WikitextParsers\ImageOverlayParser;
use Maps\Presentation\WikitextParsers\LineParser;
use Maps\Presentation\WikitextParsers\LocationParser;
use Maps\Presentation\WikitextParsers\PolygonParser;
use Maps\Presentation\WikitextParsers\RectangleParser;
use Maps\Presentation\WikitextParsers\WmsOverlayParser;
use MediaWiki\MediaWikiServices;
use ParamProcessor\ParamDefinitionFactory;
use SimpleCache\Cache\Cache;
use SimpleCache\Cache\MediaWikiCache;

/**
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < [email protected] >
 */
class MapsFactory {

	private $settings;
	private $mediaWikiServices;

	private function __construct( array $settings, MediaWikiServices $mediaWikiServices ) {
		$this->settings = $settings;
		$this->mediaWikiServices = $mediaWikiServices;
	}

	public static function newDefault(): self {
		return new self( $GLOBALS, MediaWikiServices::getInstance() );
	}

	/**
	 * Only for legacy code where dependency injection is not possible
	 */
	public static function globalInstance(): self {
		static $instance = null;

		if ( $instance === null ) {
			$instance = self::newDefault();
		}

		return $instance;
	}

	public function newLocationParser(): LocationParser {
		return LocationParser::newInstance(
			$this->getGeocoder(),
			$this->getFileUrlFinder()
		);
	}

	public function getGeocoder(): Geocoder {
		$geocoder = new CoordinateFriendlyGeocoder( $this->newCoreGeocoder() );

		if ( $this->settings['egMapsEnableGeoCache'] ) {
			return new CachingGeocoder(
				$geocoder,
				$this->getMediaWikiCache(),
				$this->settings['egMapsGeoCacheTtl']
			);
		}

		return $geocoder;
	}

	private function newCoreGeocoder(): Geocoder {
		switch ( $this->settings['egMapsDefaultGeoService'] ) {
			case 'geonames':
				if ( $this->settings['egMapsGeoNamesUser'] === '' ) {
					return $this->newGoogleGeocoder();
				}

				return new GeoNamesGeocoder(
					$this->newFileFetcher(),
					$this->settings['egMapsGeoNamesUser']
				);
			case 'google':
				return $this->newGoogleGeocoder();
			case 'nominatim':
				return new NominatimGeocoder(
					$this->newFileFetcher()
				);
			default:
				return new NullGeocoder();
		}
	}

	private function newGoogleGeocoder(): Geocoder {
		return new GoogleGeocoder(
			$this->newFileFetcher(),
			$this->settings['egMapsGMaps3ApiKey'],
			$this->settings['egMapsGMaps3ApiVersion']
		);
	}

	public function getFileFetcher(): FileFetcher {
		return $this->newFileFetcher();
	}

	private function newFileFetcher(): FileFetcher {
		return new MapsFileFetcher();
	}

	public function getGeoJsonFileFetcher(): FileFetcher {
		if ( $this->settings['egMapsGeoJsonCacheTtl'] === 0 ) {
			return $this->getFileFetcher();
		}

		return ( new CacheFactory() )->newJeroenSimpleCacheFetcher(
			$this->getFileFetcher(),
			$this->getMediaWikiSimpleCache( $this->settings['egMapsGeoJsonCacheTtl'] )
		);
	}

	private function getMediaWikiSimpleCache( int $ttlInSeconds ): Cache {
		return new MediaWikiCache(
			$this->getMediaWikiCache(),
			$ttlInSeconds
		);
	}

	private function getMediaWikiCache(): \BagOStuff {
		return wfGetCache( CACHE_ANYTHING );
	}

	public function getPageContentFetcher(): PageContentFetcher {
		return new PageContentFetcher(
			$this->mediaWikiServices->getTitleParser(),
			$this->mediaWikiServices->getRevisionLookup()
		);
	}

	public function getCoordinateFormatter(): CoordinateFormatter {
		return new CoordinateFormatter();
	}

	public function getFileUrlFinder(): FileUrlFinder {
		return new MediaWikiFileUrlFinder();
	}

	public function getMappingServices(): MappingServices {
		return new MappingServices(
			$this->settings['egMapsAvailableServices'],
			$this->settings['egMapsDefaultService'],
			new GoogleMapsService(),
			new LeafletService()
		);
	}

	public function getDisplayMapFunction(): DisplayMapFunction {
		return new DisplayMapFunction(
			$this->getMappingServices()
		);
	}

	public function getParamDefinitionFactory(): ParamDefinitionFactory {
		$factory = ParamDefinitionFactory::newDefault();

		$factory->registerType( 'coordinate', [ 'string-parser' => LatLongParser::class ] );
		$factory->registerType( 'mapslocation', [ 'string-parser' => LocationParser::class ] );
		$factory->registerType( 'mapsline', [ 'string-parser' => LineParser::class ] );
		$factory->registerType( 'mapscircle', [ 'string-parser' => CircleParser::class ] );
		$factory->registerType( 'mapsrectangle', [ 'string-parser' => RectangleParser::class ] );
		$factory->registerType( 'mapspolygon', [ 'string-parser' => PolygonParser::class ] );
		$factory->registerType( 'distance', [ 'string-parser' => DistanceParser::class ] );
		$factory->registerType( 'wmsoverlay', [ 'string-parser' => WmsOverlayParser::class ] );
		$factory->registerType( 'mapsimageoverlay', [ 'string-parser' => ImageOverlayParser::class ] );
		$factory->registerType( 'jsonfile', [ 'string-parser' => JsonFileParser::class ] );

		return $factory;
	}

}


1		<?php
2
3		declare( strict_types = 1 );
4
5		namespace Maps;
6
7		use DataValues\Geo\Parsers\LatLongParser;
8		use FileFetcher\Cache\Factory as CacheFactory;
9		use FileFetcher\FileFetcher;
10		use Jeroen\SimpleGeocoder\Geocoder;
11		use Jeroen\SimpleGeocoder\Geocoders\Decorators\CoordinateFriendlyGeocoder;
12		use Jeroen\SimpleGeocoder\Geocoders\FileFetchers\GeoNamesGeocoder;
13		use Jeroen\SimpleGeocoder\Geocoders\FileFetchers\GoogleGeocoder;
14		use Jeroen\SimpleGeocoder\Geocoders\FileFetchers\NominatimGeocoder;
15		use Jeroen\SimpleGeocoder\Geocoders\NullGeocoder;
16		use Maps\DataAccess\CachingGeocoder;
17		use Maps\DataAccess\JsonFileParser;
18		use Maps\DataAccess\MapsFileFetcher;
19		use Maps\DataAccess\MediaWikiFileUrlFinder;
20		use Maps\DataAccess\PageContentFetcher;
21		use Maps\MediaWiki\ParserHooks\DisplayMapFunction;
22		use Maps\Presentation\CoordinateFormatter;
23		use Maps\Presentation\WikitextParsers\CircleParser;
24		use Maps\Presentation\WikitextParsers\DistanceParser;
25		use Maps\Presentation\WikitextParsers\ImageOverlayParser;
26		use Maps\Presentation\WikitextParsers\LineParser;
27		use Maps\Presentation\WikitextParsers\LocationParser;
28		use Maps\Presentation\WikitextParsers\PolygonParser;
29		use Maps\Presentation\WikitextParsers\RectangleParser;
30		use Maps\Presentation\WikitextParsers\WmsOverlayParser;
31		use MediaWiki\MediaWikiServices;
32		use ParamProcessor\ParamDefinitionFactory;
33		use SimpleCache\Cache\Cache;
34		use SimpleCache\Cache\MediaWikiCache;
35
36		/**
37		* @licence GNU GPL v2+
38		* @author Jeroen De Dauw < [email protected] >
39		*/
40		class MapsFactory {
41
42		private $settings;
43		private $mediaWikiServices;
44
45	49	private function __construct( array $settings, MediaWikiServices $mediaWikiServices ) {
46	49	$this->settings = $settings;
47	49	$this->mediaWikiServices = $mediaWikiServices;
48	49	}
49
50	49	public static function newDefault(): self {
51	49	return new self( $GLOBALS, MediaWikiServices::getInstance() );
52		}
53
54		/**
55		* Only for legacy code where dependency injection is not possible
56		*/
57	109	public static function globalInstance(): self {
58	109	static $instance = null;
59
60	109	if ( $instance === null ) {
61		$instance = self::newDefault();
62		}
63
64	109	return $instance;
65		}
66
67	20	public function newLocationParser(): LocationParser {
68	20	return LocationParser::newInstance(
69	20	$this->getGeocoder(),
70	20	$this->getFileUrlFinder()
71		);
72		}
73
74	101	public function getGeocoder(): Geocoder {
75	101	$geocoder = new CoordinateFriendlyGeocoder( $this->newCoreGeocoder() );
76
77	101	if ( $this->settings['egMapsEnableGeoCache'] ) {
78	101	return new CachingGeocoder(
79	101	$geocoder,
80	101	$this->getMediaWikiCache(),
81	101	$this->settings['egMapsGeoCacheTtl']
82		);
83		}
84
85		return $geocoder;
86		}
87
88	101	private function newCoreGeocoder(): Geocoder {
89	101	switch ( $this->settings['egMapsDefaultGeoService'] ) {
90	101	case 'geonames':
91		if ( $this->settings['egMapsGeoNamesUser'] === '' ) {
92		return $this->newGoogleGeocoder();
93		}
94
95		return new GeoNamesGeocoder(
96		$this->newFileFetcher(),
97		$this->settings['egMapsGeoNamesUser']
98		);
99	101	case 'google':
100		return $this->newGoogleGeocoder();
101	101	case 'nominatim':
102	101	return new NominatimGeocoder(
103	101	$this->newFileFetcher()
104		);
105		default:
106		return new NullGeocoder();
107		}
108		}
109
110		private function newGoogleGeocoder(): Geocoder {
111		return new GoogleGeocoder(
112		$this->newFileFetcher(),
113		$this->settings['egMapsGMaps3ApiKey'],
114		$this->settings['egMapsGMaps3ApiVersion']
115		);
116		}
117
118		public function getFileFetcher(): FileFetcher {
119		return $this->newFileFetcher();
120		}
121
122	101	private function newFileFetcher(): FileFetcher {
123	101	return new MapsFileFetcher();
124		}
125
126		public function getGeoJsonFileFetcher(): FileFetcher {
127		if ( $this->settings['egMapsGeoJsonCacheTtl'] === 0 ) {
128		return $this->getFileFetcher();
129		}
130
131		return ( new CacheFactory() )->newJeroenSimpleCacheFetcher(
132		$this->getFileFetcher(),
133		$this->getMediaWikiSimpleCache( $this->settings['egMapsGeoJsonCacheTtl'] )
134		);
135		}
136
137		private function getMediaWikiSimpleCache( int $ttlInSeconds ): Cache {
138		return new MediaWikiCache(
139		$this->getMediaWikiCache(),
140		$ttlInSeconds
141		);
142		}
143
144	101	private function getMediaWikiCache(): \BagOStuff {
145	101	return wfGetCache( CACHE_ANYTHING );
146		}
147
148		public function getPageContentFetcher(): PageContentFetcher {
149		return new PageContentFetcher(
150		$this->mediaWikiServices->getTitleParser(),
151		$this->mediaWikiServices->getRevisionLookup()
152		);
153		}
154
155	17	public function getCoordinateFormatter(): CoordinateFormatter {
156	17	return new CoordinateFormatter();
157		}
158
159	79	public function getFileUrlFinder(): FileUrlFinder {
160	79	return new MediaWikiFileUrlFinder();
161		}
162
163	20	public function getMappingServices(): MappingServices {
164	20	return new MappingServices(
165	20	$this->settings['egMapsAvailableServices'],
166	20	$this->settings['egMapsDefaultService'],
167	20	new GoogleMapsService(),
168	20	new LeafletService()
169		);
170		}
171
172	20	public function getDisplayMapFunction(): DisplayMapFunction {
173	20	return new DisplayMapFunction(
174	20	$this->getMappingServices()
175		);
176		}
177
178	86	public function getParamDefinitionFactory(): ParamDefinitionFactory {
179	86	$factory = ParamDefinitionFactory::newDefault();
180
181	86	$factory->registerType( 'coordinate', [ 'string-parser' => LatLongParser::class ] );
182	86	$factory->registerType( 'mapslocation', [ 'string-parser' => LocationParser::class ] );
183	86	$factory->registerType( 'mapsline', [ 'string-parser' => LineParser::class ] );
184	86	$factory->registerType( 'mapscircle', [ 'string-parser' => CircleParser::class ] );
185	86	$factory->registerType( 'mapsrectangle', [ 'string-parser' => RectangleParser::class ] );
186	86	$factory->registerType( 'mapspolygon', [ 'string-parser' => PolygonParser::class ] );
187	86	$factory->registerType( 'distance', [ 'string-parser' => DistanceParser::class ] );
188	86	$factory->registerType( 'wmsoverlay', [ 'string-parser' => WmsOverlayParser::class ] );
189	86	$factory->registerType( 'mapsimageoverlay', [ 'string-parser' => ImageOverlayParser::class ] );
190	86	$factory->registerType( 'jsonfile', [ 'string-parser' => JsonFileParser::class ] );
191
192	86	return $factory;
193		}
194
195		}
196

JeroenDeDauw / Maps

Push — newparam ( 7a21d8...9f04a0 )

MapsFactory::getParamDefinitionFactory() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like