maxh\Nominatim\Reverse

Complexity

Total Complexity

6

Size/Duplication

Total Lines	91
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	osmType()	0	12	2
A	osmId()	0	6	1
A	latlon()	0	8	1
A	zoom()	0	6	1

<?php
/**
 * Class Reverse
 *
 * @package      maxh\nominatim
 * @author       Maxime Hélias <maximehelias16@gmail.com>
 */

namespace maxh\Nominatim;

use maxh\Nominatim\Exceptions\InvalidParameterException;

/**
 * Reverse Geocoding a OSM nominatim service for places.
 *
 * @see http://wiki.openstreetmap.org/wiki/Nominatim
 */
class Reverse extends Query
{

	/**
	 * OSM Type accepted (Node/Way/Relation)
	 * @var array
	 */
	public $osmType = ['N', 'W', 'R'];


	/**
	 * Constructo
	 * @param array $query Default value for this query
	 */
	public function __construct(array $query = [])
	{
		parent::__construct();

		$this->setPath('reverse');
	}

	// -- Builder methods ------------------------------------------------------

	/**
	 * [osmType description]
	 * 
	 * @param  string $type
	 * 
	 * @return maxh\Nominatim\Reverse
	 * @throws maxh\Nominatim\Exceptions\InvalidParameterException  if osm type is not supported
	 */
	public function osmType($type)
	{
		if (in_array($type, $this->osmType))
		{
			$this->query['osm_type'] = $type;

			return $this;
		}

		throw new InvalidParameterException("OSM Type is not supported");

	}

	/**
	 * A specific osm node / way / relation to return an address for.
	 * 
	 * @param  integer $id
	 * 
	 * @return maxh\Nominatim\Reverse
	 */
	public function osmId($id)
	{
		$this->query['osm_id'] = $id;

		return $this;
	}

	/**
	 * The location to generate an address for
	 * 
	 * @param  float $lat The latitude
	 * @param  float $lon The longitude
	 * 
	 * @return maxh\Nominatim\Reverse
	 */
	public function latlon($lat, $lon)
	{
		$this->query['lat'] = $lat;

		$this->query['lon'] = $lon;

		return $this;
	}

	/**
	 * Level of detail required where 0 is country and 18 is house/building
	 * 
	 * @param  integer $zoom 
	 * 
	 * @return maxh\Nominatim\Reverse
	 */
	public function zoom($zoom)
	{
		$this->query['zoom'] = strval($zoom);

		return $this;
	}


}