Maps\MediaWiki\Api\Geocode

Complexity

Total Complexity

10

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
B	execute()	0	35	6
A	getAllowedParams()	0	9	1
A	getParamDescription()	0	5	1
A	getDescription()	0	5	1
A	getExamples()	0	6	1

<?php

namespace Maps\MediaWiki\Api;

use ApiBase;
use Maps\MapsFactory;

/**
 * @licence GNU GPL v2++
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
class Geocode extends ApiBase {

	public function execute() {
		global $wgUser;

		if ( !$wgUser->isAllowed( 'geocode' ) || $wgUser->isBlocked() ) {
			$this->dieUsageMsg( [ 'badaccess-groups' ] );
		}

		$geocoder = MapsFactory::newDefault()->newGeocoder();

		$params = $this->extractRequestParams();

		$results = [];

		foreach ( array_unique( $params['locations'] ) as $location ) {
			$result = $geocoder->geocode( $location );

			$results[$location] = [
				'count' => $result === null ? 0 : 1,
				'locations' => []
			];

			if ( $result !== null ) {
				// FIXME: this makes the API use private var names in its output!
				$results[$location]['locations'][] = $result;
			}

			$this->getResult()->setIndexedTagName( $results[$location]['locations'], 'location' );
		}

		$this->getResult()->addValue(
			null,
			'results',
			$results
		);
	}

	public function getAllowedParams() {
		return [
			'locations' => [
				ApiBase::PARAM_TYPE => 'string',
				ApiBase::PARAM_REQUIRED => true,
				ApiBase::PARAM_ISMULTI => true,
			],
		];
	}

	public function getParamDescription() {
		return [
			'locations' => 'The locations to geocode',
		];
	}

	public function getDescription() {
		return [
			'API module for geocoding.'
		];
	}

	protected function getExamples() {
		return [
			'api.php?action=geocode&locations=new york',
			'api.php?action=geocode&locations=new york|brussels|london',
		];
	}

}