Search::polygon() - Code Metrics - Inspection of "Merge pull request #3 from maxhelias/heritage_clas..." - maxhelias/php-nominatim - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 211857...11662a )

by Maxime

created 2017-01-06 21:45 UTC

Search::polygon() A

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	5

Duplication

Lines	11
Ratio	100 %

Importance

Changes

Metric	Value
dl	11
loc	11
c	0
b	0
f	0
rs	9.4285
cc	2
eloc	5
nc	2
nop	1

<?php
/**
 * Class Search
 *
 * @package      maxh\nominatim
 * @author       Maxime Hélias <[email protected]>
 */

namespace maxh\Nominatim;

use maxh\Nominatim\Exceptions\InvalidParameterException;

/**
 * Searches a OSM nominatim service for places.
 *
 * @see http://wiki.openstreetmap.org/wiki/Nominatim
 */
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;
	}


}


1			<?php
2			/**
3			* Class Search
4			*
5			* @package maxh\nominatim
6			* @author Maxime Hélias <[email protected]>
7			*/
8
9			namespace maxh\Nominatim;
10
11			use maxh\Nominatim\Exceptions\InvalidParameterException;
12
13			/**
14			* Searches a OSM nominatim service for places.
15			*
16			* @see http://wiki.openstreetmap.org/wiki/Nominatim
17			*/
18			class Search extends Query
19			{
20
21			/**
22			* Constuctor
23			* @param array $query Default value for this query
24			*/
25			public function __construct(array $query = [])
26			{
27			parent::__construct();
28
29			$this->setPath('search');
30
31			$this->accepteFormat[] = 'html';
32			$this->accepteFormat[] = 'jsonv2';
33			}
34
35			// -- Builder methods ------------------------------------------------------
36
37			/**
38			* Query string to search for.
39			*
40			* @param string $query The query
41			*
42			* @return maxh\Nominatim\Search
43			*/
44			public function query($query)
45			{
46			$this->query['q'] = $query;
47
48			return $this;
49			}
50
51			/**
52			* Street to search for.
53			*
54			* Do not combine with query().
55			*
56			* @param string $street The street
57			*
58			* @return maxh\Nominatim\Search
59			*/
60			public function street($street)
61			{
62			$this->query['street'] = $street;
63
64			return $this;
65			}
66
67			/**
68			* City to search for (experimental).
69			*
70			* Do not combine with query().
71			*
72			* @param string $city The city
73			*
74			* @return maxh\Nominatim\Search
75			*/
76			public function city($city)
77			{
78			$this->query['city'] = $city;
79
80			return $this;
81			}
82
83			/**
84			* County to search for.
85			*
86			* Do not combine with query().
87			*
88			* @param string $county The county
89			*
90			* @return maxh\Nominatim\Search
91			*/
92			public function county($county)
93			{
94			$this->query['county'] = $county;
95
96			return $this;
97			}
98
99			/**
100			* State to search for.
101			*
102			* Do not combine with query().
103			*
104			* @param string $state The state
105			*
106			* @return maxh\Nominatim\Search
107			*/
108			public function state($state)
109			{
110			$this->query['state'] = $state;
111
112			return $this;
113			}
114
115			/**
116			* Country to search for.
117			*
118			* Do not combine with query().
119			*
120			* @param string $country The country
121			*
122			* @return maxh\Nominatim\Search
123			*/
124			public function country($country)
125			{
126			$this->query['country'] = $country;
127
128			return $this;
129			}
130
131			/**
132			* Postal code to search for (experimental).
133			*
134			* Do not combine with query().
135			*
136			* @param integer $postalCode The postal code
137			*
138			* @return maxh\Nominatim\Search
139			*/
140			public function postalCode($postalCode)
141			{
142			$this->query['postalcode'] = $postalCode;
143
144			return $this;
145			}
146
147			/**
148			* Limit search results to a specific country (or a list of countries).
149			*
150			* <countrycode> should be the ISO 3166-1alpha2 code, e.g. gb for the United
151			* Kingdom, de for Germany, etc.
152			*
153			* @param string $countrycode The country code
154			*
155			* @return maxh\Nominatim\Search
156			* @throws maxh\Nominatim\Exceptions\InvalidParameterException if country code is invalid
157			*/
158			public function countryCode($countrycode)
159			{
160			if (!preg_match('/^[a-z]{2}$/i', $countrycode)) {
161			throw new InvalidParameterException("Invalid country code: \"$countrycode\"");
162			}
163
164			if (!isset($this->query['countrycode'])) {
165			$this->query['countrycode'] = $countrycode;
166			} else {
167			$this->query['countrycode'] .= "," . $countrycode;
168			}
169
170			return $this;
171			}
172
173			/**
174			* The preferred area to find search results
175			*
176			* @param string $left Left of the area
177			* @param string $top Top of the area
178			* @param string $right Right of the area
179			* @param string $bottom Bottom of the area
180			*
181			* @return maxh\Nominatim\Search
182			*/
183			public function viewBox($left, $top, $right, $bottom)
184			{
185			$this->query['viewbox'] = $left . ',' . $top . ',' . $right . ',' . $bottom;
186
187			return $this;
188			}
189
190			/**
191			* If you do not want certain openstreetmap objects to appear in the search results.
192			*
193			* @return maxh\Nominatim\Search
194			* @throws maxh\Nominatim\Exceptions\InvalidParameterException if no place id
195			*/
196			public function exludePlaceIds()
197			{
198			$args = func_get_args();
199
200			if (count($args) > 0)
201			{
202			$this->query['exclude_place_ids'] = implode(', ', $args);
203
204			return $this;
205			}
206
207			throw new InvalidParameterException("No place id in parameter");
208			}
209
210			/**
211			* Limit the number of returned results
212			*
213			* @param integer $limit
214			*
215			* @return maxh\Nominatim\Search
216			*/
217			public function limit($limit)
218			{
219			$this->query['limit'] = strval($limit);
220
221			return $this;
222			}
223
224
225			}
226

maxhelias / php-nominatim

Push — master ( 211857...11662a )

Search::polygon() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like