DisplayMapRenderer::getLocationJson() - Code Metrics - Inspection of "Merge pull request #614 from JeroenDeDauw/cargo" - JeroenDeDauw/Maps - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4d0076...81538e )

by Jeroen De

created 2020-04-12 23:16 UTC

DisplayMapRenderer::getLocationJson() A

↳ Parent: DisplayMapRenderer

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	25
ccs	11
cts	11
cp	1
rs	9.52
c	0
b	0
f	0
cc	3
nc	3
nop	1
crap	3

<?php

declare( strict_types = 1 );

namespace Maps\Map\DisplayMap;

use Maps\DataAccess\MediaWikiFileUrlFinder;
use Maps\Elements\Location;
use Maps\Map\MapData;
use Maps\Map\MapOutput;
use Maps\Map\MapOutputBuilder;
use Maps\MappingService;
use Maps\Presentation\ElementJsonSerializer;
use Maps\Map\MapHtmlBuilder;
use Maps\Presentation\WikitextParser;
use Maps\Presentation\WikitextParsers\LocationParser;
use Parser;

/**
 * Class handling the #display_map rendering.
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < [email protected] >
 * @author Kim Eik
 */
class DisplayMapRenderer {

	public $service;

	/**
	 * @var LocationParser
	 */
	private $locationParser;

	/**
	 * @var MediaWikiFileUrlFinder
	 */
	private $fileUrlFinder;

	/**
	 * @var WikitextParser
	 */
	private $wikitextParser;
	/**
	 * @var ElementJsonSerializer
	 */
	private $elementSerializer;

	public function __construct( MappingService $service = null ) {
		$this->service = $service;
	}

	/**
	 * Handles the request from the parser hook by doing the work that's common for all
	 * mapping services, calling the specific methods and finally returning the resulting output.
	 *
	 * @param MapData $mapData
	 * @param Parser $parser
	 *
	 * @return MapOutput
	 */
	public final function renderMap( MapData $mapData, Parser $parser ): MapOutput {
		$factory = \Maps\MapsFactory::globalInstance();

		$this->locationParser = $factory->newLocationParser();
		$this->fileUrlFinder = $factory->getFileUrlFinder();

		$this->wikitextParser = new WikitextParser( clone $parser );
		$this->elementSerializer = new ElementJsonSerializer( $this->wikitextParser );

		$mapData->setParameters( $this->handleMarkerData( $mapData->getParameters() ) );

		// TODO: inject
		$outputBuilder = new MapOutputBuilder();

		return $outputBuilder->buildOutput( $this->service, $mapData );
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
	}

	/**
	 * Converts the data in the coordinates parameter to JSON-ready objects.
	 * These get stored in the locations parameter, and the coordinates on gets deleted.
	 */
	private function handleMarkerData( array $params ) {
		$params['centre'] = $this->getCenter( $params['centre'] );

		// FIXME: this parameter is google maps service specific
		if ( array_key_exists( 'wmsoverlay', $params ) && is_object( $params['wmsoverlay'] ) ) {
			$params['wmsoverlay'] = $params['wmsoverlay']->getJSONObject();
		}

		$params['locations'] = $this->getLocationJson( $params );

		unset( $params['coordinates'] );

		$this->handleShapeData( $params );

		return $params;
	}

	private function getCenter( $coordinatesOrAddress ) {
		if ( $coordinatesOrAddress === false ) {
			return false;
		}

		try {
			// FIXME: a Location makes no sense here, since the non-coordinate data is not used
			$location = $this->locationParser->parse( $coordinatesOrAddress );
		}
		catch ( \Exception $ex ) {
			// TODO: somehow report this to the user
			return false;
		}

		return $location->getJSONObject();
	}

	private function getLocationJson( array $params ) {
		$iconUrl = $this->fileUrlFinder->getUrlForFileName( $params['icon'] );
		$visitedIconUrl = $this->fileUrlFinder->getUrlForFileName( $params['visitedicon'] ?? '' );

		$locationJsonObjects = [];

		foreach ( $params['coordinates'] as $coordinatesOrAddress ) {
			try {
				$location = $this->locationParser->parse( $coordinatesOrAddress );
			}
			catch ( \Exception $ex ) {
				// TODO: somehow report this to the user
				continue;
			}

			$locationJsonObjects[] = $this->getLocationJsonObject(
				$location,
				$params,
				$iconUrl,
				$visitedIconUrl
			);
		}

		return $locationJsonObjects;
	}

	private function getLocationJsonObject( Location $location, array $params, $iconUrl, $visitedIconUrl ) {
		$jsonObj = $location->getJSONObject( $params['title'], $params['label'], $iconUrl, '', '', $visitedIconUrl );

		$this->elementSerializer->titleAndText( $jsonObj );

		if ( isset( $jsonObj['inlineLabel'] ) ) {
			$jsonObj['inlineLabel'] = strip_tags(
				$this->wikitextParser->wikitextToHtml( $jsonObj['inlineLabel'] ),
				'<a><img>'
			);
		}

		return $jsonObj;
	}

	private function handleShapeData( array &$params ) {
		$textContainers = [
			&$params['lines'],
			&$params['polygons'],
			&$params['circles'],
			&$params['rectangles'],
			&$params['imageoverlays'], // FIXME: this is Google Maps specific!!
		];

		foreach ( $textContainers as &$textContainer ) {
			if ( is_array( $textContainer ) ) {
				foreach ( $textContainer as &$obj ) {
					$obj = $this->elementSerializer->elementToJson( $obj );
				}
			}
		}
	}

}


1		<?php
2
3		declare( strict_types = 1 );
4
5		namespace Maps\Map\DisplayMap;
6
7		use Maps\DataAccess\MediaWikiFileUrlFinder;
8		use Maps\Elements\Location;
9		use Maps\Map\MapData;
10		use Maps\Map\MapOutput;
11		use Maps\Map\MapOutputBuilder;
12		use Maps\MappingService;
13		use Maps\Presentation\ElementJsonSerializer;
14		use Maps\Map\MapHtmlBuilder;
15		use Maps\Presentation\WikitextParser;
16		use Maps\Presentation\WikitextParsers\LocationParser;
17		use Parser;
18
19		/**
20		* Class handling the #display_map rendering.
21		*
22		* @licence GNU GPL v2+
23		* @author Jeroen De Dauw < [email protected] >
24		* @author Kim Eik
25		*/
26		class DisplayMapRenderer {
27
28		public $service;
29
30		/**
31		* @var LocationParser
32		*/
33		private $locationParser;
34
35		/**
36		* @var MediaWikiFileUrlFinder
37		*/
38		private $fileUrlFinder;
39
40		/**
41		* @var WikitextParser
42		*/
43		private $wikitextParser;
44		/**
45		* @var ElementJsonSerializer
46		*/
47		private $elementSerializer;
48
49	27	public function __construct( MappingService $service = null ) {
50	27	$this->service = $service;
51	27	}
52
53		/**
54		* Handles the request from the parser hook by doing the work that's common for all
55		* mapping services, calling the specific methods and finally returning the resulting output.
56		*
57		* @param MapData $mapData
58		* @param Parser $parser
59		*
60		* @return MapOutput
61		*/
62	27	public final function renderMap( MapData $mapData, Parser $parser ): MapOutput {
63	27	$factory = \Maps\MapsFactory::globalInstance();
64
65	27	$this->locationParser = $factory->newLocationParser();
66	27	$this->fileUrlFinder = $factory->getFileUrlFinder();
67
68	27	$this->wikitextParser = new WikitextParser( clone $parser );
69	27	$this->elementSerializer = new ElementJsonSerializer( $this->wikitextParser );
70
71	27	$mapData->setParameters( $this->handleMarkerData( $mapData->getParameters() ) );
72
73		// TODO: inject
74	27	$outputBuilder = new MapOutputBuilder();
75
76	27	return $outputBuilder->buildOutput( $this->service, $mapData );
		0 ignored issues – show Bug introduced 2020-04-12 04:20 UTC by Report Bug Copy Issue Report It seems like `$this->service` can be `null`; however, `buildOutput()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
77		}
78
79		/**
80		* Converts the data in the coordinates parameter to JSON-ready objects.
81		* These get stored in the locations parameter, and the coordinates on gets deleted.
82		*/
83	27	private function handleMarkerData( array $params ) {
84	27	$params['centre'] = $this->getCenter( $params['centre'] );
85
86		// FIXME: this parameter is google maps service specific
87	27	if ( array_key_exists( 'wmsoverlay', $params ) && is_object( $params['wmsoverlay'] ) ) {
88		$params['wmsoverlay'] = $params['wmsoverlay']->getJSONObject();
89		}
90
91	27	$params['locations'] = $this->getLocationJson( $params );
92
93	27	unset( $params['coordinates'] );
94
95	27	$this->handleShapeData( $params );
96
97	27	return $params;
98		}
99
100	27	private function getCenter( $coordinatesOrAddress ) {
101	27	if ( $coordinatesOrAddress === false ) {
102	27	return false;
103		}
104
105		try {
106		// FIXME: a Location makes no sense here, since the non-coordinate data is not used
107		$location = $this->locationParser->parse( $coordinatesOrAddress );
108		}
109		catch ( \Exception $ex ) {
110		// TODO: somehow report this to the user
111		return false;
112		}
113
114		return $location->getJSONObject();
115		}
116
117	27	private function getLocationJson( array $params ) {
118	27	$iconUrl = $this->fileUrlFinder->getUrlForFileName( $params['icon'] );
119	27	$visitedIconUrl = $this->fileUrlFinder->getUrlForFileName( $params['visitedicon'] ?? '' );
120
121	27	$locationJsonObjects = [];
122
123	27	foreach ( $params['coordinates'] as $coordinatesOrAddress ) {
124		try {
125	16	$location = $this->locationParser->parse( $coordinatesOrAddress );
126		}
127	1	catch ( \Exception $ex ) {
128		// TODO: somehow report this to the user
129	1	continue;
130		}
131
132	15	$locationJsonObjects[] = $this->getLocationJsonObject(
133	15	$location,
134		$params,
135		$iconUrl,
136		$visitedIconUrl
137		);
138		}
139
140	27	return $locationJsonObjects;
141		}
142
143	15	private function getLocationJsonObject( Location $location, array $params, $iconUrl, $visitedIconUrl ) {
144	15	$jsonObj = $location->getJSONObject( $params['title'], $params['label'], $iconUrl, '', '', $visitedIconUrl );
145
146	15	$this->elementSerializer->titleAndText( $jsonObj );
147
148	15	if ( isset( $jsonObj['inlineLabel'] ) ) {
149	1	$jsonObj['inlineLabel'] = strip_tags(
150	1	$this->wikitextParser->wikitextToHtml( $jsonObj['inlineLabel'] ),
151	1	'<a><img>'
152		);
153		}
154
155	15	return $jsonObj;
156		}
157
158	27	private function handleShapeData( array &$params ) {
159		$textContainers = [
160	27	&$params['lines'],
161	27	&$params['polygons'],
162	27	&$params['circles'],
163	27	&$params['rectangles'],
164	27	&$params['imageoverlays'], // FIXME: this is Google Maps specific!!
165		];
166
167	27	foreach ( $textContainers as &$textContainer ) {
168	27	if ( is_array( $textContainer ) ) {
169	27	foreach ( $textContainer as &$obj ) {
170	5	$obj = $this->elementSerializer->elementToJson( $obj );
171		}
172		}
173		}
174	27	}
175
176		}
177

JeroenDeDauw / Maps

Push — master ( 4d0076...81538e )

DisplayMapRenderer::getLocationJson() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like