minor #20172 [Cache] Accept only array in TagAwareAdapter::invalidateTags() (nicolas-grekas)

fabpot · fabpot · commit a5d134b13698 · 2016-10-09T04:12:45.000-07:00
This PR was merged into the 3.2-dev branch. Discussion ---------- [Cache] Accept only array in TagAwareAdapter::invalidateTags() | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Just to be sure that we won't suffer from some stupid incompatibility if a cache-tags PSR is published one day. See discussion: #19728 (comment) Commits ------- a08acc7 [Cache] Accept only array in TagAwareAdapter::invalidateTags()
diff --git a/src/Symfony/Component/Cache/Adapter/TagAwareAdapter.php b/src/Symfony/Component/Cache/Adapter/TagAwareAdapter.php
@@ -67,11 +67,8 @@ function ($deferred) {
     /**
      * {@inheritdoc}
      */
-    public function invalidateTags($tags)
+    public function invalidateTags(array $tags)
     {
-        if (!is_array($tags)) {
-            $tags = array($tags);
-        }
         foreach ($tags as $k => $tag) {
             if ('' !== $tag && is_string($tag)) {
                 $tags[$k] = $tag.static::TAGS_PREFIX;
diff --git a/src/Symfony/Component/Cache/Adapter/TagAwareAdapterInterface.php b/src/Symfony/Component/Cache/Adapter/TagAwareAdapterInterface.php
@@ -23,11 +23,11 @@ interface TagAwareAdapterInterface extends AdapterInterface
     /**
      * Invalidates cached items using tags.
      *
-     * @param string|string[] $tags A tag or an array of tags to invalidate
+     * @param string[] $tags An array of tags to invalidate
      *
      * @return bool True on success
      *
      * @throws InvalidArgumentException When $tags is not valid
      */
-    public function invalidateTags($tags);
+    public function invalidateTags(array $tags);
 }
diff --git a/src/Symfony/Component/Cache/Tests/Adapter/TagAwareAdapterTest.php b/src/Symfony/Component/Cache/Tests/Adapter/TagAwareAdapterTest.php
@@ -55,15 +55,15 @@ public function testInvalidateTags()
         $pool->save($i3->tag('foo')->tag('baz'));
         $pool->save($foo);
 
-        $pool->invalidateTags('bar');
+        $pool->invalidateTags(array('bar'));
 
         $this->assertFalse($pool->getItem('i0')->isHit());
         $this->assertTrue($pool->getItem('i1')->isHit());
         $this->assertFalse($pool->getItem('i2')->isHit());
         $this->assertTrue($pool->getItem('i3')->isHit());
         $this->assertTrue($pool->getItem('foo')->isHit());
 
-        $pool->invalidateTags('foo');
+        $pool->invalidateTags(array('foo'));
 
         $this->assertFalse($pool->getItem('i1')->isHit());
         $this->assertFalse($pool->getItem('i3')->isHit());
@@ -80,7 +80,7 @@ public function testTagsAreCleanedOnSave()
         $i = $pool->getItem('k');
         $pool->save($i->tag('bar'));
 
-        $pool->invalidateTags('foo');
+        $pool->invalidateTags(array('foo'));
         $this->assertTrue($pool->getItem('k')->isHit());
     }
 
@@ -93,7 +93,7 @@ public function testTagsAreCleanedOnDelete()
         $pool->deleteItem('k');
 
         $pool->save($pool->getItem('k'));
-        $pool->invalidateTags('foo');
+        $pool->invalidateTags(array('foo'));
 
         $this->assertTrue($pool->getItem('k')->isHit());
     }

Original file line number	Diff line number	Diff line change
`@@ -23,11 +23,11 @@ interface TagAwareAdapterInterface extends AdapterInterface`
`23`	`23`	`/**`
`24`	`24`	`* Invalidates cached items using tags.`
`25`	`25`	`*`
`26`		`- * @param string\|string[] $tags A tag or an array of tags to invalidate`
	`26`	`+ * @param string[] $tags An array of tags to invalidate`
`27`	`27`	`*`
`28`	`28`	`* @return bool True on success`
`29`	`29`	`*`
`30`	`30`	`* @throws InvalidArgumentException When $tags is not valid`
`31`	`31`	`*/`
`32`		`- public function invalidateTags($tags);`
	`32`	`+ public function invalidateTags(array $tags);`
`33`	`33`	`}`