bug #29591 [Cache] Fix undefined variable in ArrayTrait (eXtreme)

nicolas-grekas · nicolas-grekas · commit ec49aa1767b4 · 2018-12-13T14:38:51.000+01:00
This PR was merged into the 4.2 branch. Discussion ---------- [Cache] Fix undefined variable in ArrayTrait | Q | A | ------------- | --- | Branch? | 4.2 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | | License | MIT | Doc PR | After upgrading my project to 4.2 my tests failed with a message that `$key` variable is missing here: https://github.com/symfony/symfony/blob/e81285249b780a11ed209a79fa77c1f6ea6da67b/src/Symfony/Component/Cache/Traits/ArrayTrait.php#L131 which seems to be introduced with PR symfony/symfony#27563. So I added that variable to the trait and method calls (are there any other?). This is internal class so I guess noone is using it anywhere. Anyway, my tests pass with this fix. Commits ------- b0b5937d1d Fix undefined variable in cache ArrayTrait
diff --git a/Adapter/ArrayAdapter.php b/Adapter/ArrayAdapter.php
@@ -124,7 +124,7 @@ public function save(CacheItemInterface $item)
 
             return true;
         }
-        if ($this->storeSerialized && null === $value = $this->freeze($value)) {
+        if ($this->storeSerialized && null === $value = $this->freeze($value, $key)) {
             return false;
         }
         if (null === $expiry && 0 < $item["\0*\0defaultLifetime"]) {
diff --git a/Simple/ArrayCache.php b/Simple/ArrayCache.php
@@ -129,7 +129,7 @@ public function setMultiple($values, $ttl = null)
         $expiry = 0 < $ttl ? microtime(true) + $ttl : PHP_INT_MAX;
 
         foreach ($valuesArray as $key => $value) {
-            if ($this->storeSerialized && null === $value = $this->freeze($value)) {
+            if ($this->storeSerialized && null === $value = $this->freeze($value, $key)) {
                 return false;
             }
             $this->values[$key] = $value;
diff --git a/Traits/ArrayTrait.php b/Traits/ArrayTrait.php
@@ -113,7 +113,7 @@ private function generateItems(array $keys, $now, $f)
         }
     }
 
-    private function freeze($value)
+    private function freeze($value, $key)
     {
         if (null === $value) {
             return 'N;';

Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ public function save(CacheItemInterface $item)`
`124`	`124`
`125`	`125`	`return true;`
`126`	`126`	`}`
`127`		`- if ($this->storeSerialized && null === $value = $this->freeze($value)) {`
	`127`	`+ if ($this->storeSerialized && null === $value = $this->freeze($value, $key)) {`
`128`	`128`	`return false;`
`129`	`129`	`}`
`130`	`130`	`if (null === $expiry && 0 < $item["\0*\0defaultLifetime"]) {`
Original file line number	Diff line number	Diff line change
`@@ -129,7 +129,7 @@ public function setMultiple($values, $ttl = null)`
`129`	`129`	`$expiry = 0 < $ttl ? microtime(true) + $ttl : PHP_INT_MAX;`
`130`	`130`
`131`	`131`	`foreach ($valuesArray as $key => $value) {`
`132`		`- if ($this->storeSerialized && null === $value = $this->freeze($value)) {`
	`132`	`+ if ($this->storeSerialized && null === $value = $this->freeze($value, $key)) {`
`133`	`133`	`return false;`
`134`	`134`	`}`
`135`	`135`	`$this->values[$key] = $value;`
Original file line number	Diff line number	Diff line change
`@@ -113,7 +113,7 @@ private function generateItems(array $keys, $now, $f)`
`113`	`113`	`}`
`114`	`114`	`}`
`115`	`115`
`116`		`- private function freeze($value)`
	`116`	`+ private function freeze($value, $key)`
`117`	`117`	`{`
`118`	`118`	`if (null === $value) {`
`119`	`119`	`return 'N;';`