feature #33516 [Cache] Added reserved characters constant for CacheItem (andyexeter)

fabpot · fabpot · commit 9c3345f38462 · 2019-09-11T06:59:36.000+02:00
This PR was squashed before being merged into the 4.4 branch (closes #33516). Discussion ---------- [Cache] Added reserved characters constant for CacheItem | Q | A | ------------- | --- | Branch? | 4.4  | Bug fix? | no | New feature? | no  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | N/A  | License | MIT | Doc PR | N/A  This PR introduces a `RESERVED_CHARACTERS` constant to the `CacheItem` class to keep things DRY. The rationale for making the constant public is so that developers can access the list of reserved characters so they could - for example - sanitise keys before passing them to the Cache component. Commits ------- d853306 [Cache] Added reserved characters constant for CacheItem
diff --git a/src/Symfony/Component/Cache/CacheItem.php b/src/Symfony/Component/Cache/CacheItem.php
@@ -129,8 +129,8 @@ public function tag($tags): ItemInterface
             if ('' === $tag) {
                 throw new InvalidArgumentException('Cache tag length must be greater than zero');
             }
-            if (false !== strpbrk($tag, '{}()/\@:')) {
-                throw new InvalidArgumentException(sprintf('Cache tag "%s" contains reserved characters {}()/\@:', $tag));
+            if (false !== strpbrk($tag, self::RESERVED_CHARACTERS)) {
+                throw new InvalidArgumentException(sprintf('Cache tag "%s" contains reserved characters %s', $tag, self::RESERVED_CHARACTERS));
             }
             $this->newMetadata[self::METADATA_TAGS][$tag] = $tag;
         }
@@ -173,8 +173,8 @@ public static function validateKey($key): string
         if ('' === $key) {
             throw new InvalidArgumentException('Cache key length must be greater than zero');
         }
-        if (false !== strpbrk($key, '{}()/\@:')) {
-            throw new InvalidArgumentException(sprintf('Cache key "%s" contains reserved characters {}()/\@:', $key));
+        if (false !== strpbrk($key, self::RESERVED_CHARACTERS)) {
+            throw new InvalidArgumentException(sprintf('Cache key "%s" contains reserved characters %s', $key, self::RESERVED_CHARACTERS));
         }
 
         return $key;
diff --git a/src/Symfony/Component/Cache/composer.json b/src/Symfony/Component/Cache/composer.json
@@ -24,7 +24,7 @@
         "php": "^7.1.3",
         "psr/cache": "~1.0",
         "psr/log": "~1.0",
-        "symfony/cache-contracts": "^1.1|^2",
+        "symfony/cache-contracts": "^1.1.7|^2",
         "symfony/service-contracts": "^1.1|^2",
         "symfony/var-exporter": "^4.2|^5.0"
     },
diff --git a/src/Symfony/Contracts/Cache/ItemInterface.php b/src/Symfony/Contracts/Cache/ItemInterface.php
@@ -37,6 +37,11 @@ interface ItemInterface extends CacheItemInterface
      */
     const METADATA_TAGS = 'tags';
 
+    /**
+     * Reserved characters that cannot be used in a key or tag.
+     */
+    const RESERVED_CHARACTERS = '{}()/\@:';
+
     /**
      * Adds a tag to a cache item.
      *

Original file line number	Diff line number	Diff line change
`@@ -129,8 +129,8 @@ public function tag($tags): ItemInterface`
`129`	`129`	`if ('' === $tag) {`
`130`	`130`	`throw new InvalidArgumentException('Cache tag length must be greater than zero');`
`131`	`131`	`}`
`132`		`- if (false !== strpbrk($tag, '{}()/\@:')) {`
`133`		`- throw new InvalidArgumentException(sprintf('Cache tag "%s" contains reserved characters {}()/\@:', $tag));`
	`132`	`+ if (false !== strpbrk($tag, self::RESERVED_CHARACTERS)) {`
	`133`	`+ throw new InvalidArgumentException(sprintf('Cache tag "%s" contains reserved characters %s', $tag, self::RESERVED_CHARACTERS));`
`134`	`134`	`}`
`135`	`135`	`$this->newMetadata[self::METADATA_TAGS][$tag] = $tag;`
`136`	`136`	`}`
`@@ -173,8 +173,8 @@ public static function validateKey($key): string`
`173`	`173`	`if ('' === $key) {`
`174`	`174`	`throw new InvalidArgumentException('Cache key length must be greater than zero');`
`175`	`175`	`}`
`176`		`- if (false !== strpbrk($key, '{}()/\@:')) {`
`177`		`- throw new InvalidArgumentException(sprintf('Cache key "%s" contains reserved characters {}()/\@:', $key));`
	`176`	`+ if (false !== strpbrk($key, self::RESERVED_CHARACTERS)) {`
	`177`	`+ throw new InvalidArgumentException(sprintf('Cache key "%s" contains reserved characters %s', $key, self::RESERVED_CHARACTERS));`
`178`	`178`	`}`
`179`	`179`
`180`	`180`	`return $key;`