@@ -77,12 +77,12 @@ class OpenWeatherMap
7777 /**
7878 * Constructs the OpenWeatherMap object.
7979 *
80- * @param null|FetcherInterface $fetcher The interface to fetch the data from OpenWeatherMap. Defaults to
81- * CurlFetcher() if cURL is available. Otherwise defaults to
82- * FileGetContentsFetcher() using 'file_get_contents()'.
80+ * @param null|FetcherInterface $fetcher The interface to fetch the data from OpenWeatherMap. Defaults to
81+ * CurlFetcher() if cURL is available. Otherwise defaults to
82+ * FileGetContentsFetcher() using 'file_get_contents()'.
8383 * @param bool|string $cacheClass If set to false, caching is disabled. Otherwise this must be a class
84- * extending AbstractCache. Defaults to false.
85- * @param int $seconds How long weather data shall be cached. Default 10 minutes.
84+ * extending AbstractCache. Defaults to false.
85+ * @param int $seconds How long weather data shall be cached. Default 10 minutes.
8686 *
8787 * @throws \Exception If $cache is neither false nor a valid callable extending Cmfcmf\OpenWeatherMap\Util\Cache.
8888 * @api
@@ -112,7 +112,7 @@ public function __construct($fetcher = null, $cacheClass = false, $seconds = 600
112112 *
113113 * @param array|int|string $query The place to get weather information for. For possible values see below.
114114 * @param string $units Can be either 'metric' or 'imperial' (default). This affects almost all units returned.
115- * @param string $lang The language to use for descriptions, default is 'en'. For possible values see below.
115+ * @param string $lang The language to use for descriptions, default is 'en'. For possible values see below.
116116 * @param string $appid Your app id, default ''. See http://openweathermap.org/appid for more details.
117117 *
118118 * @throws OpenWeatherMap\Exception If OpenWeatherMap returns an error.
@@ -175,9 +175,9 @@ public function getWeather($query, $units = 'imperial', $lang = 'en', $appid = '
175175 *
176176 * @param array|int|string $query The place to get weather information for. For possible values see below.
177177 * @param string $units Can be either 'metric' or 'imperial' (default). This affects almost all units returned.
178- * @param string $lang The language to use for descriptions, default is 'en'. For possible values see below.
178+ * @param string $lang The language to use for descriptions, default is 'en'. For possible values see below.
179179 * @param string $appid Your app id, default ''. See http://openweathermap.org/appid for more details.
180- * @param int $days For how much days you want to get a forecast. Default 1, maximum: 14.
180+ * @param int $days For how much days you want to get a forecast. Default 1, maximum: 14.
181181 *
182182 * @throws OpenWeatherMap\Exception If OpenWeatherMap returns an error.
183183 * @throws \InvalidArgumentException If an argument error occurs.
@@ -248,7 +248,7 @@ public function getWeatherForecast($query, $units = 'imperial', $lang = 'en', $a
248248 * @param int $endOrCount
249249 * @param string $type
250250 * @param string $units Can be either 'metric' or 'imperial' (default). This affects almost all units returned.
251- * @param string $lang The language to use for descriptions, default is 'en'. For possible values see below.
251+ * @param string $lang The language to use for descriptions, default is 'en'. For possible values see below.
252252 * @param string $appid Your app id, default ''. See http://openweathermap.org/appid for more details.
253253 *
254254 * @throws OpenWeatherMap\Exception If OpenWeatherMap returns an error.
@@ -310,9 +310,9 @@ public function getRawData($query, $units = 'imperial', $lang = 'en', $appid = '
310310 *
311311 * @param array|int|string $query The place to get weather information for. For possible values see below.
312312 * @param string $units Can be either 'metric' or 'imperial' (default). This affects almost all units returned.
313- * @param string $lang The language to use for descriptions, default is 'en'. For possible values see below.
313+ * @param string $lang The language to use for descriptions, default is 'en'. For possible values see below.
314314 * @param string $appid Your app id, default ''. See http://openweathermap.org/appid for more details.
315- * @param string $mode The format of the data fetched. Possible values are 'json', 'html' and 'xml' (default).
315+ * @param string $mode The format of the data fetched. Possible values are 'json', 'html' and 'xml' (default).
316316 *
317317 * @return string Returns false on failure and the fetched data in the format you specified on success.
318318 *
@@ -356,9 +356,9 @@ public function getRawWeatherData($query, $units = 'imperial', $lang = 'en', $ap
356356 *
357357 * @param array|int|string $query The place to get weather information for. For possible values see below.
358358 * @param string $units Can be either 'metric' or 'imperial' (default). This affects almost all units returned.
359- * @param string $lang The language to use for descriptions, default is 'en'. For possible values see below.
359+ * @param string $lang The language to use for descriptions, default is 'en'. For possible values see below.
360360 * @param string $appid Your app id, default ''. See http://openweathermap.org/appid for more details.
361- * @param string $mode The format of the data fetched. Possible values are 'json', 'html' and 'xml' (default).
361+ * @param string $mode The format of the data fetched. Possible values are 'json', 'html' and 'xml' (default).
362362 *
363363 * @return string Returns false on failure and the fetched data in the format you specified on success.
364364 *
@@ -402,10 +402,10 @@ public function getRawHourlyForecastData($query, $units = 'imperial', $lang = 'e
402402 *
403403 * @param array|int|string $query The place to get weather information for. For possible values see below.
404404 * @param string $units Can be either 'metric' or 'imperial' (default). This affects almost all units returned.
405- * @param string $lang The language to use for descriptions, default is 'en'. For possible values see below.
405+ * @param string $lang The language to use for descriptions, default is 'en'. For possible values see below.
406406 * @param string $appid Your app id, default ''. See http://openweathermap.org/appid for more details.
407- * @param string $mode The format of the data fetched. Possible values are 'json', 'html' and 'xml' (default)
408- * @param int $cnt How many days of forecast shall be returned? Maximum (and default): 14
407+ * @param string $mode The format of the data fetched. Possible values are 'json', 'html' and 'xml' (default)
408+ * @param int $cnt How many days of forecast shall be returned? Maximum (and default): 14
409409 *
410410 * @throws \InvalidArgumentException If $cnt is higher than 14.
411411 * @return string Returns false on failure and the fetched data in the format you specified on success.
@@ -451,16 +451,16 @@ public function getRawDailyForecastData($query, $units = 'imperial', $lang = 'en
451451 /**
452452 * Directly returns the xml/json/html string returned by OpenWeatherMap for the daily forecast.
453453 *
454- * @param array|int|string $query The place to get weather information for. For possible values see below.
455- * @param \DateTime $start The \DateTime object of the date to get the first weather information from.
456- * @param \DateTime|int $endOrCount Can be either a \DateTime object representing the end of the period to
457- * receive weather history data for or an integer counting the number of
454+ * @param array|int|string $query The place to get weather information for. For possible values see below.
455+ * @param \DateTime $start The \DateTime object of the date to get the first weather information from.
456+ * @param \DateTime|int $endOrCount Can be either a \DateTime object representing the end of the period to
457+ * receive weather history data for or an integer counting the number of
458458 * reports requested.
459- * @param string $type The period of the weather history requested. Can be either be either "tick",
460- * "hour" or "day".
461- * @param string $units Can be either 'metric' or 'imperial' (default). This affects almost all units returned.
462- * @param string $lang The language to use for descriptions, default is 'en'. For possible values see below.
463- * @param string $appid Your app id, default ''. See http://openweathermap.org/appid for more details.
459+ * @param string $type The period of the weather history requested. Can be either be either "tick",
460+ * "hour" or "day".
461+ * @param string $units Can be either 'metric' or 'imperial' (default). This affects almost all units returned.
462+ * @param string $lang The language to use for descriptions, default is 'en'. For possible values see below.
463+ * @param string $appid Your app id, default ''. See http://openweathermap.org/appid for more details.
464464 *
465465 * @throws \InvalidArgumentException
466466 *
0 commit comments