Merge pull request #36 from Nyholm/features

Refactored the session handler

Author: Nyholm

src/Session/SessionHandler.php src/Bridge/SessionHandlerBridge.phpsrc/Session/SessionHandler.php renamed to src/Bridge/SessionHandlerBridge.php

@@ -9,17 +9,16 @@
  * with this source code in the file LICENSE.
  */
 
-namespace Cache\CacheBundle\Session;
+namespace Cache\CacheBundle\Bridge;
 
-use Cache\Taggable\TaggablePoolInterface;
 use Psr\Cache\CacheItemPoolInterface;
 
 /**
  * Class SessionHandler.
  *
  * @author Aaron Scherer <aequasi@gmail.com>
  */
-class SessionHandler implements \SessionHandlerInterface
+class SessionHandlerBridge implements \SessionHandlerInterface
 {
     /**
      * @type CacheItemPoolInterface Cache driver.
@@ -102,10 +101,6 @@ public function write($sessionId, $data)
      */
     public function destroy($sessionId)
     {
-        if ($this->cache instanceof TaggablePoolInterface) {
-            return $this->cache->deleteItem($this->prefix.$sessionId, ['session']);
-        }
-
         return $this->cache->deleteItem($this->prefix.$sessionId);
     }
 
@@ -125,10 +120,6 @@ public function gc($lifetime)
      */
     private function getCacheItem($sessionId)
     {
-        if ($this->cache instanceof TaggablePoolInterface) {
-            return $this->cache->getItem($this->prefix.$sessionId, ['session']);
-        }
-
         return $this->cache->getItem($this->prefix.$sessionId);
     }
 }

src/DependencyInjection/CacheExtension.php

@@ -12,6 +12,7 @@
 namespace Cache\CacheBundle\DependencyInjection;
 
 use Cache\Bridge\DoctrineCacheBridge;
+use Cache\CacheBundle\Bridge\SessionHandlerBridge;
 use Cache\CacheBundle\Bridge\SymfonyValidatorBridge;
 use Cache\CacheBundle\Factory\AnnotationFactory;
 use Cache\CacheBundle\Factory\SerializerFactory;
@@ -70,6 +71,13 @@ public function load(array $configs, ContainerBuilder $container)
                 ->addArgument($config['validation']);
         }
 
+        if ($config['session']['enabled']) {
+            $container->register('cache.service.session', SymfonyValidatorBridge::class)
+                ->setFactory([SessionHandlerBridge::class, 'get'])
+                ->addArgument(new Reference($config['session']['service_id']))
+                ->addArgument($config['session']);
+        }
+
         if ($config['router']['enabled']) {
             $loader->load('router.yml');
             $container->getDefinition('cache.router')

src/DependencyInjection/Compiler/SessionSupportCompilerPass.php

@@ -11,12 +11,8 @@
 
 namespace Cache\CacheBundle\DependencyInjection\Compiler;
 
-use Cache\CacheBundle\Session\SessionHandler;
-use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\Definition;
-use Symfony\Component\DependencyInjection\Reference;
 
 /**
  * Class SessionSupportCompilerPass.
@@ -25,11 +21,6 @@
  */
 class SessionSupportCompilerPass implements CompilerPassInterface
 {
-    /**
-     * @type ContainerBuilder
-     */
-    protected $container;
-
     /**
      * @param ContainerBuilder $container
      *
@@ -47,30 +38,6 @@ public function process(ContainerBuilder $container)
             throw new \Exception('Session cache support cannot be enabled if there is no session.storage service');
         }
 
-        $this->enableSessionSupport($container, $container->getParameter('cache.session'));
-    }
-
-    /**
-     * Enables session support for memcached.
-     *
-     * @param array $config Configuration for bundle
-     *
-     * @throws InvalidConfigurationException
-     */
-    private function enableSessionSupport(ContainerBuilder $container, array $config)
-    {
-        // calculate options
-        $sessionOptions = $container->getParameter('session.storage.options');
-        if (isset($sessionOptions['cookie_lifetime']) && !isset($config['cookie_lifetime'])) {
-            $config['cookie_lifetime'] = $sessionOptions['cookie_lifetime'];
-        }
-        // load the session handler
-        $definition = new Definition(SessionHandler::class);
-        $definition->addArgument(new Reference($config['service_id']))
-            ->addArgument($config);
-
-        $container->setDefinition('cache.session_handler', $definition);
-
-        $container->setAlias('session.handler', 'cache.session_handler');
+        $container->setAlias('session.handler', 'cache.service.session');
     }
 }

src/DependencyInjection/Configuration.php

@@ -60,9 +60,7 @@ private function addSessionSupportSection()
             ->addDefaultsIfNotSet()
             ->children()
                 ->scalarNode('service_id')->isRequired()->end()
-                ->scalarNode('prefix')
-                    ->defaultValue('session_')
-                ->end()
+                ->scalarNode('prefix')->defaultValue('session_')->end()
                 ->scalarNode('ttl')->end()
             ->end();
 

src/Factory/SessionHandlerFactory.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of php-cache\cache-bundle package.
+ *
+ * (c) 2015-2015 Aaron Scherer <aequasi@gmail.com>, Tobias Nyholm <tobias.nyholm@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Cache\CacheBundle\Factory;
+
+use Cache\Bridge\DoctrineCacheBridge;
+use Cache\CacheBundle\Bridge\SessionHandlerBridge;
+use Cache\CacheBundle\Cache\FixedTaggingCachePool;
+use Psr\Cache\CacheItemPoolInterface;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class SessionHandlerFactory
+{
+    /**
+     * @param CacheItemPoolInterface $pool
+     * @param array                  $config
+     *
+     * @return DoctrineCacheBridge
+     */
+    public static function get(CacheItemPoolInterface $pool, $config)
+    {
+        if ($config['use_tagging']) {
+            $pool = new FixedTaggingCachePool($pool, ['session']);
+        }
+
+        return new SessionHandlerBridge($pool, $config);
+    }
+}