WNBY\NearbyParserFunction

Complexity

Total Complexity

23

Size/Duplication

Total Lines	123
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

91.67%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
B	parse()	0	33	7
A	getHtmlFor()	0	17	2
B	doValidateKeyValueForParameterMatch()	0	20	6
B	addMapServices()	0	20	6
A	addMappingServiceDependencies()	0	4	1

<?php

namespace WNBY;

use Maps\MappingService;
use Maps\MappingServices;
use Maps\MapsFactory;
use Parser;
use Html;

/**
 * @license GNU GPL v2+
 * @since 1.0
 *
 * @author mwjames
 */
class NearbyParserFunction {

	/**
	 * @var Parser
	 */
	private $parser;

	/**
	 * @since  1.0
	 *
	 * @return Parser $parser

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

	 */
	public function __construct( Parser $parser ) {
		$this->parser = $parser;
	}

	/**
	 * @since  1.0
	 *
	 * @param array $params
	 *
	 * @return string
	 */
	public function parse( array $params ) {

		$parameters = array();
		$class = 'whats-nearby';

		if( isset( $params[0] ) && $params[0] instanceof \Parser ) {

The class Parser does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json?

			array_shift( $params );
		}

		foreach ( $params as $key => $value ) {
			$this->doValidateKeyValueForParameterMatch( $key, $value, $class, $parameters );
		}

		$this->addMapServices( $parameters );
		$geoip = true;

		if ( isset( $parameters['nolocation'] ) ||
			( isset( $parameters['detectlocation'] ) && !$parameters['detectlocation'] ) ) {
			$geoip = false;
		}

		// Is to signal the OutputPageParserOutput hook
		$this->parser->getOutput()->setExtensionData(
			'wnby-geoip',
			$geoip
		);

		$this->parser->getOutput()->addModules(
			'ext.whats.nearby'
		);

		return $this->getHtmlFor( $class, $parameters );
	}

	private function getHtmlFor( $class, $parameters ) {
		return Html::rawElement(
			'div',
			array(
				'class' => $class . ( isset( $parameters['class'] ) ? ' ' . $parameters['class'] : '' ),
				'data-parameters' => json_encode( $parameters )
			),
			Html::rawElement( 'div', array( 'id' => 'controls',  'style' => 'display:none' ) ) .
			Html::rawElement( 'div', array( 'id' => 'selection', 'style' => 'display:none' ) ) .
			Html::rawElement( 'div', array( 'id' => 'status' ),
				Html::rawElement( 'span', array( 'class' => 'geolocation' ) ) .
				Html::rawElement( 'span', array( 'class' => 'localcache' ) ) .
				Html::rawElement( 'span', array( 'class' => 'error' ) )
			) .
			Html::rawElement( 'div', array( 'id' => 'output', 'style' => 'opacity: 0.5;' ), wfMessage( 'wnby-loading' )->text() )
		);
	}

	private function doValidateKeyValueForParameterMatch( $key, $value, &$class, &$parameters ) {

The parameter $class is not used and could be removed.

		if ( $key == 0 && strpos( $value, '=' ) === false ) {
			$parameters['condition'] = $value;
		}

		// Build printrequest identifier for a template
		// extending argument
		if ( $value !== '' && $value{0} === '?' ) {
			$parameters['pr-' . $key] = $value;
			return;
		}

		if ( strpos( $value, '=' ) === false ) {
			return;
		}

		list( $k, $v ) = explode( '=', $value );
		$parameters[strtolower( $k )] = $v;
	}

	private function addMapServices( &$parameters ) {

		if ( isset( $parameters['format'] ) &&
			in_array( $parameters['format'], array( 'openlayers', 'leaflet', 'googlemaps', 'googlemaps3', 'maps', 'google' ) ) ) {
			$parameters['maps'] = $parameters['format'];
		}

		if ( !isset( $parameters['maps'] ) || !class_exists( MappingServices::class ) ) {
			return;
		}

		$services = MapsFactory::globalInstance()->getMappingServices();

		if ( $services->nameIsKnown( $parameters['maps'] ) ) {
			$this->addMappingServiceDependencies(
				$services->getService( $parameters['maps'] ),
				$parameters
			);
		}
	}

	private function addMappingServiceDependencies( MappingService $service, array $parameters ) {
		$this->parser->getOutput()->addHeadItem( $service->getDependencyHtml( $parameters ) );
		$this->parser->getOutput()->addModules( $service->getResourceModules() );
	}

}