Maps\MediaWiki\ParserHooks\DisplayMapFunction

Complexity

Total Complexity

15

Size/Duplication

Total Lines	156
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	10

Test Coverage

Coverage

98.63%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getMapHtmlForKeyValueStrings()	0	22	1
A	getMapHtmlForParameterList()	0	17	1
A	__construct()	0	5	1
A	getMapHtmlFromProcessor()	0	12	1
A	extractServiceName()	0	8	1
A	processedParametersToKeyValueArray()	0	9	2
A	getHookDefinition()	0	26	1
A	defaultMapZoom()	0	7	4
A	getParameterWithValue()	0	9	1
A	trackMap()	0	5	2

<?php

namespace Maps\MediaWiki\ParserHooks;

use Maps;
use Maps\MapsFactory;
use Maps\MapsFunctions;
use Maps\MappingServices;
use Maps\Presentation\ParameterExtractor;
use MWException;
use ParamProcessor;
use ParamProcessor\ProcessedParam;
use Parser;
use ParserHooks\HookDefinition;

/**
 * Class for the 'display_map' parser hooks.
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
class DisplayMapFunction {

	private $services;

	private $renderer;

	public function __construct( MappingServices $services ) {
		$this->services = $services;

		$this->renderer = new DisplayMapRenderer();
	}

	/**
	 * @param Parser $parser
	 * @param string[] $parameters Values of the array can be named parameters ("key=value") or unnamed.
	 * They are not normalized, so can be "key =  value "
	 *
	 * @return string
	 * @throws MWException
	 */
	public function getMapHtmlForKeyValueStrings( Parser $parser, array $parameters ): string {
		$processor = new \ParamProcessor\Processor( new \ParamProcessor\Options() );

		$service = $this->services->getServiceOrDefault(
			$this->extractServiceName(
				Maps\Presentation\ParameterExtractor::extractFromKeyValueStrings( $parameters )
			)
		);

		$this->renderer->service = $service;

		$processor->setFunctionParams(
			$parameters,
			array_merge(
				self::getHookDefinition( ';' )->getParameters(),
				$service->getParameterInfo()
			),
			self::getHookDefinition( ';' )->getDefaultParameters()
		);

		return $this->getMapHtmlFromProcessor( $parser, $processor );
	}

	/**
	 * @param Parser $parser
	 * @param string[] $parameters Key value list of parameters. Unnamed parameters have numeric keys.
	 * Both keys and values have not been normalized.
	 *
	 * @return string
	 * @throws MWException
	 */
	public function getMapHtmlForParameterList( Parser $parser, array $parameters ) {
		$processor = new \ParamProcessor\Processor( new \ParamProcessor\Options() );

		$service = $this->services->getServiceOrDefault( $this->extractServiceName( $parameters ) );

		$this->renderer->service = $service;

		$processor->setParameters(
			$parameters,
			array_merge(
				self::getHookDefinition( "\n" )->getParameters(),
				$service->getParameterInfo()
			)
		);

		return $this->getMapHtmlFromProcessor( $parser, $processor );
	}

	private function getMapHtmlFromProcessor( Parser $parser, ParamProcessor\Processor $processor ) {
		$params = $processor->processParameters()->getParameters();

		$this->defaultMapZoom( $params );

		$this->trackMap( $parser );

		return $this->renderer->renderMap(
			$this->processedParametersToKeyValueArray( $params ),
			$parser
		);
	}

	private function extractServiceName( array $parameters ): string {
		$service = ( new ParameterExtractor() )->extract(
			[ 'mappingservice', 'service' ],
			$parameters
		);

		return $service ?? '';
	}

	private function processedParametersToKeyValueArray( array $params ): array {
		$parameters = [];

		foreach ( $params as $parameter ) {
			$parameters[$parameter->getName()] = $parameter->getValue();
		}

		return $parameters;
	}

	public static function getHookDefinition( string $locationDelimiter ): HookDefinition {
		$params = [];

		$params['mappingservice'] = [
			'type' => 'string',
			'aliases' => 'service',
			'default' => $GLOBALS['egMapsDefaultService'],
			'values' => MapsFactory::globalInstance()->getMappingServices()->getAllNames(),
			'message' => 'maps-par-mappingservice'
		];

		$params['coordinates'] = [
			'type' => 'string',
			'aliases' => [ 'coords', 'location', 'address', 'addresses', 'locations', 'points' ],
			'default' => [],
			'islist' => true,
			'delimiter' => $locationDelimiter,
			'message' => 'maps-displaymap-par-coordinates',
		];

		return new HookDefinition(
			[ 'display_map', 'display_point', 'display_points', 'display_line' ],
			$params,

$params is of type array<string,array<string,?>,{"coordinates":"array<string,string|array|boolean,{\"type\":\"string\",\"aliases\":\"array<integer,string,{\\\"0\\\":\\\"string\\\",\\\"1\\\":\\\"string\\\",\\\"2\\\":\\\"string\\\",\\\"3\\\":\\\"string\\\",\\\"4\\\":\\\"string\\\",\\\"5\\\":\\\"string\\\"}>\",\"default\":\"array\",\"islist\":\"boolean\",\"delimiter\":\"string\",\"message\":\"string\"}>"}>, but the function expects a array<integer,object<ParamProcessor\ParamDefinition>>.

			[ 'coordinates' ]
		);
	}

	/**
	 * @param ProcessedParam[] $parameters
	 */
	private function defaultMapZoom( array &$parameters ) {
		if ( array_key_exists( 'zoom', $parameters ) && $parameters['zoom']->wasSetToDefault() && count(
				$parameters['coordinates']->getValue()
			) > 1 ) {
			$parameters['zoom'] = $this->getParameterWithValue( $parameters['zoom'], false );
		}
	}

	private function getParameterWithValue( ProcessedParam $param, $value ) {
		return new ProcessedParam(
			$param->getName(),
			$value,
			$param->wasSetToDefault(),
			$param->getOriginalName(),
			$param->getOriginalValue()
		);
	}

	private function trackMap( Parser $parser ) {
		if ( $GLOBALS['egMapsEnableCategory'] ) {
			$parser->addTrackingCategory( 'maps-tracking-category' );
		}
	}

}