cmfcmf / OpenWeatherMap-PHP-API

Examples/Cache.php

Doc Comments +3 added lines

@@ -34,6 +34,9 @@
         $this->tmp = sys_get_temp_dir();
     }
 
+    /**
+     * @param string $url
+     */
     private function urlToPath($url)
     {
         $dir = $this->tmp . DIRECTORY_SEPARATOR . "OpenWeatherMapPHPAPI";

Cmfcmf/OpenWeatherMap.php

Doc Comments +10 added lines, -10 removed lines

@@ -197,7 +197,7 @@ 
     /**
      * Returns the current weather for a group of city ids.
      *
-     * @param array  $ids   The city ids to get weather information for
+     * @param string[]  $ids   The city ids to get weather information for
      * @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.
@@ -221,7 +221,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.
@@ -252,7 +252,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.
@@ -279,7 +279,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'.
@@ -314,7 +314,7 @@ 
      *
      * @param float              $lat           The location's latitude.
      * @param float              $lon           The location's longitude.
-     * @param \DateTimeInterface $dateTime      The date and time to request data for.
+     * @param \DateTime $dateTime      The date and time to request data for.
      * @param string             $timePrecision This decides about the timespan OWM will look for the uv index. The tighter
      *                                          the timespan, the less likely it is to get a result. Can be 'year', 'month',
      *                                          'day', 'hour', 'minute' or 'second', defaults to 'day'.
@@ -431,7 +431,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",
@@ -546,10 +546,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.