DataValues\Geo\Parsers\LatLongParser

Complexity

Total Complexity

8

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	2
A	parse()	0	11	3
A	getParsers()	0	10	1
A	areCoordinates()	0	9	2

<?php

namespace DataValues\Geo\Parsers;

use DataValues\Geo\Values\LatLongValue;
use ValueParsers\ParseException;
use ValueParsers\ParserOptions;
use ValueParsers\StringValueParser;
use ValueParsers\ValueParser;

/**
 * ValueParser that parses the string representation of a geographical coordinate.
 *
 * The resulting objects are of type @see LatLongValue.
 *
 * Supports the following notations:
 * - Degree minute second
 * - Decimal degrees
 * - Decimal minutes
 * - Float
 *
 * And for all these notations direction can be indicated either with
 * + and - or with N/E/S/W, the later depending on the set options.
 *
 * The delimiter between latitude and longitude can be set in the options.
 * So can the symbols used for degrees, minutes and seconds.
 *
 * Some code in this class has been borrowed from the
 * MapsCoordinateParser class of the Maps extension for MediaWiki.
 *
 * @since 0.1, name changed in 2.0
 *
 * @license GPL-2.0+
 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
 */
class LatLongParser implements ValueParser {

	/* public */ const TYPE_FLOAT = 'float';
	/* public */ const TYPE_DMS = 'dms';
	/* public */ const TYPE_DM = 'dm';
	/* public */ const TYPE_DD = 'dd';

	/**
	 * The symbols representing the different directions for usage in directional notation.
	 */
	/* public */ const OPT_NORTH_SYMBOL = 'north';
	/* public */ const OPT_EAST_SYMBOL = 'east';
	/* public */ const OPT_SOUTH_SYMBOL = 'south';
	/* public */ const OPT_WEST_SYMBOL = 'west';

	/**
	 * The symbols representing degrees, minutes and seconds.
	 */
	/* public */ const OPT_DEGREE_SYMBOL = 'degree';
	/* public */ const OPT_MINUTE_SYMBOL = 'minute';
	/* public */ const OPT_SECOND_SYMBOL = 'second';

	/**
	 * The symbol to use as separator between latitude and longitude.
	 */
	/* public */ const OPT_SEPARATOR_SYMBOL = 'separator';

	/**
	 * @var ParserOptions
	 */
	private $options;

	public function __construct( ParserOptions $options = null ) {
		$this->options = $options ?: new ParserOptions();
		$this->options->defaultOption( ValueParser::OPT_LANG, 'en' );
	}

	/**
	 * @see ValueParser::parse
	 *
	 * @param string $value
	 *
	 * @throws ParseException
	 * @return LatLongValue
	 */
	public function parse( $value ) {
		foreach ( $this->getParsers() as $parser ) {
			try {
				return $parser->parse( $value );
			} catch ( ParseException $ex ) {
				continue;
			}
		}

		throw new ParseException( 'The format of the coordinate could not be determined. Parsing failed.' );
	}

	/**
	 * @return  StringValueParser[]
	 */
	protected function getParsers() {
		$parsers = [];

		$parsers[] = new FloatCoordinateParser( $this->options );
		$parsers[] = new DmsCoordinateParser( $this->options );
		$parsers[] = new DmCoordinateParser( $this->options );
		$parsers[] = new DdCoordinateParser( $this->options );

		return $parsers;
	}

	/**
	 * Convenience function for determining if something is a valid coordinate string.
	 * Analogous to creating an instance of the parser, parsing the string and checking isValid on the result.
	 *
	 * @deprecated since 2.0, please instantiate and call isValid() instead
	 *
	 * @param string $string
	 *
	 * @return boolean
	 */
	public static function areCoordinates( $string ) {
		static $parser = null;

		if ( $parser === null ) {
			$parser = new self();
		}

		return $parser->parse( $string )->isValid();
	}

}