added factory methods disableCaching and enableCaching to disable or enable caching on the fly

Author: stevleibelt

src/Domino/CacheStore/Factory.php

@@ -10,6 +10,7 @@
 namespace Domino\CacheStore;
 
 use Domino\CacheStore\Exception\StorageException;
+use Domino\CacheStore\Storage\StorageInterface;
 
 /**
  * Domino Cache Store Factory
@@ -30,6 +31,9 @@ class Factory
      */
     private static $connectionMap = array();
 
+    /** @var bool */
+    private static $cachingIsDisabled = false;
+
     /**
      * Registered storage
      * @var array
@@ -38,6 +42,7 @@ class Factory
         'apc'       => 'Domino\CacheStore\Storage\Apc',
         'memcached' => 'Domino\CacheStore\Storage\Memcached',
         'memcache'  => 'Domino\CacheStore\Storage\Memcache',
+        'nocache'   => 'Domino\CacheStore\Storage\NoCache',
         'redis'     => 'Domino\CacheStore\Storage\Redis',
     );
 
@@ -103,17 +108,41 @@ public static function clearConnectionCache()
         self::$connectionMap = array();
     }
 
+    /**
+     * Changes the behavior of the method factory
+     * If you trigger this method, you will get back a NoCache storage
+     */
+    public static function disableCaching()
+    {
+        self::$cachingIsDisabled = true;
+    }
+
+    /**
+     * Resets behavior of the method factory
+     * If you trigger this method, you will get back the storage you want to
+     *
+     * HINT:
+     *  If you enable caching, I recommend to clear the cache right afterwards.
+     */
+    public static function enableCaching()
+    {
+        self::$cachingIsDisabled = false;
+    }
+
     /**
      * Instantiate a cache storage
      * @param  string  $storage_type cache store storage type (eg. 'apc', 'memcached')
-     * @return Storage               cache store storage instance
+     * @return StorageInterface               cache store storage instance
      * @throws StorageException when $storage_type is not registered
      */
     public static function factory($storage_type)
     {
         if (!array_key_exists($storage_type, self::$storage)) {
             throw new StorageException(sprintf('Storage class not set for type %s', $storage_type));
         }
+        if (self::$cachingIsDisabled) {
+            $storage_type = 'nocache';
+        }
         if (!isset(self::$connectionMap[$storage_type])) {
             self::$connectionMap[$storage_type] = new self::$storage[$storage_type](self::getOption($storage_type));
         }
@@ -124,8 +153,8 @@ public static function factory($storage_type)
     /**
      * Register a cache storage
      *
-     * @param $storage_type cache store storage type (eg. 'apc', 'memcached', 'my_apc')
-     * @param $storage_class class name which must implement Domino\CacheStore\Storage\StorageInterface
+     * @param string $storage_type cache store storage type (eg. 'apc', 'memcached', 'my_apc')
+     * @param string $storage_class class name which must implement Domino\CacheStore\Storage\StorageInterface
      * @throws StorageException when $storage_class not implements Domino\CacheStore\Storage\StorageInterface
      */
     public static function registerStorage($storage_type, $storage_class)

tests/Domino/CacheStore/Tests/FactoryTest.php

@@ -22,6 +22,7 @@ class FactoryTest extends \PHPUnit_Framework_TestCase
     public function setUp()
     {
         CacheStore\Factory::clearOptions();
+        CacheStore\Factory::enableCaching();
     }
 
     public function testOptions()
@@ -36,10 +37,10 @@ public function testOptions()
 
     public function testOption()
     {
-        $set_apc_option = array("storage" => 'apc', 'default_ttl' => 10);
+        $set_apc_option = array('storage' => 'apc', 'default_ttl' => 10);
         CacheStore\Factory::setOption($set_apc_option);
 
-        $set_memcached_option = array("storage" => 'memcached', 'option1' => 20);
+        $set_memcached_option = array('storage' => 'memcached', 'option1' => 20);
         CacheStore\Factory::setOption($set_memcached_option);
 
         $get_apc_option = CacheStore\Factory::getOption('apc');
@@ -60,6 +61,10 @@ public function testFactoryApc()
 
     public function testFactoryMemcached()
     {
+        if (!extension_loaded('memcached')) {
+            $this->markTestSkipped('Memcached extension is not loaded');
+        }
+
         $memcached_option = array('storage' => 'memcached', 'default_ttl' => 10, 'prefix' => '_md', 'servers' => array());
         CacheStore\Factory::setOption($memcached_option);
 
@@ -69,6 +74,10 @@ public function testFactoryMemcached()
 
     public function testFactoryMemcache()
     {
+        if (!extension_loaded('memcache')) {
+            $this->markTestSkipped('Memcache extension is not loaded');
+        }
+
         $memcached_option = array('storage' => 'memcache', 'default_ttl' => 10, 'prefix' => '_md', 'servers' => array());
         CacheStore\Factory::setOption($memcached_option);
 
@@ -93,7 +102,7 @@ public function testRegisterStorage()
         // register custom storage
         $customStorage = $this->getMock('Domino\CacheStore\Storage\StorageInterface');
         CacheStore\Factory::registerStorage('custom', get_class($customStorage));
-        $cacheStore = CacheStore\Factory::factory('custom', get_class($customStorage));
+        $cacheStore = CacheStore\Factory::factory('custom');
         $this->assertInstanceOf(get_class($customStorage), $cacheStore);
 
         // try to register custom storage with bad interface
@@ -124,4 +133,33 @@ public function testClearConnectionCache()
 
         $this->assertNotSame($store1, $store2);
     }
+
+    public function testDisableCache()
+    {
+        CacheStore\Factory::disableCaching();
+        $storage = CacheStore\Factory::factory('apc');
+
+        $this->assertInstanceOf('\Domino\CacheStore\Storage\NoCache', $storage);
+    }
+
+    public function testDisableAndEnableCache()
+    {
+        //begin of setup
+        $name           = 'custom';
+        /** @var CacheStore\Storage\StorageInterface $storageMock */
+        $storageMock    = $this->getMock('Domino\CacheStore\Storage\StorageInterface');
+        CacheStore\Factory::registerStorage($name, get_class($storageMock));
+        //end of setup
+
+        //begin of assertions
+        $customStorage  = CacheStore\Factory::factory($name);
+        CacheStore\Factory::disableCaching();
+        $noCacheStorage = CacheStore\Factory::factory($name);
+
+        $this->assertInstanceOf('\Domino\CacheStore\Storage\NoCache', $noCacheStorage);
+        CacheStore\Factory::enableCaching();
+
+        $this->assertSame($customStorage, CacheStore\Factory::factory($name));
+        //end of assertions
+    }
 }