memcached cache pool adapter

robfrawley · robfrawley · commit 740bce0f0e3e · 2016-12-10T13:05:39.000-05:00
diff --git a/src/Symfony/Component/Cache/Adapter/MemcachedAdapter.php b/src/Symfony/Component/Cache/Adapter/MemcachedAdapter.php
@@ -0,0 +1,100 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Cache\Adapter;
+
+/**
+ * @author Rob Frawley 2nd <rmf@src.run>
+ */
+class MemcachedAdapter extends AbstractAdapter
+{
+    private $client;
+
+    /**
+     * @param \Memcached $client
+     */
+    public function __construct(\Memcached $client, $namespace = '', $defaultLifetime = 0)
+    {
+        parent::__construct($namespace, $defaultLifetime);
+        $this->client = $client;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function doSave(array $values, $lifetime)
+    {
+        return $this->client->setMulti($values, $lifetime)
+            && $this->client->getResultCode() === \Memcached::RES_SUCCESS;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function doFetch(array $ids)
+    {
+        foreach ($this->client->getMulti($ids) as $id => $val) {
+            yield $id => $val;
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function doHave($id)
+    {
+        return $this->client->get($id) !== false
+            && $this->client->getResultCode() !== \Memcached::RES_NOTFOUND;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function doDelete(array $ids)
+    {
+        $toDelete = count($ids);
+        foreach ((array) $this->client->deleteMulti($ids) as $result) {
+            if (true === $result || \Memcached::RES_NOTFOUND === $result) {
+                --$toDelete;
+            }
+        }
+
+        return 0 === $toDelete;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function doClear($namespace)
+    {
+        if (!isset($namespace[0]) || false === $ids = $this->getIdsByPrefix($namespace)) {
+            return $this->client->flush();
+        }
+
+        $isCleared = true;
+        do {
+            $isCleared = $this->doDelete($ids) && $isCleared;
+        } while ($ids = $this->getIdsByPrefix($namespace));
+
+        return $isCleared;
+    }
+
+    private function getIdsByPrefix($namespace)
+    {
+        if (false === $ids = $this->client->getAllKeys()) {
+            return false;
+        }
+
+        return array_filter((array) $ids, function ($id) use ($namespace) {
+            return 0 === strpos($id, $namespace);
+        });
+    }
+}
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/MemcachedAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/MemcachedAdapterTest.php
@@ -0,0 +1,68 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Cache\Tests\Adapter;
+
+use Symfony\Component\Cache\Adapter\MemcachedAdapter;
+
+/**
+ * @author Rob Frawley 2nd <rmf@src.run>
+ */
+class MemcachedAdapterTest extends AdapterTestCase
+{
+    protected $skippedTests = array(
+        //'testExpiration' => 'Testing expiration slows down the test suite',
+        //'testHasItemReturnsFalseWhenDeferredItemIsExpired' => 'Testing expiration slows down the test suite',
+        //'testDefaultLifeTime' => 'Testing expiration slows down the test suite',
+    );
+
+    private static $client;
+
+    private static function clientDefaultServer()
+    {
+        return array(
+            getenv('MEMCACHED_HOST') ?: '127.0.0.1',
+            getenv('MEMCACHED_PORT') ?: 11211,
+        );
+    }
+
+    public static function setupBeforeClass()
+    {
+        if (!extension_loaded('memcached') || !version_compare(phpversion('memcached'), '2.1.0', '>')) {
+            self::markTestSkipped('Extension memcached >2.1.0 required.');
+        }
+
+        self::$client = new \Memcached();
+        self::$client->addServers(array(static::clientDefaultServer()));
+
+        parent::setupBeforeClass();
+    }
+
+    public function createCachePool($defaultLifetime = 0)
+    {
+        return new MemcachedAdapter(self::$client, str_replace('\\', '.', __CLASS__), $defaultLifetime);
+    }
+
+    /**
+     * @group memcachedAdapter
+     */
+    public function testAdapterAndClientCreationAndServers()
+    {
+        $this->assertInstanceOf(MemcachedAdapter::class, static::createCachePool(),
+            'Adapter created should be instance of MemcachedAdapter.');
+
+        $this->assertInstanceOf(\Memcached::class, static::$client,
+            'Client created should be instance of Memcached.');
+
+        $this->assertCount(1, static::$client->getServerList(),
+            'No registered servers should exist with Memcached client.');
+    }
+}
