Honor PSR-16 SimpleCache interface

Methods `put`, `set`, `putMany`, `setMultiple`, and `forever` now return boolean values. Fixes issue #26674
laravel · Dec 1, 2018 · 90c9569 · 90c9569
1 parent d0cf02d
commit 90c9569
Show file tree

Hide file tree

Showing 18 changed files with 155 additions and 97 deletions.
diff --git a/src/Illuminate/Cache/ApcStore.php b/src/Illuminate/Cache/ApcStore.php
@@ -56,11 +56,11 @@ public function get($key)
      * @param  string  $key
      * @param  mixed   $value
      * @param  float|int  $minutes
-     * @return void
+     * @return bool
      */
     public function put($key, $value, $minutes)
     {
-        $this->apc->put($this->prefix.$key, $value, (int) ($minutes * 60));
+        return $this->apc->put($this->prefix.$key, $value, (int) ($minutes * 60));
     }
 
     /**
@@ -92,11 +92,11 @@ public function decrement($key, $value = 1)
      *
      * @param  string  $key
      * @param  mixed   $value
-     * @return void
+     * @return bool
      */
     public function forever($key, $value)
     {
-        $this->put($key, $value, 0);
+        return $this->put($key, $value, 0);
     }
 
     /**

diff --git a/src/Illuminate/Cache/ArrayStore.php b/src/Illuminate/Cache/ArrayStore.php
@@ -32,11 +32,13 @@ public function get($key)
      * @param  string  $key
      * @param  mixed   $value
      * @param  float|int  $minutes
-     * @return void
+     * @return bool
      */
     public function put($key, $value, $minutes)
     {
         $this->storage[$key] = $value;
+
+        return array_key_exists($key, $this->storage);
     }
 
     /**
@@ -71,11 +73,11 @@ public function decrement($key, $value = 1)
      *
      * @param  string  $key
      * @param  mixed   $value
-     * @return void
+     * @return bool
      */
     public function forever($key, $value)
     {
-        $this->put($key, $value, 0);
+        return $this->put($key, $value, 0);
     }
 
     /**

diff --git a/src/Illuminate/Cache/DatabaseStore.php b/src/Illuminate/Cache/DatabaseStore.php
@@ -89,7 +89,7 @@ public function get($key)
      * @param  string  $key
      * @param  mixed   $value
      * @param  float|int  $minutes
-     * @return void
+     * @return bool
      */
     public function put($key, $value, $minutes)
     {
@@ -100,9 +100,9 @@ public function put($key, $value, $minutes)
         $expiration = $this->getTime() + (int) ($minutes * 60);
 
         try {
-            $this->table()->insert(compact('key', 'value', 'expiration'));
+            return $this->table()->insert(compact('key', 'value', 'expiration'));
         } catch (Exception $e) {
-            $this->table()->where('key', $key)->update(compact('value', 'expiration'));
+            return $this->table()->where('key', $key)->update(compact('value', 'expiration'));
         }
     }
 
@@ -196,11 +196,11 @@ protected function getTime()
      *
      * @param  string  $key
      * @param  mixed   $value
-     * @return void
+     * @return bool
      */
     public function forever($key, $value)
     {
-        $this->put($key, $value, 5256000);
+        return $this->put($key, $value, 5256000);
     }
 
     /**

diff --git a/src/Illuminate/Cache/FileStore.php b/src/Illuminate/Cache/FileStore.php
@@ -55,15 +55,17 @@ public function get($key)
      * @param  string  $key
      * @param  mixed   $value
      * @param  float|int  $minutes
-     * @return void
+     * @return bool
      */
     public function put($key, $value, $minutes)
     {
         $this->ensureCacheDirectoryExists($path = $this->path($key));
 
-        $this->files->put(
+        $result = $this->files->put(
             $path, $this->expiration($minutes).serialize($value), true
         );
+
+        return $result !== false && $result > 0;
     }
 
     /**
@@ -112,11 +114,11 @@ public function decrement($key, $value = 1)
      *
      * @param  string  $key
      * @param  mixed   $value
-     * @return void
+     * @return bool
      */
     public function forever($key, $value)
     {
-        $this->put($key, $value, 0);
+        return $this->put($key, $value, 0);
     }
 
     /**

diff --git a/src/Illuminate/Cache/MemcachedStore.php b/src/Illuminate/Cache/MemcachedStore.php
@@ -106,11 +106,11 @@ public function many(array $keys)
      * @param  string  $key
      * @param  mixed   $value
      * @param  float|int  $minutes
-     * @return void
+     * @return bool
      */
     public function put($key, $value, $minutes)
     {
-        $this->memcached->set(
+        return $this->memcached->set(
             $this->prefix.$key, $value, $this->calculateExpiration($minutes)
         );
     }
@@ -120,7 +120,7 @@ public function put($key, $value, $minutes)
      *
      * @param  array  $values
      * @param  float|int  $minutes
-     * @return void
+     * @return bool
      */
     public function putMany(array $values, $minutes)
     {
@@ -130,7 +130,7 @@ public function putMany(array $values, $minutes)
             $prefixedValues[$this->prefix.$key] = $value;
         }
 
-        $this->memcached->setMulti(
+        return $this->memcached->setMulti(
             $prefixedValues, $this->calculateExpiration($minutes)
         );
     }
@@ -179,11 +179,11 @@ public function decrement($key, $value = 1)
      *
      * @param  string  $key
      * @param  mixed   $value
-     * @return void
+     * @return bool
      */
     public function forever($key, $value)
     {
-        $this->put($key, $value, 0);
+        return $this->put($key, $value, 0);
     }
 
     /**

diff --git a/src/Illuminate/Cache/NullStore.php b/src/Illuminate/Cache/NullStore.php
@@ -23,7 +23,7 @@ class NullStore extends TaggableStore implements Store
      */
     public function get($key)
     {
-        //
+        return null;
     }
 
     /**
@@ -32,11 +32,11 @@ public function get($key)
      * @param  string  $key
      * @param  mixed   $value
      * @param  float|int  $minutes
-     * @return void
+     * @return bool
      */
     public function put($key, $value, $minutes)
     {
-        //
+        return false;
     }
 
     /**
@@ -68,22 +68,22 @@ public function decrement($key, $value = 1)
      *
      * @param  string  $key
      * @param  mixed   $value
-     * @return void
+     * @return bool
      */
     public function forever($key, $value)
     {
-        //
+        return false;
     }
 
     /**
      * Remove an item from the cache.
      *
      * @param  string  $key
-     * @return void
+     * @return bool
      */
     public function forget($key)
     {
-        //
+        return true;
     }
 
     /**

diff --git a/src/Illuminate/Cache/RedisStore.php b/src/Illuminate/Cache/RedisStore.php
@@ -85,31 +85,37 @@ public function many(array $keys)
      * @param  string  $key
      * @param  mixed   $value
      * @param  float|int  $minutes
-     * @return void
+     * @return bool
      */
     public function put($key, $value, $minutes)
     {
-        $this->connection()->setex(
+        $result = $this->connection()->setex(
             $this->prefix.$key, (int) max(1, $minutes * 60), $this->serialize($value)
         );
+
+        return $result ? true : false;
     }
 
     /**
      * Store multiple items in the cache for a given number of minutes.
      *
      * @param  array  $values
      * @param  float|int  $minutes
-     * @return void
+     * @return bool
      */
     public function putMany(array $values, $minutes)
     {
         $this->connection()->multi();
 
+        $resultMany = null;
         foreach ($values as $key => $value) {
-            $this->put($key, $value, $minutes);
+            $result = $this->put($key, $value, $minutes);
+            $resultMany = is_null($resultMany) ? $result : $result && $resultMany;
         }
 
         $this->connection()->exec();
+
+        return $resultMany ?: false;
     }
 
     /**
@@ -158,11 +164,13 @@ public function decrement($key, $value = 1)
      *
      * @param  string  $key
      * @param  mixed   $value
-     * @return void
+     * @return bool
      */
     public function forever($key, $value)
     {
-        $this->connection()->set($this->prefix.$key, $this->serialize($value));
+        $result = $this->connection()->set($this->prefix.$key, $this->serialize($value));
+
+        return $result ? true : false;
     }
 
     /**

diff --git a/src/Illuminate/Cache/Repository.php b/src/Illuminate/Cache/Repository.php
@@ -194,55 +194,63 @@ public function pull($key, $default = null)
      * @param  string  $key
      * @param  mixed   $value
      * @param  \DateTimeInterface|\DateInterval|float|int|null  $minutes
-     * @return void
+     * @return bool
      */
     public function put($key, $value, $minutes = null)
     {
         if (is_array($key)) {
-            $this->putMany($key, $value);
+            $result = $this->putMany($key, $value);
 
-            return;
+            return $result;
         }
 
         if (! is_null($minutes = $this->getMinutes($minutes))) {
-            $this->store->put($this->itemKey($key), $value, $minutes);
+            $result = $this->store->put($this->itemKey($key), $value, $minutes);
 
             $this->event(new KeyWritten($key, $value, $minutes));
+
+            return $result;
         }
+
+        return false;
     }
 
     /**
      * {@inheritdoc}
      */
     public function set($key, $value, $ttl = null)
     {
-        $this->put($key, $value, $ttl);
+        return $this->put($key, $value, $ttl);
     }
 
     /**
      * Store multiple items in the cache for a given number of minutes.
      *
      * @param  array  $values
      * @param  \DateTimeInterface|\DateInterval|float|int  $minutes
-     * @return void
+     * @return bool
      */
     public function putMany(array $values, $minutes)
     {
         if (! is_null($minutes = $this->getMinutes($minutes))) {
-            $this->store->putMany($values, $minutes);
+            $result = $this->store->putMany($values, $minutes);
 
             foreach ($values as $key => $value) {
                 $this->event(new KeyWritten($key, $value, $minutes));
             }
+
+            return $result;
         }
+
+        return false;
     }
 
     /**
      * {@inheritdoc}
      */
     public function setMultiple($values, $ttl = null)
     {
-        $this->putMany($values, $ttl);
+        return $this->putMany($values, $ttl);
     }
 
     /**
@@ -309,13 +317,15 @@ public function decrement($key, $value = 1)
      *
      * @param  string  $key
      * @param  mixed   $value
-     * @return void
+     * @return bool
      */
     public function forever($key, $value)
     {
-        $this->store->forever($this->itemKey($key), $value);
+        $result = $this->store->forever($this->itemKey($key), $value);
 
         $this->event(new KeyWritten($key, $value, 0));
+
+        return $result;
     }
 
     /**

diff --git a/src/Illuminate/Cache/RetrievesMultipleKeys.php b/src/Illuminate/Cache/RetrievesMultipleKeys.php
@@ -28,12 +28,16 @@ public function many(array $keys)
      *
      * @param  array  $values
      * @param  float|int  $minutes
-     * @return void
+     * @return bool
      */
     public function putMany(array $values, $minutes)
     {
+        $resultMany = null;
         foreach ($values as $key => $value) {
-            $this->put($key, $value, $minutes);
+            $result = $this->put($key, $value, $minutes);
+            $resultMany = is_null($resultMany) ? $result : $result && $resultMany;
         }
+
+        return $resultMany ?: false;
     }
 }