Merge pull request #4635 from paulbalandan/cache-handler-optimize

paulbalandan · web-flow · commit 50a1e8b3f514 · 2021-05-02T21:16:16.000+08:00
[Cache] Allow covariant returns and optimize code
diff --git a/system/Cache/Handlers/DummyHandler.php b/system/Cache/Handlers/DummyHandler.php
@@ -23,7 +23,6 @@ class DummyHandler extends BaseHandler
 	 */
 	public function initialize()
 	{
-		// Nothing to see here...
 	}
 
 	//--------------------------------------------------------------------
@@ -33,7 +32,7 @@ public function initialize()
 	 *
 	 * @param string $key Cache item name
 	 *
-	 * @return mixed
+	 * @return null
 	 */
 	public function get(string $key)
 	{
@@ -49,7 +48,7 @@ public function get(string $key)
 	 * @param integer $ttl      Time to live
 	 * @param Closure $callback Callback return value
 	 *
-	 * @return mixed
+	 * @return null
 	 */
 	public function remember(string $key, int $ttl, Closure $callback)
 	{
@@ -108,7 +107,7 @@ public function deleteMatching(string $pattern)
 	 * @param string  $key    Cache ID
 	 * @param integer $offset Step/value to increase by
 	 *
-	 * @return mixed
+	 * @return boolean
 	 */
 	public function increment(string $key, int $offset = 1)
 	{
@@ -123,7 +122,7 @@ public function increment(string $key, int $offset = 1)
 	 * @param string  $key    Cache ID
 	 * @param integer $offset Step/value to increase by
 	 *
-	 * @return mixed
+	 * @return boolean
 	 */
 	public function decrement(string $key, int $offset = 1)
 	{
@@ -150,7 +149,7 @@ public function clean()
 	 * The information returned and the structure of the data
 	 * varies depending on the handler.
 	 *
-	 * @return mixed
+	 * @return null
 	 */
 	public function getCacheInfo()
 	{
@@ -164,7 +163,7 @@ public function getCacheInfo()
 	 *
 	 * @param string $key Cache item name.
 	 *
-	 * @return mixed
+	 * @return null
 	 */
 	public function getMetaData(string $key)
 	{
@@ -182,6 +181,4 @@ public function isSupported(): bool
 	{
 		return true;
 	}
-
-	//--------------------------------------------------------------------
 }
diff --git a/system/Cache/Handlers/FileHandler.php b/system/Cache/Handlers/FileHandler.php
@@ -71,7 +71,7 @@ public function __construct(Cache $config)
 		}
 
 		$this->mode   = $config->file['mode'] ?? 0640;
-		$this->prefix = (string) $config->prefix;
+		$this->prefix = $config->prefix;
 	}
 
 	//--------------------------------------------------------------------
@@ -81,7 +81,6 @@ public function __construct(Cache $config)
 	 */
 	public function initialize()
 	{
-		// Not to see here...
 	}
 
 	//--------------------------------------------------------------------
@@ -190,7 +189,7 @@ public function deleteMatching(string $pattern)
 	 * @param string  $key    Cache ID
 	 * @param integer $offset Step/value to increase by
 	 *
-	 * @return mixed
+	 * @return boolean
 	 */
 	public function increment(string $key, int $offset = 1)
 	{
@@ -223,7 +222,7 @@ public function increment(string $key, int $offset = 1)
 	 * @param string  $key    Cache ID
 	 * @param integer $offset Step/value to increase by
 	 *
-	 * @return mixed
+	 * @return bool
 	 */
 	public function decrement(string $key, int $offset = 1)
 	{
@@ -268,7 +267,7 @@ public function clean()
 	 * The information returned and the structure of the data
 	 * varies depending on the handler.
 	 *
-	 * @return mixed
+	 * @return array|false
 	 */
 	public function getCacheInfo()
 	{
@@ -534,6 +533,8 @@ protected function getFileInfo(string $file, $returnedValues = ['name', 'server_
 			$returnedValues = explode(',', $returnedValues);
 		}
 
+		$fileInfo = [];
+
 		foreach ($returnedValues as $key)
 		{
 			switch ($key)
@@ -565,8 +566,6 @@ protected function getFileInfo(string $file, $returnedValues = ['name', 'server_
 			}
 		}
 
-		return $fileInfo; // @phpstan-ignore-line
+		return $fileInfo;
 	}
-
-	//--------------------------------------------------------------------
 }
diff --git a/system/Cache/Handlers/MemcachedHandler.php b/system/Cache/Handlers/MemcachedHandler.php
@@ -57,7 +57,7 @@ class MemcachedHandler extends BaseHandler
 	 */
 	public function __construct(Cache $config)
 	{
-		$this->prefix = (string) $config->prefix;
+		$this->prefix = $config->prefix;
 
 		if (! empty($config))
 		{
@@ -269,7 +269,7 @@ public function deleteMatching(string $pattern)
 	 * @param string  $key    Cache ID
 	 * @param integer $offset Step/value to increase by
 	 *
-	 * @return mixed
+	 * @return integer|false
 	 */
 	public function increment(string $key, int $offset = 1)
 	{
@@ -292,7 +292,7 @@ public function increment(string $key, int $offset = 1)
 	 * @param string  $key    Cache ID
 	 * @param integer $offset Step/value to increase by
 	 *
-	 * @return mixed
+	 * @return integer|false
 	 */
 	public function decrement(string $key, int $offset = 1)
 	{
@@ -328,7 +328,7 @@ public function clean()
 	 * The information returned and the structure of the data
 	 * varies depending on the handler.
 	 *
-	 * @return mixed
+	 * @return array|false
 	 */
 	public function getCacheInfo()
 	{
@@ -380,6 +380,6 @@ public function getMetaData(string $key)
 	 */
 	public function isSupported(): bool
 	{
-		return (extension_loaded('memcached') || extension_loaded('memcache'));
+		return extension_loaded('memcached') || extension_loaded('memcache');
 	}
 }
diff --git a/system/Cache/Handlers/PredisHandler.php b/system/Cache/Handlers/PredisHandler.php
@@ -58,7 +58,7 @@ class PredisHandler extends BaseHandler
 	 */
 	public function __construct(Cache $config)
 	{
-		$this->prefix = (string) $config->prefix;
+		$this->prefix = $config->prefix;
 
 		if (isset($config->redis))
 		{
@@ -101,10 +101,9 @@ public function initialize()
 	 */
 	public function get(string $key)
 	{
-		$data = array_combine([
-			'__ci_type',
-			'__ci_value',
-		], $this->redis->hmget($key, ['__ci_type', '__ci_value'])
+		$data = array_combine(
+			['__ci_type', '__ci_value'],
+			$this->redis->hmget($key, ['__ci_type', '__ci_value'])
 		);
 
 		if (! isset($data['__ci_type'], $data['__ci_value']) || $data['__ci_value'] === false)
@@ -180,7 +179,7 @@ public function save(string $key, $value, int $ttl = 60)
 	 */
 	public function delete(string $key)
 	{
-		return ($this->redis->del($key) === 1);
+		return $this->redis->del($key) === 1;
 	}
 
 	//--------------------------------------------------------------------
@@ -194,7 +193,6 @@ public function delete(string $key)
 	 */
 	public function deleteMatching(string $pattern)
 	{
-		$deleted = 0;
 		$matchedKeys = [];
 
 		foreach (new Keyspace($this->redis, $pattern) as $key)
@@ -213,7 +211,7 @@ public function deleteMatching(string $pattern)
 	 * @param string  $key    Cache ID
 	 * @param integer $offset Step/value to increase by
 	 *
-	 * @return mixed
+	 * @return integer
 	 */
 	public function increment(string $key, int $offset = 1)
 	{
@@ -228,7 +226,7 @@ public function increment(string $key, int $offset = 1)
 	 * @param string  $key    Cache ID
 	 * @param integer $offset Step/value to increase by
 	 *
-	 * @return mixed
+	 * @return integer
 	 */
 	public function decrement(string $key, int $offset = 1)
 	{
@@ -255,7 +253,7 @@ public function clean()
 	 * The information returned and the structure of the data
 	 * varies depending on the handler.
 	 *
-	 * @return mixed
+	 * @return array
 	 */
 	public function getCacheInfo()
 	{
diff --git a/system/Cache/Handlers/RedisHandler.php b/system/Cache/Handlers/RedisHandler.php
@@ -57,7 +57,7 @@ class RedisHandler extends BaseHandler
 	 */
 	public function __construct(Cache $config)
 	{
-		$this->prefix = (string) $config->prefix;
+		$this->prefix = $config->prefix;
 
 		if (! empty($config))
 		{
@@ -72,7 +72,7 @@ public function __construct(Cache $config)
 	 */
 	public function __destruct()
 	{
-		if ($this->redis) // @phpstan-ignore-line
+		if (isset($this->redis))
 		{
 			$this->redis->close();
 		}
@@ -218,7 +218,7 @@ public function delete(string $key)
 	{
 		$key = $this->prefix . $key;
 
-		return ($this->redis->del($key) === 1);
+		return $this->redis->del($key) === 1;
 	}
 
 	//--------------------------------------------------------------------
@@ -262,7 +262,7 @@ public function deleteMatching(string $pattern)
 	 * @param string  $key    Cache ID
 	 * @param integer $offset Step/value to increase by
 	 *
-	 * @return mixed
+	 * @return integer
 	 */
 	public function increment(string $key, int $offset = 1)
 	{
@@ -279,7 +279,7 @@ public function increment(string $key, int $offset = 1)
 	 * @param string  $key    Cache ID
 	 * @param integer $offset Step/value to increase by
 	 *
-	 * @return mixed
+	 * @return integer
 	 */
 	public function decrement(string $key, int $offset = 1)
 	{
@@ -308,7 +308,7 @@ public function clean()
 	 * The information returned and the structure of the data
 	 * varies depending on the handler.
 	 *
-	 * @return mixed
+	 * @return array
 	 */
 	public function getCacheInfo()
 	{
@@ -358,6 +358,4 @@ public function isSupported(): bool
 	{
 		return extension_loaded('redis');
 	}
-
-	//--------------------------------------------------------------------
 }
diff --git a/system/Cache/Handlers/WincacheHandler.php b/system/Cache/Handlers/WincacheHandler.php

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,6 @@ class DummyHandler extends BaseHandler`
`23`	`23`	`*/`
`24`	`24`	`public function initialize()`
`25`	`25`	`{`
`26`		`- // Nothing to see here...`
`27`	`26`	`}`
`28`	`27`
`29`	`28`	`//--------------------------------------------------------------------`
`@@ -33,7 +32,7 @@ public function initialize()`
`33`	`32`	`*`
`34`	`33`	`* @param string $key Cache item name`
`35`	`34`	`*`
`36`		`- * @return mixed`
	`35`	`+ * @return null`
`37`	`36`	`*/`
`38`	`37`	`public function get(string $key)`
`39`	`38`	`{`
`@@ -49,7 +48,7 @@ public function get(string $key)`
`49`	`48`	`* @param integer $ttl Time to live`
`50`	`49`	`* @param Closure $callback Callback return value`
`51`	`50`	`*`
`52`		`- * @return mixed`
	`51`	`+ * @return null`
`53`	`52`	`*/`
`54`	`53`	`public function remember(string $key, int $ttl, Closure $callback)`
`55`	`54`	`{`
`@@ -108,7 +107,7 @@ public function deleteMatching(string $pattern)`
`108`	`107`	`* @param string $key Cache ID`
`109`	`108`	`* @param integer $offset Step/value to increase by`
`110`	`109`	`*`
`111`		`- * @return mixed`
	`110`	`+ * @return boolean`
`112`	`111`	`*/`
`113`	`112`	`public function increment(string $key, int $offset = 1)`
`114`	`113`	`{`
`@@ -123,7 +122,7 @@ public function increment(string $key, int $offset = 1)`
`123`	`122`	`* @param string $key Cache ID`
`124`	`123`	`* @param integer $offset Step/value to increase by`
`125`	`124`	`*`
`126`		`- * @return mixed`
	`125`	`+ * @return boolean`
`127`	`126`	`*/`
`128`	`127`	`public function decrement(string $key, int $offset = 1)`
`129`	`128`	`{`
`@@ -150,7 +149,7 @@ public function clean()`
`150`	`149`	`* The information returned and the structure of the data`
`151`	`150`	`* varies depending on the handler.`
`152`	`151`	`*`
`153`		`- * @return mixed`
	`152`	`+ * @return null`
`154`	`153`	`*/`
`155`	`154`	`public function getCacheInfo()`
`156`	`155`	`{`
`@@ -164,7 +163,7 @@ public function getCacheInfo()`
`164`	`163`	`*`
`165`	`164`	`* @param string $key Cache item name.`
`166`	`165`	`*`
`167`		`- * @return mixed`
	`166`	`+ * @return null`
`168`	`167`	`*/`
`169`	`168`	`public function getMetaData(string $key)`
`170`	`169`	`{`
`@@ -182,6 +181,4 @@ public function isSupported(): bool`
`182`	`181`	`{`
`183`	`182`	`return true;`
`184`	`183`	`}`
`185`		`-`
`186`		`- //--------------------------------------------------------------------`
`187`	`184`	`}`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ public function __construct(Cache $config)`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`$this->mode = $config->file['mode'] ?? 0640;`
`74`		`- $this->prefix = (string) $config->prefix;`
	`74`	`+ $this->prefix = $config->prefix;`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`//--------------------------------------------------------------------`
`@@ -81,7 +81,6 @@ public function __construct(Cache $config)`
`81`	`81`	`*/`
`82`	`82`	`public function initialize()`
`83`	`83`	`{`
`84`		`- // Not to see here...`
`85`	`84`	`}`
`86`	`85`
`87`	`86`	`//--------------------------------------------------------------------`
`@@ -190,7 +189,7 @@ public function deleteMatching(string $pattern)`
`190`	`189`	`* @param string $key Cache ID`
`191`	`190`	`* @param integer $offset Step/value to increase by`
`192`	`191`	`*`
`193`		`- * @return mixed`
	`192`	`+ * @return boolean`
`194`	`193`	`*/`
`195`	`194`	`public function increment(string $key, int $offset = 1)`
`196`	`195`	`{`
`@@ -223,7 +222,7 @@ public function increment(string $key, int $offset = 1)`
`223`	`222`	`* @param string $key Cache ID`
`224`	`223`	`* @param integer $offset Step/value to increase by`
`225`	`224`	`*`
`226`		`- * @return mixed`
	`225`	`+ * @return bool`
`227`	`226`	`*/`
`228`	`227`	`public function decrement(string $key, int $offset = 1)`
`229`	`228`	`{`
`@@ -268,7 +267,7 @@ public function clean()`
`268`	`267`	`* The information returned and the structure of the data`
`269`	`268`	`* varies depending on the handler.`
`270`	`269`	`*`
`271`		`- * @return mixed`
	`270`	`+ * @return array\|false`
`272`	`271`	`*/`
`273`	`272`	`public function getCacheInfo()`
`274`	`273`	`{`
`@@ -534,6 +533,8 @@ protected function getFileInfo(string $file, $returnedValues = ['name', 'server_`
`534`	`533`	`$returnedValues = explode(',', $returnedValues);`
`535`	`534`	`}`
`536`	`535`
	`536`	`+ $fileInfo = [];`
	`537`	`+`
`537`	`538`	`foreach ($returnedValues as $key)`
`538`	`539`	`{`
`539`	`540`	`switch ($key)`
`@@ -565,8 +566,6 @@ protected function getFileInfo(string $file, $returnedValues = ['name', 'server_`
`565`	`566`	`}`
`566`	`567`	`}`
`567`	`568`
`568`		`- return $fileInfo; // @phpstan-ignore-line`
	`569`	`+ return $fileInfo;`
`569`	`570`	`}`
`570`		`-`
`571`		`- //--------------------------------------------------------------------`
`572`	`571`	`}`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ class MemcachedHandler extends BaseHandler`
`57`	`57`	`*/`
`58`	`58`	`public function __construct(Cache $config)`
`59`	`59`	`{`
`60`		`- $this->prefix = (string) $config->prefix;`
	`60`	`+ $this->prefix = $config->prefix;`
`61`	`61`
`62`	`62`	`if (! empty($config))`
`63`	`63`	`{`
`@@ -269,7 +269,7 @@ public function deleteMatching(string $pattern)`
`269`	`269`	`* @param string $key Cache ID`
`270`	`270`	`* @param integer $offset Step/value to increase by`
`271`	`271`	`*`
`272`		`- * @return mixed`
	`272`	`+ * @return integer\|false`
`273`	`273`	`*/`
`274`	`274`	`public function increment(string $key, int $offset = 1)`
`275`	`275`	`{`
`@@ -292,7 +292,7 @@ public function increment(string $key, int $offset = 1)`
`292`	`292`	`* @param string $key Cache ID`
`293`	`293`	`* @param integer $offset Step/value to increase by`
`294`	`294`	`*`
`295`		`- * @return mixed`
	`295`	`+ * @return integer\|false`
`296`	`296`	`*/`
`297`	`297`	`public function decrement(string $key, int $offset = 1)`
`298`	`298`	`{`
`@@ -328,7 +328,7 @@ public function clean()`
`328`	`328`	`* The information returned and the structure of the data`
`329`	`329`	`* varies depending on the handler.`
`330`	`330`	`*`
`331`		`- * @return mixed`
	`331`	`+ * @return array\|false`
`332`	`332`	`*/`
`333`	`333`	`public function getCacheInfo()`
`334`	`334`	`{`
`@@ -380,6 +380,6 @@ public function getMetaData(string $key)`
`380`	`380`	`*/`
`381`	`381`	`public function isSupported(): bool`
`382`	`382`	`{`
`383`		`- return (extension_loaded('memcached') \|\| extension_loaded('memcache'));`
	`383`	`+ return extension_loaded('memcached') \|\| extension_loaded('memcache');`
`384`	`384`	`}`
`385`	`385`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ class PredisHandler extends BaseHandler`
`58`	`58`	`*/`
`59`	`59`	`public function __construct(Cache $config)`
`60`	`60`	`{`
`61`		`- $this->prefix = (string) $config->prefix;`
	`61`	`+ $this->prefix = $config->prefix;`
`62`	`62`
`63`	`63`	`if (isset($config->redis))`
`64`	`64`	`{`
`@@ -101,10 +101,9 @@ public function initialize()`
`101`	`101`	`*/`
`102`	`102`	`public function get(string $key)`
`103`	`103`	`{`
`104`		`- $data = array_combine([`
`105`		`- '__ci_type',`
`106`		`- '__ci_value',`
`107`		`- ], $this->redis->hmget($key, ['__ci_type', '__ci_value'])`
	`104`	`+ $data = array_combine(`
	`105`	`+ ['__ci_type', '__ci_value'],`
	`106`	`+ $this->redis->hmget($key, ['__ci_type', '__ci_value'])`
`108`	`107`	`);`
`109`	`108`
`110`	`109`	`if (! isset($data['__ci_type'], $data['__ci_value']) \|\| $data['__ci_value'] === false)`
`@@ -180,7 +179,7 @@ public function save(string $key, $value, int $ttl = 60)`
`180`	`179`	`*/`
`181`	`180`	`public function delete(string $key)`
`182`	`181`	`{`
`183`		`- return ($this->redis->del($key) === 1);`
	`182`	`+ return $this->redis->del($key) === 1;`
`184`	`183`	`}`
`185`	`184`
`186`	`185`	`//--------------------------------------------------------------------`
`@@ -194,7 +193,6 @@ public function delete(string $key)`
`194`	`193`	`*/`
`195`	`194`	`public function deleteMatching(string $pattern)`
`196`	`195`	`{`
`197`		`- $deleted = 0;`
`198`	`196`	`$matchedKeys = [];`
`199`	`197`
`200`	`198`	`foreach (new Keyspace($this->redis, $pattern) as $key)`
`@@ -213,7 +211,7 @@ public function deleteMatching(string $pattern)`
`213`	`211`	`* @param string $key Cache ID`
`214`	`212`	`* @param integer $offset Step/value to increase by`
`215`	`213`	`*`
`216`		`- * @return mixed`
	`214`	`+ * @return integer`
`217`	`215`	`*/`
`218`	`216`	`public function increment(string $key, int $offset = 1)`
`219`	`217`	`{`
`@@ -228,7 +226,7 @@ public function increment(string $key, int $offset = 1)`
`228`	`226`	`* @param string $key Cache ID`
`229`	`227`	`* @param integer $offset Step/value to increase by`
`230`	`228`	`*`
`231`		`- * @return mixed`
	`229`	`+ * @return integer`
`232`	`230`	`*/`
`233`	`231`	`public function decrement(string $key, int $offset = 1)`
`234`	`232`	`{`
`@@ -255,7 +253,7 @@ public function clean()`
`255`	`253`	`* The information returned and the structure of the data`
`256`	`254`	`* varies depending on the handler.`
`257`	`255`	`*`
`258`		`- * @return mixed`
	`256`	`+ * @return array`
`259`	`257`	`*/`
`260`	`258`	`public function getCacheInfo()`
`261`	`259`	`{`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ class RedisHandler extends BaseHandler`
`57`	`57`	`*/`
`58`	`58`	`public function __construct(Cache $config)`
`59`	`59`	`{`
`60`		`- $this->prefix = (string) $config->prefix;`
	`60`	`+ $this->prefix = $config->prefix;`
`61`	`61`
`62`	`62`	`if (! empty($config))`
`63`	`63`	`{`
`@@ -72,7 +72,7 @@ public function __construct(Cache $config)`
`72`	`72`	`*/`
`73`	`73`	`public function __destruct()`
`74`	`74`	`{`
`75`		`- if ($this->redis) // @phpstan-ignore-line`
	`75`	`+ if (isset($this->redis))`
`76`	`76`	`{`
`77`	`77`	`$this->redis->close();`
`78`	`78`	`}`
`@@ -218,7 +218,7 @@ public function delete(string $key)`
`218`	`218`	`{`
`219`	`219`	`$key = $this->prefix . $key;`
`220`	`220`
`221`		`- return ($this->redis->del($key) === 1);`
	`221`	`+ return $this->redis->del($key) === 1;`
`222`	`222`	`}`
`223`	`223`
`224`	`224`	`//--------------------------------------------------------------------`
`@@ -262,7 +262,7 @@ public function deleteMatching(string $pattern)`
`262`	`262`	`* @param string $key Cache ID`
`263`	`263`	`* @param integer $offset Step/value to increase by`
`264`	`264`	`*`
`265`		`- * @return mixed`
	`265`	`+ * @return integer`
`266`	`266`	`*/`
`267`	`267`	`public function increment(string $key, int $offset = 1)`
`268`	`268`	`{`
`@@ -279,7 +279,7 @@ public function increment(string $key, int $offset = 1)`
`279`	`279`	`* @param string $key Cache ID`
`280`	`280`	`* @param integer $offset Step/value to increase by`
`281`	`281`	`*`
`282`		`- * @return mixed`
	`282`	`+ * @return integer`
`283`	`283`	`*/`
`284`	`284`	`public function decrement(string $key, int $offset = 1)`
`285`	`285`	`{`
`@@ -308,7 +308,7 @@ public function clean()`
`308`	`308`	`* The information returned and the structure of the data`
`309`	`309`	`* varies depending on the handler.`
`310`	`310`	`*`
`311`		`- * @return mixed`
	`311`	`+ * @return array`
`312`	`312`	`*/`
`313`	`313`	`public function getCacheInfo()`
`314`	`314`	`{`
`@@ -358,6 +358,4 @@ public function isSupported(): bool`
`358`	`358`	`{`
`359`	`359`	`return extension_loaded('redis');`
`360`	`360`	`}`
`361`		`-`
`362`		`- //--------------------------------------------------------------------`
`363`	`361`	`}`