Switch to PSR-6 cache implementation

Author: cmfcmf

Cmfcmf/OpenWeatherMap.php

@@ -17,7 +17,6 @@
 
 namespace Cmfcmf;
 
-use Cmfcmf\OpenWeatherMap\AbstractCache;
 use Cmfcmf\OpenWeatherMap\CurrentWeather;
 use Cmfcmf\OpenWeatherMap\UVIndex;
 use Cmfcmf\OpenWeatherMap\CurrentWeatherGroup;
@@ -27,6 +26,7 @@
 use Cmfcmf\OpenWeatherMap\Fetcher\FileGetContentsFetcher;
 use Cmfcmf\OpenWeatherMap\WeatherForecast;
 use Cmfcmf\OpenWeatherMap\WeatherHistory;
+use Psr\Cache\CacheItemPoolInterface;
 
 /**
  * Main class for the OpenWeatherMap-PHP-API. Only use this class.
@@ -74,14 +74,14 @@ class OpenWeatherMap
     private $uvIndexUrl = 'https://api.openweathermap.org/data/2.5/uvi';
 
     /**
-     * @var AbstractCache|bool $cache The cache to use.
+     * @var CacheItemPoolInterface|null $cache The cache to use.
      */
-    private $cache = false;
+    private $cache = null;
 
     /**
      * @var int
      */
-    private $seconds;
+    private $ttl;
 
     /**
      * @var bool
@@ -101,41 +101,36 @@ class OpenWeatherMap
     /**
      * Constructs the OpenWeatherMap object.
      *
-     * @param string                $apiKey  The OpenWeatherMap API key. Required.
-     * @param null|FetcherInterface $fetcher The interface to fetch the data from OpenWeatherMap. Defaults to
-     *                                       CurlFetcher() if cURL is available. Otherwise defaults to
-     *                                       FileGetContentsFetcher() using 'file_get_contents()'.
-     * @param bool|string           $cache   If set to false, caching is disabled. Otherwise this must be a class
-     *                                       extending AbstractCache. Defaults to false.
-     * @param int $seconds                   How long weather data shall be cached. Default 10 minutes.
-     *
-     * @throws \Exception If $cache is neither false nor a valid callable extending Cmfcmf\OpenWeatherMap\Util\Cache.
+     * @param string                      $apiKey  The OpenWeatherMap API key. Required.
+     * @param null|FetcherInterface       $fetcher The interface to fetch the data from OpenWeatherMap. Defaults to
+     *                                             CurlFetcher() if cURL is available. Otherwise defaults to
+     *                                             FileGetContentsFetcher() using 'file_get_contents()'.
+     * @param null|CacheItemPoolInterface $cache   If set to null, caching is disabled. Otherwise this must be
+     *                                             a PSR 16-compatible cache instance.
+     * @param int                         $ttl     How long weather data shall be cached. Defaults to 10 minutes.
+     *                                             Only used if $cache is not null.
      *
      * @api
      */
-    public function __construct($apiKey, $fetcher = null, $cache = false, $seconds = 600)
+    public function __construct($apiKey, $fetcher = null, $cache = null, $ttl = 600)
     {
         if (!is_string($apiKey) || empty($apiKey)) {
             throw new \InvalidArgumentException("You must provide an API key.");
         }
 
-        $this->apiKey = $apiKey;
-
-        if ($cache !== false && !($cache instanceof AbstractCache)) {
-            throw new \InvalidArgumentException('The cache class must implement the FetcherInterface!');
+        if ($cache !== null && !($cache instanceof CacheItemPoolInterface)) {
+            throw new \InvalidArgumentException('The cache class must implement the \Psr\Cache\CacheItemPoolInterface!');
         }
-        if (!is_numeric($seconds)) {
+        if (!is_numeric($ttl)) {
             throw new \InvalidArgumentException('$seconds must be numeric.');
         }
         if (!isset($fetcher)) {
             $fetcher = (function_exists('curl_version')) ? new CurlFetcher() : new FileGetContentsFetcher();
         }
-        if ($seconds == 0) {
-            $cache = false;
-        }
 
+        $this->apiKey = $apiKey;
         $this->cache = $cache;
-        $this->seconds = $seconds;
+        $this->ttl = $ttl;
         $this->fetcher = $fetcher;
     }
 
@@ -576,18 +571,21 @@ public function wasCached()
      */
     private function cacheOrFetchResult($url)
     {
-        if ($this->cache !== false) {
-            /** @var AbstractCache $cache */
-            $cache = $this->cache;
-            $cache->setSeconds($this->seconds);
-
-            if ($cache->isCached($url)) {
+        if ($this->cache !== null) {
+            $key = str_replace(
+                ["{", "}", "(", ")", "/", "\\", "@", ":"],
+                ["_", "_", "_", "_", "_", "_",  "_", "_"],
+                $url);
+            $item = $this->cache->getItem($key);
+            if ($item->isHit()) {
                 $this->wasCached = true;
-                return $cache->getCached($url);
+                return $item->get();
             }
 
             $result = $this->fetcher->fetch($url);
-            $cache->setCached($url, $result);
+            $item->set($result);
+            $item->expiresAfter($this->ttl);
+            $this->cache->save($item);
         } else {
             $result = $this->fetcher->fetch($url);
         }
@@ -712,7 +710,7 @@ private function parseXML($answer)
     /**
      * @param string $answer The content returned by OpenWeatherMap.
      *
-     * @return \stdClass
+     * @return \stdClass|array
      * @throws OWMException If the content isn't valid JSON.
      */
     private function parseJson($answer)

Cmfcmf/OpenWeatherMap/AbstractCache.php

@@ -32,9 +32,8 @@
 // Units (can be 'metric' or 'imperial' [default]):
 $units = 'metric';
 
-// Get OpenWeatherMap object. Don't use caching (take a look into Example_Cache.php to see how it works).
-$owm = new OpenWeatherMap();
-$owm->setApiKey($myApiKey);
+// Get OpenWeatherMap object
+$owm = new OpenWeatherMap($myApiKey);
 
 // Example 1: Get current temperature in Berlin.
 $weather = $owm->getWeather('Berlin', $units, $lang);

Examples/Cache.php

@@ -15,7 +15,6 @@
  * @see http://openweathermap.org/appid
  */
 use Cmfcmf\OpenWeatherMap;
-use Cmfcmf\OpenWeatherMap\Exception as OWMException;
 
 require_once __DIR__ . '/bootstrap.php';
 
@@ -33,8 +32,7 @@
 $units = 'metric';
 
 // Get OpenWeatherMap object. Don't use caching (take a look into Example_Cache.php to see how it works).
-$owm = new OpenWeatherMap();
-$owm->setApiKey($myApiKey);
+$owm = new OpenWeatherMap($myApiKey);
 
 // Example 1: Get current uv index in Berlin.
 $uvIndex = $owm->getCurrentUVIndex(52.520008, 13.404954);

Examples/CurrentWeather.php

@@ -1,6 +1,6 @@
 OpenWeatherMap PHP API
 ======================
-A php API to retrieve and parse global weather data from 
+A php API to retrieve and parse global weather data from
 [OpenWeatherMap.org](http://www.OpenWeatherMap.org).
 This library aims to normalise the provided data and remove some inconsistencies.
 This library is neither maintained by OpenWeatherMap nor their official PHP API.
@@ -37,8 +37,7 @@ $lang = 'de';
 // Units (can be 'metric' or 'imperial' [default]):
 $units = 'metric';
 
-// Create OpenWeatherMap object. 
-// Don't use caching (take a look into Examples/Cache.php to see how it works).
+// Create OpenWeatherMap object.
 $owm = new OpenWeatherMap('YOUR-API-KEY');
 
 try {
@@ -52,24 +51,24 @@ try {
 echo $weather->temperature;
 ```
 
-For more example code and instructions on how to use this library, please take 
-a look into  the `Examples` folder. Make sure to get an API Key from 
+For more example code and instructions on how to use this library, please take
+a look into  the `Examples` folder. Make sure to get an API Key from
 http://home.openweathermap.org/ and put it into `Examples/ApiKey.ini`.
+
 - `CurrentWeather.php` Shows how to receive the current weather.
 - `WeatherForecast.php` Shows how to receive weather forecasts.
 - `WeatherHistory.php` Shows how to receive weather history.
 - `UVIndex.php` Shows how to receive uv index data.
-- `Cache.php` Shows how to implement and use a cache.
 
 Contributing
 ============
-I'm happy about every **pull request** or **issue** you find and open to help 
+I'm happy about every **pull request** or **issue** you find and open to help
 make this API **more awesome**.
 
 ## Vagrant
 
 You can use [Vagrant](https://vagrantup.com) to kick-start your development.
-Simply run `vagrant up` and `vagrant ssh` to start a PHP VM with all 
+Simply run `vagrant up` and `vagrant ssh` to start a PHP VM with all
 dependencies included.
 
 ## Docker
@@ -95,7 +94,7 @@ License
 MIT — Please see the [LICENSE file](https://github.com/Cmfcmf/OpenWeatherMap-PHP-Api/blob/master/LICENSE)
 distributed with this source code for further information regarding copyright and licensing.
 
-**Please check out the following official links to read about the terms, pricing 
+**Please check out the following official links to read about the terms, pricing
 and license of OpenWeatherMap before using the service:**
 - [OpenWeatherMap.org/terms](http://OpenWeatherMap.org/terms)
 - [OpenWeatherMap.org/appid](http://OpenWeatherMap.org/appid)