maxhelias / php-nominatim

src/Query.php

Indentation +233 added lines, -233 removed lines

@@ -15,238 +15,238 @@
  */
 class Query implements QueryInterface
 {
-	/**
-	 * Contain the path of the request
-	 * @var string
-	 */
-	protected $path;
-
-	/**
-	 * Contain the query for request
-	 * @var array
-	 */
-	protected $query = [];
-
-	/**
-	 * Contain the format for decode data returning by the request
-	 * @var string
-	 */
-	protected $format;
-
-	/**
-	 * Output format accepted
-	 * @var array
-	 */
-	protected $accepteFormat = ['xml', 'json'];
-
-	/**
-	 * Output polygon format accepted
-	 * @var array
-	 */
-	protected $polygon = ['geojson', 'kml', 'svg', 'text'];
-
-
-	/**
-	 * Constuctor
-	 * @param array $query Default value for this query
-	 */
-	public function __construct(array $query = [])
-	{
-		if (!isset($query['format']))
-		{
-			//Default format
-			$query['format'] = 'json';
-		}
-
-		$this->setQuery($query);
-		$this->setFormat($query['format']);
-
-	}
-
-	// -- Builder methods ------------------------------------------------------
-
-	/**
-	 * Format returning by the request.
-	 *
-	 * @param  string $format The output format for the request
-	 *
-	 * @return maxh\Nominatim\Query
-	 * @throws maxh\Nominatim\Exceptions\InvalidParameterException if format is not supported
-	 */
-	public function format($format)
-	{
-		$format = strtolower($format);
-
-		if (in_array($format, $this->accepteFormat))
-		{
-			$this->setFormat($format);
-
-			return $this;
-		}
-
-		throw new InvalidParameterException("Format is not supported");
-	}
-
-	/**
-	 * Preferred language order for showing search results, overrides the value
-	 * specified in the "Accept-Language" HTTP header. Either uses standard
-	 * rfc2616 accept-language string or a simple comma separated list of
-	 * language codes.
-	 *
-	 * @param  string $language         Preferred language order for showing search results, overrides the value specified in the "Accept-Language" HTTP header.
-	 * Either uses standard rfc2616 accept-language string or a simple comma separated list of language codes.
-	 *
-	 * @return maxh\Nominatim\Query
-	 */
-	public function language($language)
-	{
-		$this->query['accept-language'] = $language;
-
-		return $this;
-	}
-
-	/**
-	 * Include a breakdown of the address into elements.
-	 *
-	 * @param  boolean $details
-	 * 
-	 * @return maxh\Nominatim\Query
-	 */
-	public function addressDetails($details = true)
-	{
-		$this->query['addressdetails'] = $details ? "1" : "0";
-
-		return $this;
-	}
-
-	/**
-	 * If you are making large numbers of request please include a valid email address or alternatively include your email address as part of the User-Agent string.
-	 * This information will be kept confidential and only used to contact you in the event of a problem, see Usage Policy for more details.
-	 * 
-	 * @param  string $email Address mail
-	 * 
-	 * @return maxh\Nominatim\Query
-	 */
-	public function email($email)
-	{
-		$this->query['email'] = $email;
-
-		return $this;
-	}
-
-	/**
-	 * Output format for the geometry of results
-	 * 
-	 * @param  string $polygon
-	 * 
-	 * @return maxh\Nominatim\Query
-	 * @throws maxh\Nominatim\Exceptions\InvalidParameterException  if polygon format is not supported
-	 */
-	public function polygon($polygon)
-	{
-		if (in_array($polygon, $this->polygon))
-		{
-			$this->query['polygon_' . $polygon] = "1";
-
-			return $this;
-		}
-
-		throw new InvalidParameterException("This polygon format is not supported");
-	}
-
-	/**
-	 * Include additional information in the result if available
-	 * 
-	 * @param  boolean $tags 
-	 * 
-	 * @return maxh\Nominatim\Query
-	 */
-	public function extraTags($tags = true)
-	{
-		$this->query['extratags'] = $tags ? "1" : "0";
-
-		return $this;
-	}
-
-	/**
-	 * Include a list of alternative names in the results.
-	 * These may include language variants, references, operator and brand.
-	 * 
-	 * @param  boolean $details 
-	 * 
-	 * @return maxh\Nominatim\Query
-	 */
-	public function nameDetails($details = true)
-	{
-		$this->query['namedetails'] = $details ? "1" : "0";
-
-		return $this;
-	}
-
-	/**
-	 * Returns the URL-encoded query.
-	 *
-	 * @return string
-	 */
-	public function getQueryString()
-	{
-		return http_build_query($this->query);
-	}
-
-	// -- Getters & Setters ----------------------------------------------------
-
-	/**
-	 * Get path
-	 * @return string
-	 */
-	public function getPath()
-	{
-		return $this->path;
-	}
-
-	/**
-	 * Get query
-	 * @return array
-	 */
-	public function getQuery()
-	{
-		return $this->query;
-	}
-
-	/**
-	 * Get format
-	 * @return string
-	 */
-	public function getFormat()
-	{
-		return $this->format;
-	}
-
-	/**
-	 * Set path
-	 * @param string $path Name's path of the service
-	 */
-	protected function setPath($path)
-	{
-		$this->path = $path;
-	}
-
-	/**
-	 * Set query
-	 * @param array $query Parameter of the query
-	 */
-	protected function setQuery($query = array())
-	{
-		$this->query = $query;
-	}
-
-	/**
-	 * Set format
-	 * @param string $format Format returning by the response
-	 */
-	protected function setFormat($format)
-	{
-		$this->format = $this->query['format'] = $format;
-	}
+    /**
+     * Contain the path of the request
+     * @var string
+     */
+    protected $path;
+
+    /**
+     * Contain the query for request
+     * @var array
+     */
+    protected $query = [];
+
+    /**
+     * Contain the format for decode data returning by the request
+     * @var string
+     */
+    protected $format;
+
+    /**
+     * Output format accepted
+     * @var array
+     */
+    protected $accepteFormat = ['xml', 'json'];
+
+    /**
+     * Output polygon format accepted
+     * @var array
+     */
+    protected $polygon = ['geojson', 'kml', 'svg', 'text'];
+
+
+    /**
+     * Constuctor
+     * @param array $query Default value for this query
+     */
+    public function __construct(array $query = [])
+    {
+        if (!isset($query['format']))
+        {
+            //Default format
+            $query['format'] = 'json';
+        }
+
+        $this->setQuery($query);
+        $this->setFormat($query['format']);
+
+    }
+
+    // -- Builder methods ------------------------------------------------------
+
+    /**
+     * Format returning by the request.
+     *
+     * @param  string $format The output format for the request
+     *
+     * @return maxh\Nominatim\Query
+     * @throws maxh\Nominatim\Exceptions\InvalidParameterException if format is not supported
+     */
+    public function format($format)
+    {
+        $format = strtolower($format);
+
+        if (in_array($format, $this->accepteFormat))
+        {
+            $this->setFormat($format);
+
+            return $this;
+        }
+
+        throw new InvalidParameterException("Format is not supported");
+    }
+
+    /**
+     * Preferred language order for showing search results, overrides the value
+     * specified in the "Accept-Language" HTTP header. Either uses standard
+     * rfc2616 accept-language string or a simple comma separated list of
+     * language codes.
+     *
+     * @param  string $language         Preferred language order for showing search results, overrides the value specified in the "Accept-Language" HTTP header.
+     * Either uses standard rfc2616 accept-language string or a simple comma separated list of language codes.
+     *
+     * @return maxh\Nominatim\Query
+     */
+    public function language($language)
+    {
+        $this->query['accept-language'] = $language;
+
+        return $this;
+    }
+
+    /**
+     * Include a breakdown of the address into elements.
+     *
+     * @param  boolean $details
+     * 
+     * @return maxh\Nominatim\Query
+     */
+    public function addressDetails($details = true)
+    {
+        $this->query['addressdetails'] = $details ? "1" : "0";
+
+        return $this;
+    }
+
+    /**
+     * If you are making large numbers of request please include a valid email address or alternatively include your email address as part of the User-Agent string.
+     * This information will be kept confidential and only used to contact you in the event of a problem, see Usage Policy for more details.
+     * 
+     * @param  string $email Address mail
+     * 
+     * @return maxh\Nominatim\Query
+     */
+    public function email($email)
+    {
+        $this->query['email'] = $email;
+
+        return $this;
+    }
+
+    /**
+     * Output format for the geometry of results
+     * 
+     * @param  string $polygon
+     * 
+     * @return maxh\Nominatim\Query
+     * @throws maxh\Nominatim\Exceptions\InvalidParameterException  if polygon format is not supported
+     */
+    public function polygon($polygon)
+    {
+        if (in_array($polygon, $this->polygon))
+        {
+            $this->query['polygon_' . $polygon] = "1";
+
+            return $this;
+        }
+
+        throw new InvalidParameterException("This polygon format is not supported");
+    }
+
+    /**
+     * Include additional information in the result if available
+     * 
+     * @param  boolean $tags 
+     * 
+     * @return maxh\Nominatim\Query
+     */
+    public function extraTags($tags = true)
+    {
+        $this->query['extratags'] = $tags ? "1" : "0";
+
+        return $this;
+    }
+
+    /**
+     * Include a list of alternative names in the results.
+     * These may include language variants, references, operator and brand.
+     * 
+     * @param  boolean $details 
+     * 
+     * @return maxh\Nominatim\Query
+     */
+    public function nameDetails($details = true)
+    {
+        $this->query['namedetails'] = $details ? "1" : "0";
+
+        return $this;
+    }
+
+    /**
+     * Returns the URL-encoded query.
+     *
+     * @return string
+     */
+    public function getQueryString()
+    {
+        return http_build_query($this->query);
+    }
+
+    // -- Getters & Setters ----------------------------------------------------
+
+    /**
+     * Get path
+     * @return string
+     */
+    public function getPath()
+    {
+        return $this->path;
+    }
+
+    /**
+     * Get query
+     * @return array
+     */
+    public function getQuery()
+    {
+        return $this->query;
+    }
+
+    /**
+     * Get format
+     * @return string
+     */
+    public function getFormat()
+    {
+        return $this->format;
+    }
+
+    /**
+     * Set path
+     * @param string $path Name's path of the service
+     */
+    protected function setPath($path)
+    {
+        $this->path = $path;
+    }
+
+    /**
+     * Set query
+     * @param array $query Parameter of the query
+     */
+    protected function setQuery($query = array())
+    {
+        $this->query = $query;
+    }
+
+    /**
+     * Set format
+     * @param string $format Format returning by the response
+     */
+    protected function setFormat($format)
+    {
+        $this->format = $this->query['format'] = $format;
+    }
 
 }

src/Nominatim.php

Indentation +169 added lines, -169 removed lines

@@ -22,174 +22,174 @@
 class Nominatim
 {
 
-	/**
-	 * Contain url of the current application
-	 * @var string
-	 */
-	private $application_url = null;
-
-	/**
-	 * Contain http client connection
-	 * @var Client
-	 */
-	private $http_client = null;
-
-	/**
-	 * The search object which serves as a template for new ones created
-	 * by 'newSearch()' method.
-	 *
-	 * @var Search
-	 */
-	private $baseSearch;
-
-	/**
-	 * Template for new ones created by 'newReverser()' method.
-	 * @var Reverse
-	 */
-	private $baseReverse;
-
-	/**
-	 * Template for new ones created by 'newLookup()' method.
-	 * @var Lookup
-	 */
-	private $baseLookup;
-
-	/**
-	 * Constructor
-	 * @param string      			$application_url Contain url of the current application
-	 * @param Guzzle\Client|null 	$http_client     Client object from Guzzle
-	 */
-	public function __construct(
-		$application_url,
-		Client $http_client = null
-	) {
-
-		if (!isset($application_url))
-		{
-			throw new InvalidParameterException("Application url parameter is empty");
-		}
-
-		if (!isset($http_client))
-		{
-			$http_client = new Client([
-				'base_uri'			 => $application_url,
-				'timeout'			 => 30,
-				'connection_timeout' => 5,
-			]);
-		} else if ($http_client instanceof Client)
-		{
-			$application_url_client = $http_client->getConfig('base_uri');
-
-			if (!isset($application_url_client))
-			{
-				$http_client->setDefaultOption('base_uri', $application_url);
-			} else if ($application_url_client != $application_url)
-			{
-				throw new InvalidParameterException("http_client parameter has a differente url to application_url parameter");
-			}
-		} else
-		{
-			throw new InvalidParameterException("http_client parameter must be a GuzzleHttp\Client object or empty");
-		}
-
-		$this->application_url = $application_url;
-		$this->http_client = $http_client;
-
-		//Create base
-		$this->baseSearch = new Search();
-		$this->baseReverse = new Reverse();
-		$this->baseLookup = new Lookup();
-
-	}
-
-	/**
-	 * Returns a new search object based on the base search.
-	 *
-	 * @return Search
-	 */
-	public function newSearch()
-	{
-		return clone $this->baseSearch;
-	}
-
-	/**
-	 * Returns a new search object based on the base reverse.
-	 *
-	 * @return Reverse
-	 */
-	public function newReverse()
-	{
-		return clone $this->baseReverse;
-	}
-
-	/**
-	 * Returns a new search object based on the base lookup.
-	 * 
-	 * @return Lookup
-	 */
-	public function newLookup()
-	{
-		return clone $this->baseLookup;
-	}
-
-	/**
-	 * Decode the data returned from the request
-	 * 
-	 * @param  string   $format   json or xml
-	 * @param  Request  $request  Request object from Guzzle
-	 * @param  ResponseInterface $response Interface response object from Guzzle
-	 * 
-	 * @return array|\SimpleXMLElement
-	 * @throws maxh\Nominatim\Exceptions\NominatimException if no format for decode
-	 */
-	private function decodeResponse($format, Request $request, ResponseInterface $response)
-	{
-
-		if ($format == 'json')
-		{
-			return json_decode($response->getBody(), true);
-		}
-
-		if ($format == 'xml')
-		{
-			return new \SimpleXMLElement($response->getBody());
-		}
-
-		throw new NominatimException("Format is undefined or not supported for decode response", $request, $response);
-	}
-
-	/**
-	 * Runs the query and returns the result set from Nominatim.
-	 * @param  QueryInterface $nRequest  The object request to send
-	 * 
-	 * @return array                                        The decoded data returned from Nominatim
-	 * @throws \GuzzleHttp\Exception\ClientException 		if http request is an error
-	 */
-	public function find(QueryInterface $nRequest)
-	{
-		$url = $this->application_url . '/' . $nRequest->getPath() . '?';
-		$request = new Request('GET', $url);
-
-		//Convert the query array to string with space replace to +
-		$query = \GuzzleHttp\Psr7\build_query($nRequest->getQuery(), PHP_QUERY_RFC1738);
-
-		$url = $request->getUri()->withQuery($query);
-		$request = $request->withUri($url);
-
-		return $this->decodeResponse(
-			$nRequest->getFormat(),
-			$request,
-			$this->http_client->send($request)
-		);
-	}
-
-	/**
-	 * Return the client using by instance
-	 * @return GuzzleHttp\Client
-	 */
-	public function getClient()
-	{
-		return $this->http_client;
-	}
+    /**
+     * Contain url of the current application
+     * @var string
+     */
+    private $application_url = null;
+
+    /**
+     * Contain http client connection
+     * @var Client
+     */
+    private $http_client = null;
+
+    /**
+     * The search object which serves as a template for new ones created
+     * by 'newSearch()' method.
+     *
+     * @var Search
+     */
+    private $baseSearch;
+
+    /**
+     * Template for new ones created by 'newReverser()' method.
+     * @var Reverse
+     */
+    private $baseReverse;
+
+    /**
+     * Template for new ones created by 'newLookup()' method.
+     * @var Lookup
+     */
+    private $baseLookup;
+
+    /**
+     * Constructor
+     * @param string      			$application_url Contain url of the current application
+     * @param Guzzle\Client|null 	$http_client     Client object from Guzzle
+     */
+    public function __construct(
+        $application_url,
+        Client $http_client = null
+    ) {
+
+        if (!isset($application_url))
+        {
+            throw new InvalidParameterException("Application url parameter is empty");
+        }
+
+        if (!isset($http_client))
+        {
+            $http_client = new Client([
+                'base_uri'			 => $application_url,
+                'timeout'			 => 30,
+                'connection_timeout' => 5,
+            ]);
+        } else if ($http_client instanceof Client)
+        {
+            $application_url_client = $http_client->getConfig('base_uri');
+
+            if (!isset($application_url_client))
+            {
+                $http_client->setDefaultOption('base_uri', $application_url);
+            } else if ($application_url_client != $application_url)
+            {
+                throw new InvalidParameterException("http_client parameter has a differente url to application_url parameter");
+            }
+        } else
+        {
+            throw new InvalidParameterException("http_client parameter must be a GuzzleHttp\Client object or empty");
+        }
+
+        $this->application_url = $application_url;
+        $this->http_client = $http_client;
+
+        //Create base
+        $this->baseSearch = new Search();
+        $this->baseReverse = new Reverse();
+        $this->baseLookup = new Lookup();
+
+    }
+
+    /**
+     * Returns a new search object based on the base search.
+     *
+     * @return Search
+     */
+    public function newSearch()
+    {
+        return clone $this->baseSearch;
+    }
+
+    /**
+     * Returns a new search object based on the base reverse.
+     *
+     * @return Reverse
+     */
+    public function newReverse()
+    {
+        return clone $this->baseReverse;
+    }
+
+    /**
+     * Returns a new search object based on the base lookup.
+     * 
+     * @return Lookup
+     */
+    public function newLookup()
+    {
+        return clone $this->baseLookup;
+    }
+
+    /**
+     * Decode the data returned from the request
+     * 
+     * @param  string   $format   json or xml
+     * @param  Request  $request  Request object from Guzzle
+     * @param  ResponseInterface $response Interface response object from Guzzle
+     * 
+     * @return array|\SimpleXMLElement
+     * @throws maxh\Nominatim\Exceptions\NominatimException if no format for decode
+     */
+    private function decodeResponse($format, Request $request, ResponseInterface $response)
+    {
+
+        if ($format == 'json')
+        {
+            return json_decode($response->getBody(), true);
+        }
+
+        if ($format == 'xml')
+        {
+            return new \SimpleXMLElement($response->getBody());
+        }
+
+        throw new NominatimException("Format is undefined or not supported for decode response", $request, $response);
+    }
+
+    /**
+     * Runs the query and returns the result set from Nominatim.
+     * @param  QueryInterface $nRequest  The object request to send
+     * 
+     * @return array                                        The decoded data returned from Nominatim
+     * @throws \GuzzleHttp\Exception\ClientException 		if http request is an error
+     */
+    public function find(QueryInterface $nRequest)
+    {
+        $url = $this->application_url . '/' . $nRequest->getPath() . '?';
+        $request = new Request('GET', $url);
+
+        //Convert the query array to string with space replace to +
+        $query = \GuzzleHttp\Psr7\build_query($nRequest->getQuery(), PHP_QUERY_RFC1738);
+
+        $url = $request->getUri()->withQuery($query);
+        $request = $request->withUri($url);
+
+        return $this->decodeResponse(
+            $nRequest->getFormat(),
+            $request,
+            $this->http_client->send($request)
+        );
+    }
+
+    /**
+     * Return the client using by instance
+     * @return GuzzleHttp\Client
+     */
+    public function getClient()
+    {
+        return $this->http_client;
+    }
 
 }

src/Search.php

Indentation +202 added lines, -202 removed lines

@@ -18,208 +18,208 @@
 class Search extends Query
 {
 
-	/**
-	 * Constuctor
-	 * @param array $query Default value for this query
-	 */
-	public function __construct(array $query = [])
-	{
-		parent::__construct();
-
-		$this->setPath('search');
-
-		$this->accepteFormat[] = 'html';
-		$this->accepteFormat[] = 'jsonv2';
-	}
-
-	// -- Builder methods ------------------------------------------------------
-
-	/**
-	 * Query string to search for.
-	 *
-	 * @param  string $query The query
-	 *
-	 * @return maxh\Nominatim\Search
-	 */
-	public function query($query)
-	{
-		$this->query['q'] = $query;
-
-		return $this;
-	}
-
-	/**
-	 * Street to search for.
-	 *
-	 * Do not combine with query().
-	 *
-	 * @param  string $street The street
-	 *
-	 * @return maxh\Nominatim\Search
-	 */
-	public function street($street)
-	{
-		$this->query['street'] = $street;
-
-		return $this;
-	}
-
-	/**
-	 * City to search for (experimental).
-	 *
-	 * Do not combine with query().
-	 * 
-	 * @param  string $city The city
-	 *
-	 * @return maxh\Nominatim\Search
-	 */
-	public function city($city)
-	{
-		$this->query['city'] = $city;
-
-		return $this;
-	}
-
-	/**
-	 * County to search for.
-	 *
-	 * Do not combine with query().
-	 * 
-	 * @param  string $county The county
-	 *
-	 * @return maxh\Nominatim\Search
-	 */
-	public function county($county)
-	{
-		$this->query['county'] = $county;
-
-		return $this;
-	}
-
-	/**
-	 * State to search for.
-	 *
-	 * Do not combine with query().
-	 *
-	 * @param  string $state The state
-	 *
-	 * @return maxh\Nominatim\Search
-	 */
-	public function state($state)
-	{
-		$this->query['state'] = $state;
-
-		return $this;
-	}
-
-	/**
-	 * Country to search for.
-	 *
-	 * Do not combine with query().
-	 *
-	 * @param  string $country The country
-	 *
-	 * @return maxh\Nominatim\Search
-	 */
-	public function country($country)
-	{
-		$this->query['country'] = $country;
-
-		return $this;
-	}
-
-	/**
-	 * Postal code to search for (experimental).
-	 *
-	 * Do not combine with query().
-	 *
-	 * @param  integer $postalCode The postal code
-	 *
-	 * @return maxh\Nominatim\Search
-	 */
-	public function postalCode($postalCode)
-	{
-		$this->query['postalcode'] = $postalCode;
-
-		return $this;
-	}
-
-	/**
-	 * Limit search results to a specific country (or a list of countries).
-	 *
-	 * <countrycode> should be the ISO 3166-1alpha2 code, e.g. gb for the United
-	 * Kingdom, de for Germany, etc.
-	 *
-	 * @param  string $countrycode The country code
-	 *
-	 * @return maxh\Nominatim\Search
-	 * @throws maxh\Nominatim\Exceptions\InvalidParameterException if country code is invalid
-	 */
-	public function countryCode($countrycode)
-	{
-		if (!preg_match('/^[a-z]{2}$/i', $countrycode)) {
-			throw new InvalidParameterException("Invalid country code: \"$countrycode\"");
-		}
-
-		if (!isset($this->query['countrycode'])) {
-			$this->query['countrycode'] = $countrycode;
-		} else {
-			$this->query['countrycode'] .= "," . $countrycode;
-		}
-
-		return $this;
-	}
-
-	/**
-	 * The preferred area to find search results
-	 * 
-	 * @param  string $left   Left of the area
-	 * @param  string $top	Top of the area
-	 * @param  string $right  Right of the area
-	 * @param  string $bottom Bottom of the area
-	 * 
-	 * @return maxh\Nominatim\Search
-	 */
-	public function viewBox($left, $top, $right, $bottom)
-	{
-		$this->query['viewbox'] = $left . ',' . $top . ',' . $right . ',' . $bottom;
-
-		return $this;
-	}
-
-	/**
-	 * If you do not want certain openstreetmap objects to appear in the search results.
-	 * 
-	 * @return maxh\Nominatim\Search
-	 * @throws maxh\Nominatim\Exceptions\InvalidParameterException  if no place id
-	 */
-	public function exludePlaceIds()
-	{
-		$args = func_get_args();
-
-		if (count($args) > 0)
-		{
-			$this->query['exclude_place_ids'] = implode(', ', $args);
-
-			return $this;
-		}
-
-		throw new InvalidParameterException("No place id in parameter");
-	}
-
-	/**
-	 * Limit the number of returned results
-	 * 
-	 * @param  integer $limit 
-	 * 
-	 * @return maxh\Nominatim\Search
-	 */
-	public function limit($limit)
-	{
-		$this->query['limit'] = strval($limit);
-
-		return $this;
-	}
+    /**
+     * Constuctor
+     * @param array $query Default value for this query
+     */
+    public function __construct(array $query = [])
+    {
+        parent::__construct();
+
+        $this->setPath('search');
+
+        $this->accepteFormat[] = 'html';
+        $this->accepteFormat[] = 'jsonv2';
+    }
+
+    // -- Builder methods ------------------------------------------------------
+
+    /**
+     * Query string to search for.
+     *
+     * @param  string $query The query
+     *
+     * @return maxh\Nominatim\Search
+     */
+    public function query($query)
+    {
+        $this->query['q'] = $query;
+
+        return $this;
+    }
+
+    /**
+     * Street to search for.
+     *
+     * Do not combine with query().
+     *
+     * @param  string $street The street
+     *
+     * @return maxh\Nominatim\Search
+     */
+    public function street($street)
+    {
+        $this->query['street'] = $street;
+
+        return $this;
+    }
+
+    /**
+     * City to search for (experimental).
+     *
+     * Do not combine with query().
+     * 
+     * @param  string $city The city
+     *
+     * @return maxh\Nominatim\Search
+     */
+    public function city($city)
+    {
+        $this->query['city'] = $city;
+
+        return $this;
+    }
+
+    /**
+     * County to search for.
+     *
+     * Do not combine with query().
+     * 
+     * @param  string $county The county
+     *
+     * @return maxh\Nominatim\Search
+     */
+    public function county($county)
+    {
+        $this->query['county'] = $county;
+
+        return $this;
+    }
+
+    /**
+     * State to search for.
+     *
+     * Do not combine with query().
+     *
+     * @param  string $state The state
+     *
+     * @return maxh\Nominatim\Search
+     */
+    public function state($state)
+    {
+        $this->query['state'] = $state;
+
+        return $this;
+    }
+
+    /**
+     * Country to search for.
+     *
+     * Do not combine with query().
+     *
+     * @param  string $country The country
+     *
+     * @return maxh\Nominatim\Search
+     */
+    public function country($country)
+    {
+        $this->query['country'] = $country;
+
+        return $this;
+    }
+
+    /**
+     * Postal code to search for (experimental).
+     *
+     * Do not combine with query().
+     *
+     * @param  integer $postalCode The postal code
+     *
+     * @return maxh\Nominatim\Search
+     */
+    public function postalCode($postalCode)
+    {
+        $this->query['postalcode'] = $postalCode;
+
+        return $this;
+    }
+
+    /**
+     * Limit search results to a specific country (or a list of countries).
+     *
+     * <countrycode> should be the ISO 3166-1alpha2 code, e.g. gb for the United
+     * Kingdom, de for Germany, etc.
+     *
+     * @param  string $countrycode The country code
+     *
+     * @return maxh\Nominatim\Search
+     * @throws maxh\Nominatim\Exceptions\InvalidParameterException if country code is invalid
+     */
+    public function countryCode($countrycode)
+    {
+        if (!preg_match('/^[a-z]{2}$/i', $countrycode)) {
+            throw new InvalidParameterException("Invalid country code: \"$countrycode\"");
+        }
+
+        if (!isset($this->query['countrycode'])) {
+            $this->query['countrycode'] = $countrycode;
+        } else {
+            $this->query['countrycode'] .= "," . $countrycode;
+        }
+
+        return $this;
+    }
+
+    /**
+     * The preferred area to find search results
+     * 
+     * @param  string $left   Left of the area
+     * @param  string $top	Top of the area
+     * @param  string $right  Right of the area
+     * @param  string $bottom Bottom of the area
+     * 
+     * @return maxh\Nominatim\Search
+     */
+    public function viewBox($left, $top, $right, $bottom)
+    {
+        $this->query['viewbox'] = $left . ',' . $top . ',' . $right . ',' . $bottom;
+
+        return $this;
+    }
+
+    /**
+     * If you do not want certain openstreetmap objects to appear in the search results.
+     * 
+     * @return maxh\Nominatim\Search
+     * @throws maxh\Nominatim\Exceptions\InvalidParameterException  if no place id
+     */
+    public function exludePlaceIds()
+    {
+        $args = func_get_args();
+
+        if (count($args) > 0)
+        {
+            $this->query['exclude_place_ids'] = implode(', ', $args);
+
+            return $this;
+        }
+
+        throw new InvalidParameterException("No place id in parameter");
+    }
+
+    /**
+     * Limit the number of returned results
+     * 
+     * @param  integer $limit 
+     * 
+     * @return maxh\Nominatim\Search
+     */
+    public function limit($limit)
+    {
+        $this->query['limit'] = strval($limit);
+
+        return $this;
+    }
 
 
 }

src/QueryInterface.php

Indentation +24 added lines, -24 removed lines

@@ -14,31 +14,31 @@
 interface QueryInterface
 {
 	
-	/**
-	 * Get path of the request
-	 *
-	 *  Example request :
-	 *  - Search = search
-	 *  - Reverse Geocoding = reverse
-	 *  
-	 * @return string
-	 */
-	public function getPath();
+    /**
+     * Get path of the request
+     *
+     *  Example request :
+     *  - Search = search
+     *  - Reverse Geocoding = reverse
+     *  
+     * @return string
+     */
+    public function getPath();
 
-	/**
-	 * Get the query to send
-	 * 
-	 * @return array
-	 */
-	public function getQuery();
+    /**
+     * Get the query to send
+     * 
+     * @return array
+     */
+    public function getQuery();
 
-	/**
-	 * Get the format of the request
-	 *
-	 * Example : json or xml
-	 * 
-	 * @return string
-	 */
-	public function getFormat();
+    /**
+     * Get the format of the request
+     *
+     * Example : json or xml
+     * 
+     * @return string
+     */
+    public function getFormat();
 
 }

src/Exceptions/NominatimException.php

Indentation +45 added lines, -45 removed lines

@@ -23,56 +23,56 @@
 class NominatimException extends Exception
 {
 
-	/**
-	 * Contain the request
-	 * @var RequestInterface
-	 */
-	private $request;
+    /**
+     * Contain the request
+     * @var RequestInterface
+     */
+    private $request;
 
-	/**
-	 * Contain the response
-	 * @var ResponseInterface
-	 */
-	private $response;
+    /**
+     * Contain the response
+     * @var ResponseInterface
+     */
+    private $response;
 	
-	/**
-	 * Constructor
-	 * @param string                 $message  Message of this exception
-	 * @param RequestInterface       $request  The request instance
-	 * @param ResponseInterface|null $response The response of the request
-	 * @param Exception|null        $previous Exception object
-	 */
-	public function __construct(
-		$message,
-		RequestInterface $request,
-		ResponseInterface $response = null,
-		Exception $previous = null
-	) {
-		// Set the code of the exception if the response is set and not future.
-		$code = $response && !($response instanceof PromiseInterface) ? $response->getStatusCode() : 0;
+    /**
+     * Constructor
+     * @param string                 $message  Message of this exception
+     * @param RequestInterface       $request  The request instance
+     * @param ResponseInterface|null $response The response of the request
+     * @param Exception|null        $previous Exception object
+     */
+    public function __construct(
+        $message,
+        RequestInterface $request,
+        ResponseInterface $response = null,
+        Exception $previous = null
+    ) {
+        // Set the code of the exception if the response is set and not future.
+        $code = $response && !($response instanceof PromiseInterface) ? $response->getStatusCode() : 0;
 
-		parent::__construct($message, $code, $previous);
+        parent::__construct($message, $code, $previous);
 
-		$this->request = $request;
-		$this->response = $response;
+        $this->request = $request;
+        $this->response = $response;
 
-	}
+    }
 
-	/**
-	 * Return the Request
-	 * @return GuzzleHttp\Psr7\Request
-	 */
-	public function getRequest()
-	{
-		return $this->request;
-	}
+    /**
+     * Return the Request
+     * @return GuzzleHttp\Psr7\Request
+     */
+    public function getRequest()
+    {
+        return $this->request;
+    }
 
-	/**
-	 * Return the Response
-	 * @return GuzzleHttp\Psr7\Response [description]
-	 */
-	public function getResponse()
-	{
-		return $this->response;
-	}
+    /**
+     * Return the Response
+     * @return GuzzleHttp\Psr7\Response [description]
+     */
+    public function getResponse()
+    {
+        return $this->response;
+    }
 }

src/Reverse.php

Indentation +85 added lines, -85 removed lines

@@ -18,91 +18,91 @@
 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;
-	}
+    /**
+     * 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;
+    }
 
 
 }

src/Lookup.php

Indentation +38 added lines, -38 removed lines

@@ -18,44 +18,44 @@
 class Lookup extends Query
 {
 
-	/**
-	 * Constuctor
-	 * @param array $query Default value for this query
-	 */
-	public function __construct(array $query = [])
-	{
-		parent::__construct();
-
-		$this->setPath('lookup');
-	}
-
-	// -- Builder methods ------------------------------------------------------
-
-	/**
-	 * A list of up to 50 specific osm node, way or relations ids to return the addresses for
-	 * 
-	 * @param  string $id
-	 * 
-	 * @return maxh\Nominatim\Lookup
-	 */
-	public function osmIds($id)
-	{
-		$this->query['osm_ids'] = $id;
-
-		return $this;
-	}
-
-	/**
-	 * Output format for the geometry of results
-	 * 
-	 * @param  string $polygon
-	 * 
-	 * @throws maxh\Nominatim\Exceptions\InvalidParameterException  Polygon is not supported with lookup
-	 */
-	public function polygon($polygon)
-	{
-		throw new InvalidParameterException("The polygon is not supported with lookup");
-	}
+    /**
+     * Constuctor
+     * @param array $query Default value for this query
+     */
+    public function __construct(array $query = [])
+    {
+        parent::__construct();
+
+        $this->setPath('lookup');
+    }
+
+    // -- Builder methods ------------------------------------------------------
+
+    /**
+     * A list of up to 50 specific osm node, way or relations ids to return the addresses for
+     * 
+     * @param  string $id
+     * 
+     * @return maxh\Nominatim\Lookup
+     */
+    public function osmIds($id)
+    {
+        $this->query['osm_ids'] = $id;
+
+        return $this;
+    }
+
+    /**
+     * Output format for the geometry of results
+     * 
+     * @param  string $polygon
+     * 
+     * @throws maxh\Nominatim\Exceptions\InvalidParameterException  Polygon is not supported with lookup
+     */
+    public function polygon($polygon)
+    {
+        throw new InvalidParameterException("The polygon is not supported with lookup");
+    }
 
 
 }