Added APCU support.

This should solve ##274.
tedious · Dec 14, 2015 · 00bcc6b · 00bcc6b
1 parent 6b8c33d
commit 00bcc6b
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 ### v1.0.0
 
-* Implemented PSR-6 interfaces. 
+* Implemented PSR-6 interfaces.
 
 * Removed deprecated DriverList::getDrivers function.
 
@@ -34,6 +34,8 @@
 
 * Removed legacy methods for defining keys- keys must be defined as strings.
 
+* Added support for "APCU" functions.
+
 
 ## Stash v0.13 Changelog
 

diff --git a/src/Stash/Driver/Apc.php b/src/Stash/Driver/Apc.php
@@ -36,6 +36,14 @@ class Apc extends AbstractDriver
      */
     protected $apcNamespace;
 
+    /**
+     * Whether to use the APCu functions or the original APC ones.
+     *
+     * @var string
+     */
+    protected $apcu = false;
+
+
     /**
      * The number of records \ApcIterator will grab at once.
      *
@@ -51,6 +59,10 @@ public function getDefaultOptions()
         return array(
             'ttl' => 300,
             'namespace' => md5(__FILE__),
+
+            // Test using the APCUIterator, as some versions of APCU have the
+            // custom functions but not the iterator class.
+            'apcu' => class_exists('\APCUIterator')
         );
     }
 
@@ -68,6 +80,7 @@ public function setOptions(array $options = array())
 
         $this->ttl = (int) $options['ttl'];
         $this->apcNamespace = $options['namespace'];
+        $this->apcu = $options['apcu'];
     }
 
     /**
@@ -77,7 +90,7 @@ public function getData($key)
     {
         $keyString = self::makeKey($key);
         $success = null;
-        $data = apc_fetch($keyString, $success);
+        $data = $this->apcu ? apcu_fetch($keyString, $success) : apc_fetch($keyString, $success);
 
         return $success ? $data : false;
     }
@@ -88,8 +101,11 @@ public function getData($key)
     public function storeData($key, $data, $expiration)
     {
         $life = $this->getCacheTime($expiration);
+        $apckey = $this->makeKey($key);
+        $store = array('data' => $data, 'expiration' => $expiration);
 
-        return apc_store($this->makeKey($key), array('data' => $data, 'expiration' => $expiration), $life);
+
+        return $this->apcu ? apcu_store($apckey, $store, $life) : apc_store($apckey, $store, $life);
     }
 
     /**
@@ -98,17 +114,19 @@ public function storeData($key, $data, $expiration)
     public function clear($key = null)
     {
         if (!isset($key)) {
-            return apc_clear_cache('user');
+            return $this->apcu ? apcu_clear_cache('user') : apc_clear_cache('user');
         } else {
             $keyRegex = '[' . $this->makeKey($key) . '*]';
             $chunkSize = isset($this->chunkSize) && is_numeric($this->chunkSize) ? $this->chunkSize : 100;
 
             do {
                 $emptyIterator = true;
-                $it = new \APCIterator('user', $keyRegex, \APC_ITER_KEY, $chunkSize);
+                $iteratorClass = $this->apcu ? '\APCUIterator' : '\APCIterator';
+                $it = new $iteratorClass('user', $keyRegex, \APC_ITER_KEY, $chunkSize);
+
                 foreach ($it as $item) {
                     $emptyIterator = false;
-                    apc_delete($item['key']);
+                    $this->apcu ? apcu_delete($item['key']) : apc_delete($item['key']);
                 }
             } while (!$emptyIterator);
         }
@@ -128,10 +146,10 @@ public function purge()
         $it = new \APCIterator('user', $keyRegex, \APC_ITER_KEY, $chunkSize);
         foreach ($it as $item) {
             $success = null;
-            $data = apc_fetch($item['key'], $success);
+            $data = $this->apcu ? apcu_fetch($item['key'], $success): apc_fetch($item['key'], $success);
 
             if ($success && is_array($data) && $data['expiration'] <= $now) {
-                apc_delete($item['key']);
+                $this->apcu ? apcu_delete($item['key']) : apc_delete($item['key']);
             }
         }
 
@@ -145,12 +163,12 @@ public function purge()
      */
     public static function isAvailable()
     {
-        // HHVM has some of the APC extension, but not all of it.
-        if (!class_exists('\APCIterator')) {
+        // Some versions of HHVM are missing the APCIterator
+        if (!class_exists('\APCIterator') && !class_exists('\APCUIterator')) {
             return false;
         }
 
-        return function_exists('apc_fetch');
+        return function_exists('apcu_fetch') || function_exists('apc_fetch');
     }
 
     /**