BC - change cache service

Author: liverbool

Cache/LocalFile.php

@@ -30,7 +30,7 @@ public function getConfigTreeBuilder()
         $rootNode
             ->children()
                 ->scalarNode('enabled')->defaultValue(true)->end()
-                ->scalarNode('cache')->defaultValue(null)->end()
+                ->scalarNode('cache_adapter')->defaultValue(null)->end()
             ->end()
             ->children()
                 ->arrayNode('modifiers')

DependencyInjection/Configuration.php

@@ -43,8 +43,10 @@ public function load(array $configs, ContainerBuilder $container)
         $loader = new Loader\XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.xml');
 
-        $definition = $container->getDefinition('phpmob_twig_modify.modifier');
-        $definition->replaceArgument(0, new Reference($config['cache'] ?: 'phpmob_twig_modify.cache.local_file'));
+        if ($config['cache_adapter']) {
+            $definition = $container->getDefinition('phpmob_twig_modify.modifier');
+            $definition->replaceArgument(0, new Reference($config['cache_adapter']));
+        }
 
         foreach ($config['modifiers'] as $key => $options) {
             $definition->addMethodCall('addType', [$key, $options]);

DependencyInjection/PhpMobTwigModifyExtension.php

@@ -11,7 +11,7 @@
 
 namespace PhpMob\TwigModifyBundle\Modifier;
 
-use Doctrine\Common\Cache\Cache;
+use Symfony\Component\Cache\Adapter\AdapterInterface;
 
 /**
  * @author Ishmael Doss <[email protected]>
@@ -26,10 +26,10 @@ class Modify
     static private $types = [];
 
     /**
-     * @param Cache $cache
+     * @param AdapterInterface $cache
      * @param array $types
      */
-    public function __construct(Cache $cache = null, array $types = [])
+    public function __construct(AdapterInterface $cache = null, array $types = [])
     {
         self::$cache = $cache;
         self::$types = $types;
@@ -46,9 +46,10 @@ public static function addType($type, $minifier)
 
     /**
      * @param $content
-     * @param string $type
+     * @param $type
+     * @return mixed
      *
-     * @return string
+     * @throws \Psr\Cache\InvalidArgumentException
      */
     public static function modify($content, $type)
     {
@@ -64,16 +65,16 @@ public static function modify($content, $type)
 
         $cacheId = md5($content);
 
-        if (self::$cache && self::$cache->contains($cacheId)) {
-            return self::$cache->fetch($cacheId);
+        if (self::$cache && self::$cache->hasItem($cacheId)) {
+            return self::$cache->getItem($cacheId)->get();
         }
 
         $content = call_user_func_array(
             [$modifier['class'], $modifier['method']],
             [$content, $modifier['options']]
         );
 
-        self::$cache && self::$cache->save($cacheId, $content);
+        self::$cache && self::$cache->save(self::$cache->getItem($cacheId)->set($content));
 
         return $content;
     }

Modifier/Modify.php

@@ -10,7 +10,7 @@ recommended.
 
 ```yaml
 "require": {
-  "phpmob/twig-modify-bundle": "~1.0"
+  "phpmob/twig-modify-bundle": "~2.0"
 }
 ```
 
@@ -90,23 +90,17 @@ A wrapped modifier for `\voku\helper\AntiXSS`, Thanks [voku/anti-xss](https://gi
 ```
 
 ## Cache
-TwigModifyBundle use local cache folder by default, however you can use any cache that implemented `\Doctrine\Common\Cache\Cache` interface and then change the confiuration for your cache service:
+TwigModifyBundle use local cache folder by default, however you can use any cache that implemented `\Symfony\Component\Cache\Adapter\AdapterInterface` interface and then change the confiuration for your cache service:
 
 ```yaml
 phpmob_twig_modify:
-    cache: "my_cache_service_id"
+    cache_adapter: "my_cache_adapter_service_id"
 ```
 
-You can also use doctrine cache.
+You can also use symfony [framework-bundle cache adapter](https://symfony.com/doc/current/reference/configuration/framework.html#reference-templating-cache).
 ```yaml
-
-doctrine_cache:
-    providers:
-        modifier_cache:
-            type: file_system
-
 phpmob_twig_modify:
-    cache: "doctrine_cache.providers.modifier_cache"
+    cache_adapter: "cache.app"
 ```
 
 Don't fogot enable `DoctrineCacheBundle` in your `AppKernel.php` - See https://symfony.com/doc/current/bundles/DoctrineCacheBundle/index.html
@@ -139,8 +133,8 @@ Configuration reference:
 
 ```yaml
 phpmob_twig_modify:
-    # cache serivce implemented `\Doctrine\Common\Cache\Cache` interface.
-    cache: "my_cache_service_id"
+    # cache adapter serivce implemented `\Symfony\Component\Cache\Adapter\AdapterInterface` interface.
+    cache_adapter: "my_cache_service_id"
     # application wide toggle enable/disable all modifiers
     enabled: true
     # custom/override modifiers (same key of modifier will override other previous defined)

README.md

@@ -5,12 +5,14 @@
            xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <services>
-        <service id="phpmob_twig_modify.cache.local_file" class="PhpMob\TwigModifyBundle\Cache\LocalFile" public="false">
-            <argument>%kernel.cache_dir%/modify</argument>
-        </service>
-
         <service id="phpmob_twig_modify.modifier" class="PhpMob\TwigModifyBundle\Modifier\Modify">
-            <argument/>
+            <argument type="service">
+                <service id="phpmob_twig_modify.cache" class="\Symfony\Component\Cache\Adapter\FilesystemAdapter">
+                    <argument /> <!-- namespace -->
+                    <argument>0</argument> <!-- default lifetime -->
+                    <argument>%kernel.cache_dir%/pools</argument>
+                </service>
+            </argument>
             <argument type="collection">
                 <argument key="jsmin" type="collection">
                     <argument key="class">\PhpMob\TwigModifyBundle\Modifier\JSMin</argument>

Resources/config/services.xml

@@ -22,11 +22,14 @@
     ],
     "require": {
         "php": "^5.6|^7.0",
-        "doctrine/cache": "^1.4.2",
         "ezyang/htmlpurifier": "^4.9",
         "tedivm/jshrink": "^1.2",
         "tubalmartin/cssmin": "^4.1",
-        "voku/anti-xss": "^4.0"
+        "voku/anti-xss": "^4.0",
+        "symfony/cache": "^3.1",
+        "symfony/config": "^3.1",
+        "symfony/dependency-injection": "^3.1",
+        "symfony/http-kernel": "^3.1"
     },
     "require-dev": {
         "phpunit/phpunit": "^6.4.3"