wip: update phpdoc, implement enum key resolution on APC

Author: michaeldyrynda

src/Illuminate/Cache/ApcStore.php

@@ -2,6 +2,8 @@
 
 namespace Illuminate\Cache;
 
+use function Illuminate\Support\enum_value;
+
 class ApcStore extends TaggableStore
 {
     use RetrievesMultipleKeys;
@@ -35,48 +37,56 @@ public function __construct(ApcWrapper $apc, $prefix = '')
     /**
      * Retrieve an item from the cache by key.
      *
-     * @param  string  $key
+     * @param  \BackedEnum|\UnitEnum|string  $key
      * @return mixed
      */
     public function get($key)
     {
+        $key = enum_value($key);
+
         return $this->apc->get($this->prefix.$key);
     }
 
     /**
      * Store an item in the cache for a given number of seconds.
      *
-     * @param  string  $key
+     * @param  \BackedEnum|\UnitEnum|string  $key
      * @param  mixed  $value
      * @param  int  $seconds
      * @return bool
      */
     public function put($key, $value, $seconds)
     {
+        $key = enum_value($key);
+
         return $this->apc->put($this->prefix.$key, $value, $seconds);
     }
 
     /**
      * Increment the value of an item in the cache.
      *
-     * @param  string  $key
+     * @param  \BackedEnum|\UnitEnum|string  $key
      * @param  mixed  $value
      * @return int|bool
      */
     public function increment($key, $value = 1)
     {
+        $key = enum_value($key);
+
         return $this->apc->increment($this->prefix.$key, $value);
     }
 
     /**
      * Decrement the value of an item in the cache.
      *
-     * @param  string  $key
+     * @param  \BackedEnum|\UnitEnum|string  $key
      * @param  mixed  $value
      * @return int|bool
      */
     public function decrement($key, $value = 1)
     {
+        $key = enum_value($key);
+
         return $this->apc->decrement($this->prefix.$key, $value);
     }
 
@@ -95,11 +105,13 @@ public function forever($key, $value)
     /**
      * Remove an item from the cache.
      *
-     * @param  string  $key
+     * @param  \BackedEnum|\UnitEnum|string  $key
      * @return bool
      */
     public function forget($key)
     {
+        $key = enum_value($key);
+
         return $this->apc->delete($this->prefix.$key);
     }
 

src/Illuminate/Contracts/Cache/Store.php

@@ -7,7 +7,7 @@ interface Store
     /**
      * Retrieve an item from the cache by key.
      *
-     * @param  string  $key
+     * @param  \BackedEnum|\UnitEnum|string  $key
      * @return mixed
      */
     public function get($key);
@@ -25,7 +25,7 @@ public function many(array $keys);
     /**
      * Store an item in the cache for a given number of seconds.
      *
-     * @param  string  $key
+     * @param  \BackedEnum|\UnitEnum|string  $key
      * @param  mixed  $value
      * @param  int  $seconds
      * @return bool
@@ -44,7 +44,7 @@ public function putMany(array $values, $seconds);
     /**
      * Increment the value of an item in the cache.
      *
-     * @param  string  $key
+     * @param  \BackedEnum|\UnitEnum|string  $key
      * @param  mixed  $value
      * @return int|bool
      */
@@ -53,7 +53,7 @@ public function increment($key, $value = 1);
     /**
      * Decrement the value of an item in the cache.
      *
-     * @param  string  $key
+     * @param  \BackedEnum|\UnitEnum|string  $key
      * @param  mixed  $value
      * @return int|bool
      */
@@ -62,7 +62,7 @@ public function decrement($key, $value = 1);
     /**
      * Store an item in the cache indefinitely.
      *
-     * @param  string  $key
+     * @param  \BackedEnum|\UnitEnum|string  $key
      * @param  mixed  $value
      * @return bool
      */
@@ -71,7 +71,7 @@ public function forever($key, $value);
     /**
      * Remove an item from the cache.
      *
-     * @param  string  $key
+     * @param  \BackedEnum|\UnitEnum|string  $key
      * @return bool
      */
     public function forget($key);

tests/Cache/CacheApcStoreTest.php

@@ -5,10 +5,21 @@
 use Illuminate\Cache\ApcStore;
 use Illuminate\Cache\ApcWrapper;
 use Mockery;
+use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
 class CacheApcStoreTest extends TestCase
 {
+    public static function resolveKeyNameDataProvider(): array
+    {
+        return [
+            'uses BackedEnum' => [BackedCacheKey::Foo, 'foo'],
+            'uses UnitEnum' => [UnitCacheKey::Foo, 'Foo'],
+            'uses normal string' => ['foo', 'foo'],
+            'uses int' => [100, '100'],
+        ];
+    }
+
     public function testGetReturnsNullWhenNotFound()
     {
         $apc = $this->getMockBuilder(ApcWrapper::class)->onlyMethods(['get'])->getMock();
@@ -132,4 +143,13 @@ public function testFlushesCached()
         $result = $store->flush();
         $this->assertTrue($result);
     }
+
+enum UnitCacheKey
+{
+    case Foo;
+}
+
+enum BackedCacheKey: string
+{
+    case Foo = 'foo';
 }