cmfcmf / OpenWeatherMap-PHP-API

Cmfcmf/OpenWeatherMap.php

Doc Comments +8 added lines, -8 removed lines

@@ -224,7 +224,7 @@ 
      * Returns the forecast for the place you specified. DANGER: Might return
      * fewer results than requested due to a bug in the OpenWeatherMap API!
      *
-     * @param array|int|string $query The place to get weather information for. For possible values see ::getWeather.
+     * @param string $query The place to get weather information for. For possible values see ::getWeather.
      * @param string           $units Can be either 'metric' or 'imperial' (default). This affects almost all units returned.
      * @param string           $lang  The language to use for descriptions, default is 'en'. For possible values see http://openweathermap.org/current#multi.
      * @param string           $appid Your app id, default ''. See http://openweathermap.org/appid for more details.
@@ -255,7 +255,7 @@ 
      * Returns the DAILY forecast for the place you specified. DANGER: Might return
      * fewer results than requested due to a bug in the OpenWeatherMap API!
      *
-     * @param array|int|string $query The place to get weather information for. For possible values see ::getWeather.
+     * @param string $query The place to get weather information for. For possible values see ::getWeather.
      * @param string           $units Can be either 'metric' or 'imperial' (default). This affects almost all units returned.
      * @param string           $lang  The language to use for descriptions, default is 'en'. For possible values see http://openweathermap.org/current#multi.
      * @param string           $appid Your app id, default ''. See http://openweathermap.org/appid for more details.
@@ -282,7 +282,7 @@ 
     /**
      * Returns the weather history for the place you specified.
      *
-     * @param array|int|string $query      The place to get weather information for. For possible values see ::getWeather.
+     * @param string $query      The place to get weather information for. For possible values see ::getWeather.
      * @param \DateTime        $start
      * @param int              $endOrCount
      * @param string           $type       Can either be 'tick', 'hour' or 'day'.
@@ -484,7 +484,7 @@ 
      *
      * @param array|int|string $query      The place to get weather information for. For possible values see ::getWeather.
      * @param \DateTime        $start      The \DateTime object of the date to get the first weather information from.
-     * @param \DateTime|int    $endOrCount Can be either a \DateTime object representing the end of the period to
+     * @param integer    $endOrCount Can be either a \DateTime object representing the end of the period to
      *                                     receive weather history data for or an integer counting the number of
      *                                     reports requested.
      * @param string           $type       The period of the weather history requested. Can be either be either "tick",
@@ -605,10 +605,10 @@ 
      * Build the url to fetch weather data from.
      *
      * @param        $query
-     * @param        $units
-     * @param        $lang
-     * @param        $appid
-     * @param        $mode
+     * @param        string $units
+     * @param        string $lang
+     * @param        string $appid
+     * @param        string $mode
      * @param string $url   The url to prepend.
      *
      * @return bool|string The fetched url, false on failure.

tests/TestHttpClient.php

Doc Comments +12 added lines

@@ -59,11 +59,17 @@ 
         return $response->withBody(Psr7\stream_for($content));
     }
 
+    /**
+     * @param integer $code
+     */
     public function returnErrorForNextRequest($code)
     {
         $this->errorWithStatusCode = $code;
     }
 
+    /**
+     * @param string $format
+     */
     private function currentWeather($format)
     {
         if ($format == 'xml') {
@@ -71,6 +77,9 @@ 
         }
     }
 
+    /**
+     * @param string $format
+     */
     private function forecast($format)
     {
         if ($format == 'xml') {
@@ -78,6 +87,9 @@ 
         }
     }
 
+    /**
+     * @param string $format
+     */
     private function group($format)
     {
         if ($format == 'json') {