Merge pull request #1 from nateritter/weather-history

Weather history (nateritter)

Author: gitllermopalafox

.gitignore

@@ -0,0 +1,2 @@
+composer.lock
+vendor/

README.md

@@ -77,6 +77,30 @@ public function bar()
 Visit [https://github.com/cmfcmf/OpenWeatherMap-PHP-Api/blob/master/Examples/WeatherForecast.php](https://github.com/cmfcmf/OpenWeatherMap-PHP-Api/blob/master/Examples/WeatherForecast.php) for more info.
 
 
+#### History
+
+```
+...
+use Gmopx\LaravelOWM\LaravelOWM;
+...
+
+public function bar()
+{
+    $lowm = new LaravelOWM();
+
+    // Get yesterday's date
+    $date = new \DateTime();
+    $date->add(\DateInterval::createFromDateString('yesterday'));
+
+    $history = $lowm->getWeatherHistory('london', $date);
+
+    dd($history);
+}
+
+```
+
+Visit [https://github.com/cmfcmf/OpenWeatherMap-PHP-Api/blob/master/Examples/WeatherForecast.php](https://github.com/cmfcmf/OpenWeatherMap-PHP-Api/blob/master/Examples/WeatherForecast.php) for more info.
+
 ##### Parameters:
 
 Note:
@@ -130,6 +154,30 @@ There are three ways to specify the place to get weather information for:
 
 ```
 
+##### getWeatherHistory:
+```
+    /**
+     * Get the forecast of the requested location/city.
+     *
+     * More info about how to interact with the results:
+     *
+     * https://github.com/cmfcmf/OpenWeatherMap-PHP-Api/blob/master/Examples/WeatherHistory.php
+     *
+     * @param $query            (required)
+     * @param \DateTime $start  (default: today)
+     * @param int $endOrCount   (default: 1)
+     * @param string $type      (default: hour) - 'tick', 'hour', or 'day'
+     * @param string $lang      (default: en) - http://openweathermap.org/current#multi.
+     * @param string $units     (default: metric) - 'metric' or 'imperial'.
+     * @param bool $cache       (default: false)
+     * @param int $time         (default: 600)
+     * @return OpenWeatherMap\WeatherForecast
+     */
+    public function getWeatherHistory($query, \DateTime $start, $endOrCount = 1, $type = 'hour', $lang = 'en', $units = 'metric', $cache = false, $time = 600)
+    ...
+
+```
+
 
 ### Routes
 

src/Http/routes.php

@@ -1,8 +1,8 @@
 <?php
 
-    Route::group(['prefix' => 'owmapi', 'namespace' => 'Gmopx\LaravelOWM\Http\Controllers'], function() {
+Route::group(['prefix' => 'owmapi', 'namespace' => 'Gmopx\LaravelOWM\Http\Controllers'], function() {
 
-        Route::get('current-weather', ['uses' => 'LaravelOWMController@currentweather']);
-        Route::get('forecast', ['uses' => 'LaravelOWMController@forecast']);
+    Route::get('current-weather', ['uses' => 'LaravelOWMController@currentweather']);
+    Route::get('forecast', ['uses' => 'LaravelOWMController@forecast']);
 
-    });
+});

src/LaravelOWM.php

@@ -1,4 +1,5 @@
-<?php namespace Gmopx\LaravelOWM;
+<?php
+namespace Gmopx\LaravelOWM;
 
 use Cmfcmf\OpenWeatherMap;
 
@@ -18,11 +19,11 @@ public function __construct()
     {
         $this->config = config('laravel-owm');
 
-        if($this->config === null){
+        if ($this->config === null) {
             throw new \Exception('config/laravel-owm.php not found');
         }
 
-        if($this->config['api_key'] === null){
+        if ($this->config['api_key'] === null) {
             throw new \Exception('laravel-owm.api_key not found');
         }
 
@@ -53,7 +54,7 @@ public function getCurrentWeather($query, $lang = 'en', $units = 'metric', $cach
         $lang = $lang ?: 'en';
         $units = $units ?: 'metric';
 
-        if($cache){
+        if ($cache) {
             $owm = new OpenWeatherMap($this->api_key, null, new Cache(), $time);
             return $owm->getWeather($query, $units, $lang);
         }
@@ -88,13 +89,51 @@ public function getWeatherForecast($query, $lang = 'en', $units = 'metric', $day
         $units = $units ?: 'metric';
         $days = $days ?: 6;
 
-        if($cache){
+        if ($cache) {
             $owm = new OpenWeatherMap($this->api_key, null, new Cache(), $time);
             return $owm->getWeatherForecast($query, $units, $lang, '', $days);
         }
 
         $owm = new OpenWeatherMap($this->api_key);
         return $owm->getWeatherForecast($query, $units, $lang, '', $days);
     }
-    
-}
+
+    /**
+     * Returns the weather history for the place you specified.
+     *
+     * More info about how to interact with the results:
+     *
+     * https://github.com/cmfcmf/OpenWeatherMap-PHP-Api/blob/master/Examples/WeatherHistory.php
+     *
+     * There are three ways to specify the place to get weather information for:
+     *  - Use the city name: $query must be a string containing the city name.
+     *  - Use the city id: $query must be an integer containing the city id.
+     *  - Use the coordinates: $query must be an associative array containing the 'lat' and 'lon' values.
+     *
+     * @param array|int|string $query
+     * @param \DateTime $start
+     * @param int $endOrCount
+     * @param string $type
+     * @param string $lang
+     * @param string $units
+     * @param bool $cache
+     * @param int $time
+     * @return OpenWeatherMap\WeatherHistory
+     */
+    public function getWeatherHistory($query, \DateTime $start, $endOrCount = 1, $type = 'hour', $lang = 'en', $units = 'metric', $cache = false, $time = 600)
+    {
+        $lang = $lang ?: 'en';
+        $units = $units ?: 'metric';
+        $start = $start ?: new \DateTime;
+        $endOrCount = $endOrCount ?: 1;
+        $type = $type ?: 'hour';
+
+        if ($cache) {
+            $owm = new OpenWeatherMap($this->api_key, null, new Cache(), $time);
+            return $owm->getWeatherHistory($query, $start, $endOrCount, $type, $units, $lang, '');
+        }
+
+        $owm = new OpenWeatherMap($this->api_key);
+        return $owm->getWeatherHistory($query, $start, $endOrCount, $type, $units, $lang, '');
+    }
+}

src/LaravelOWMServiceProvider.php

@@ -16,9 +16,11 @@ public function boot()
 
 		// Loading routes file
 		if ($config !== null) {
-			if($config['routes_enabled']){
+
+			if ($config['routes_enabled']) {
 				require __DIR__ . '/Http/routes.php';
 			}
+
 		} else {
 			require __DIR__ . '/Http/routes.php';
 		}

src/config/laravel-owm.php

@@ -1,7 +1,6 @@
 <?php
 
-    return [
-        'api_key' => '',            // visit: http://openweathermap.org/appid#get for more info.
-
-        'routes_enabled' => true,   // If the routes have to be enabled.
-    ];
+return [
+    'api_key' => '',            // visit: http://openweathermap.org/appid#get for more info.
+    'routes_enabled' => true,   // If the routes have to be enabled.
+];