Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

RedisCache driver implementation #109

Merged
merged 4 commits into from Mar 30, 2012
@@ -0,0 +1,119 @@
+<?php
+
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information, see
+ * <http://www.doctrine-project.org>.
+ */
+
+namespace Doctrine\Common\Cache;
+
+use Redis;
+
+/**
+ * Redis cache provider.
+ *
+ * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
+ * @link www.doctrine-project.org
+ * @since 2.2
+ * @author Osman Ungur <osmanungur@gmail.com>
+ */
+class RedisCache extends CacheProvider
+{
+ /**
+ * @var Redis
+ */
+ private $redis;
+
+ /**
+ * Sets the redis instance to use.
+ *
+ * @param Redis $redis
+ */
+ public function setRedis(Redis $redis)
@Ocramius

Ocramius Mar 13, 2012

Owner

An instance of Redis is a hard dependency of this class. To avoid confusion, you should add a constructor that accepts an instance of Redis as a required parameter.

@o

o Mar 13, 2012

Contributor

I know Redis class is the hard dependency of RedisCache.
But, for avoid confusion, i used same convention with MemcacheCache driver.
https://github.com/doctrine/common/blob/master/lib/Doctrine/Common/Cache/MemcacheCache.php#L49

@Ocramius

Ocramius Mar 13, 2012

Owner

Hmm... Yeah, makes sense, but I don't like that either... Also, modifying the MemcacheCache adapter would break BC... :(

@Ocramius

Ocramius Mar 30, 2012

Owner

Could you eventually add a __construct($redis = null) constructor and check if the passed in $redis is a Redis instance? That would probably fix also my request :)

@o

o Apr 1, 2012

Contributor

Hi Marco,
For keeping conventions same, also should add this check to MemcachedDriver.

I think we can solve this problem in another discussion/pr :)

@Ocramius

Ocramius Apr 1, 2012

Owner

Yeah, I will eventually do that :)

+ {
+ $redis->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_IGBINARY);
+ $this->redis = $redis;
+ }
+
+ /**
+ * Gets the redis instance used by the cache.
+ *
+ * @return Redis
+ */
+ public function getRedis()
+ {
+ return $this->redis;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function doFetch($id)
+ {
+ return $this->redis->get($id);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function doContains($id)
+ {
+ return $this->redis->exists($id);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function doSave($id, $data, $lifeTime = 0)
+ {
+ $result = $this->redis->set($id, $data);
+ if ($lifeTime > 0) {
+ $this->redis->expire($id, $lifeTime);
+ }
+ return $result;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function doDelete($id)
+ {
+ return $this->redis->delete($id);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function doFlush()
+ {
+ return $this->redis->flushDB();
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function doGetStats()
+ {
+ $info = $this->redis->info();
+ return array(
+ Cache::STATS_HITS => false,
+ Cache::STATS_MISSES => false,
+ Cache::STATS_UPTIME => $info['uptime_in_seconds'],
+ Cache::STATS_MEMORY_USAGE => $info['used_memory'],
+ Cache::STATS_MEMORY_AVAILIABLE => false
+ );
+ }
+}
@@ -18,11 +18,15 @@ public function testBasics()
// Test fetch
$this->assertEquals('testing this out', $cache->fetch('test_key'));
-
+
// Test delete
$cache->save('test_key2', 'test2');
$cache->delete('test_key2');
$this->assertFalse($cache->contains('test_key2'));
+
+ // Fetch/save test with objects (Is cache driver serializes/unserializes objects correctly ?)
+ $cache->save('test_object_key', new \ArrayObject());
+ $this->assertTrue($cache->fetch('test_object_key') instanceof \ArrayObject);
}
public function testDeleteAll()
@@ -0,0 +1,30 @@
+<?php
+
+namespace Doctrine\Tests\Common\Cache;
+
+use Doctrine\Common\Cache\RedisCache;
+
+class RedisCacheTest extends CacheTest
+{
+ private $_redis;
+
+ public function setUp()
+ {
+ if (extension_loaded('redis')) {
+ $this->_redis = new \Redis();
+ $ok = @$this->_redis->connect('127.0.0.1');
+ if (!$ok) {
+ $this->markTestSkipped('The ' . __CLASS__ .' requires the use of redis');
+ }
+ } else {
+ $this->markTestSkipped('The ' . __CLASS__ .' requires the use of redis');
+ }
+ }
+
+ protected function _getCacheDriver()
+ {
+ $driver = new RedisCache();
+ $driver->setRedis($this->_redis);
+ return $driver;
+ }
+}