Query::email() - Code Metrics - Inspection of "First test with heritage" - maxhelias/php-nominatim - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — heritage_class (c7b9cc)

by Maxime

created 2017-01-06 20:17 UTC

Query::email() A

↳ Parent: Query

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	1

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

namespace maxh\Nominatim;

/**
 * Class implementing functionality common to requests nominatim.
 */
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 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->query['format'] = $format;
			$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;
	}

	/**
	 * 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;
	}

	/**
	 * 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;
	}

	/**
	 * 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 = $format;
	}

}


1			<?php
2			/**
3			* Class Query
4			*
5			* @package maxh\nominatim
6			* @author Maxime Hélias <[email protected]>
7			*/
8
9			namespace maxh\Nominatim;
10
11			/**
12			* Class implementing functionality common to requests nominatim.
13			*/
14			class Query implements QueryInterface
15			{
16			/**
17			* Contain the path of the request
18			* @var string
19			*/
20			protected $path;
21
22			/**
23			* Contain the query for request
24			* @var array
25			*/
26			protected $query = [];
27
28			/**
29			* Contain the format for decode data returning by the request
30			* @var string
31			*/
32			protected $format;
33
34			/**
35			* Output polygon format accepted
36			* @var array
37			*/
38			protected $polygon = ['geojson', 'kml', 'svg', 'text'];
39
40
41			/**
42			* Constuctor
43			* @param array $query Default value for this query
44			*/
45			public function __construct(array $query = [])
46			{
47			if(!isset($query['format']))
48			{
49			//Default format
50			$query['format'] = 'json';
51			}
52
53			$this->setQuery($query);
54			$this->setFormat($query['format']);
55
56			}
57
58			// -- Builder methods ------------------------------------------------------
59
60			/**
61			* Format returning by the request.
62			*
63			* @param string $format The output format for the request
64			*
65			* @return maxh\Nominatim\Query
66			* @throws maxh\Nominatim\Exceptions\InvalidParameterException if format is not supported
67			*/
68			public function format($format)
69			{
70			$format = strtolower($format);
71
72			if(in_array($format, $this->accepteFormat))
			0 ignored issues – show Bug introduced 2017-01-06 20:19 UTC by Report Bug Copy Issue Report The property `accepteFormat` does not seem to exist. Did you mean `format`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
73			{
74			$this->query['format'] = $format;
75			$this->setFormat($format);
76
77			return $this;
78			}
79
80			throw new InvalidParameterException("Format is not supported");
81			}
82
83			/**
84			* Preferred language order for showing search results, overrides the value
85			* specified in the "Accept-Language" HTTP header. Either uses standard
86			* rfc2616 accept-language string or a simple comma separated list of
87			* language codes.
88			*
89			* @param string $language Preferred language order for showing search results, overrides the value specified in the "Accept-Language" HTTP header.
90			* Either uses standard rfc2616 accept-language string or a simple comma separated list of language codes.
91			*
92			* @return maxh\Nominatim\Query
93			*/
94			public function language($language)
95			{
96			$this->query['accept-language'] = $language;
97
98			return $this;
99			}
100
101			/**
102			* Include a breakdown of the address into elements.
103			*
104			* @param boolean $details
105			*
106			* @return maxh\Nominatim\Query
107			*/
108			public function addressDetails($details = true)
109			{
110			$this->query['addressdetails'] = $details ? "1" : "0";
111
112			return $this;
113			}
114
115			/**
116			* Include additional information in the result if available
117			*
118			* @param boolean $tags
119			*
120			* @return maxh\Nominatim\Query
121			*/
122			public function extraTags($tags = true)
123			{
124			$this->query['extratags'] = $tags ? "1" : "0";
125
126			return $this;
127			}
128
129			/**
130			* Include a list of alternative names in the results.
131			* These may include language variants, references, operator and brand.
132			*
133			* @param boolean $details
134			*
135			* @return maxh\Nominatim\Query
136			*/
137			public function nameDetails($details = true)
138			{
139			$this->query['namedetails'] = $details ? "1" : "0";
140
141			return $this;
142			}
143
144			/**
145			* 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.
146			* This information will be kept confidential and only used to contact you in the event of a problem, see Usage Policy for more details.
147			*
148			* @param string $email Address mail
149			*
150			* @return maxh\Nominatim\Query
151			*/
152			public function email($email)
153			{
154			$this->query['email'] = $email;
155
156			return $this;
157			}
158
159			/**
160			* Returns the URL-encoded query.
161			*
162			* @return string
163			*/
164			public function getQueryString()
165			{
166			return http_build_query($this->query);
167			}
168
169			// -- Getters & Setters ----------------------------------------------------
170
171			/**
172			* Get path
173			* @return string
174			*/
175			public function getPath()
176			{
177			return $this->path;
178			}
179
180			/**
181			* Get query
182			* @return array
183			*/
184			public function getQuery()
185			{
186			return $this->query;
187			}
188
189			/**
190			* Get format
191			* @return string
192			*/
193			public function getFormat()
194			{
195			return $this->format;
196			}
197
198			/**
199			* Set path
200			* @param string $path Name's path of the service
201			*/
202			protected function setPath($path)
203			{
204			$this->path = $path;
205			}
206
207			/**
208			* Set query
209			* @param array $query Parameter of the query
210			*/
211			protected function setQuery($query = array())
212			{
213			$this->query = $query;
214			}
215
216			/**
217			* Set format
218			* @param string $format Format returning by the response
219			*/
220			protected function setFormat($format)
221			{
222			$this->format = $format;
223			}
224
225			}
226

maxhelias / php-nominatim

Branch — heritage_class (c7b9cc)

Query::email() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like