Merge pull request #4 from php-cache/Nyholm-patch-1

Added redis in a comment.

Author: Nyholm

README.md

@@ -4,7 +4,7 @@
 This repository has one trait and one interfaces that makes a PSR-6 cache implementation taggable. Using tags allow you 
 to tag related items, and then clear the cached data for that tag only.
 
-*Note: Performance will be best with a driver such as memcached, which automatically purges stale records.*
+*Note: Performance will be best with a driver such as memcached or redis, which automatically purges stale records.*
 
 ## Usage
 

composer.json

@@ -1,7 +1,7 @@
 {
     "name":         "cache/taggable-cache",
     "type":         "library",
-    "description":  "Add tag support to your  PSR-6 cache implementation",
+    "description":  "Add tag support to your PSR-6 cache implementation",
     "keywords":     ["cache", "psr6", "tag", "taggable"],
     "homepage":     "https://github.com/php-cache/taggable-cache",
     "license":      "MIT",
@@ -17,7 +17,8 @@
             "homepage": "https://github.com/nyholm"
         }
     ],
-    "require":      {
+    "require":
+    {
         "php":       "^5.5|^7",
         "psr/cache": "1.0.0"
     },

src/TaggablePoolInterface.php

@@ -13,16 +13,21 @@
 
 /**
  * Lets you add tags to your cache items. Prepend the PSR-6 function arguments with an array of tag names for
- * functions not requiring an CacheItemInterface
+ * functions not requiring an CacheItemInterface.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
 interface TaggablePoolInterface
 {
-    public function getItem($key, array $tags = array());
-    public function getItems(array $keys = array(), array $tags = array());
-    public function hasItem($key, array $tags = array());
-    public function clear(array $tags = array());
-    public function deleteItem($key, array $tags = array());
-    public function deleteItems(array $keys, array $tags = array());
+    public function getItem($key, array $tags = []);
+
+    public function getItems(array $keys = [], array $tags = []);
+
+    public function hasItem($key, array $tags = []);
+
+    public function clear(array $tags = []);
+
+    public function deleteItem($key, array $tags = []);
+
+    public function deleteItems(array $keys, array $tags = []);
 }

src/TaggablePoolTrait.php

@@ -67,7 +67,7 @@ protected function flushTag($name)
     }
 
     /**
-     * Generate a good cache key that is dependent of the tags. This key should be the key of the CacheItem
+     * Generate a good cache key that is dependent of the tags. This key should be the key of the CacheItem.
      *
      * @param string $key
      * @param array  $tags
@@ -79,7 +79,7 @@ protected function generateCacheKey($key, array $tags)
         // We sort the tags because the order should not matter
         sort($tags);
 
-        $tagIds = array();
+        $tagIds = [];
         foreach ($tags as $tag) {
             $tagIds[] = $this->getTagId($tag);
         }

tests/Helper/CacheItem.php

@@ -1,28 +1,36 @@
 <?php
 
+/*
+ * This file is part of php-cache\taggable-cache package.
+ *
+ * (c) 2015-2015 Aaron Scherer <aequasi@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
 namespace Cache\Taggable\Tests\Helper;
 
 use Psr\Cache\CacheItemInterface;
 
 class CacheItem implements CacheItemInterface
 {
     /**
-     * @var string
+     * @type string
      */
     private $key;
 
     /**
-     * @var string
+     * @type string
      */
     private $value;
 
     /**
-     * @var boolean
+     * @type bool
      */
     private $hasValue = false;
 
     /**
-     *
      * @param string $key
      */
     public function __construct($key)
@@ -31,8 +39,7 @@ public function __construct($key)
     }
 
     /**
-     *
-     * @return boolean
+     * @return bool
      */
     public function isHit()
     {
@@ -63,7 +70,7 @@ public function get()
     public function set($value)
     {
         $this->hasValue = true;
-        $this->value = $value;
+        $this->value    = $value;
 
         return $this;
     }
@@ -77,6 +84,4 @@ public function expiresAfter($time)
     {
         // TODO: Implement expiresAfter() method.
     }
-
-
-}
+}

tests/Helper/CachePool.php

@@ -1,12 +1,21 @@
 <?php
 
+/*
+ * This file is part of php-cache\taggable-cache package.
+ *
+ * (c) 2015-2015 Aaron Scherer <aequasi@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
 namespace Cache\Taggable\Tests\Helper;
 
 use Cache\Taggable\TaggablePoolTrait;
 use Psr\Cache\CacheItemInterface;
 
 /**
- * A cache pool used in tests
+ * A cache pool used in tests.
  *
  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  */
@@ -15,11 +24,11 @@ class CachePool
     use TaggablePoolTrait;
 
     /**
-     * @var array
+     * @type array
      */
     private $memoryCache;
 
-    public function getItem($key, array $tags = array())
+    public function getItem($key, array $tags = [])
     {
         $taggedKey = $this->generateCacheKey($key, $tags);
 
@@ -37,10 +46,10 @@ protected function getTagItem($key)
         return $item;
     }
 
-
     public function save(CacheItemInterface $item)
     {
-        $this->memoryCache[$item->getKey()]=$item;
+        $this->memoryCache[$item->getKey()] = $item;
+
         return true;
     }
 
@@ -53,4 +62,4 @@ public function exposeFlushTag($name)
     {
         return $this->flushTag($name);
     }
-}
+}

tests/TaggablePoolTraitTest.php

@@ -43,4 +43,4 @@ public function testFlushTag()
         $cache->exposeFlushTag('tag');
         $this->assertFalse($cache->getItem('foo', ['tag'])->isHit());
     }
-}
+}