Update handler docblocks

MGatner · MGatner · commit aeea6328a7e4 · 2021-05-01T12:51:44.000Z
diff --git a/system/Cache/Handlers/DummyHandler.php b/system/Cache/Handlers/DummyHandler.php
@@ -65,7 +65,7 @@ public function remember(string $key, int $ttl, Closure $callback)
 	 * @param mixed   $value The data to save
 	 * @param integer $ttl   Time To Live, in seconds (default 60)
 	 *
-	 * @return mixed
+	 * @return boolean Success or failure
 	 */
 	public function save(string $key, $value, int $ttl = 60)
 	{
@@ -79,7 +79,7 @@ public function save(string $key, $value, int $ttl = 60)
 	 *
 	 * @param string $key Cache item name
 	 *
-	 * @return boolean
+	 * @return boolean Success or failure
 	 */
 	public function delete(string $key)
 	{
@@ -135,7 +135,7 @@ public function decrement(string $key, int $offset = 1)
 	/**
 	 * Will delete all items in the entire cache.
 	 *
-	 * @return boolean
+	 * @return boolean Success or failure
 	 */
 	public function clean()
 	{
diff --git a/system/Cache/Handlers/FileHandler.php b/system/Cache/Handlers/FileHandler.php
@@ -111,7 +111,7 @@ public function get(string $key)
 	 * @param mixed   $value The data to save
 	 * @param integer $ttl   Time To Live, in seconds (default 60)
 	 *
-	 * @return mixed
+	 * @return boolean Success or failure
 	 */
 	public function save(string $key, $value, int $ttl = 60)
 	{
@@ -149,7 +149,7 @@ public function save(string $key, $value, int $ttl = 60)
 	 *
 	 * @param string $key Cache item name
 	 *
-	 * @return boolean
+	 * @return boolean Success or failure
 	 */
 	public function delete(string $key)
 	{
@@ -253,7 +253,7 @@ public function decrement(string $key, int $offset = 1)
 	/**
 	 * Will delete all items in the entire cache.
 	 *
-	 * @return boolean
+	 * @return boolean Success or failure
 	 */
 	public function clean()
 	{
diff --git a/system/Cache/Handlers/MemcachedHandler.php b/system/Cache/Handlers/MemcachedHandler.php
@@ -202,7 +202,7 @@ public function get(string $key)
 	 * @param mixed   $value The data to save
 	 * @param integer $ttl   Time To Live, in seconds (default 60)
 	 *
-	 * @return mixed
+	 * @return boolean Success or failure
 	 */
 	public function save(string $key, $value, int $ttl = 60)
 	{
@@ -238,7 +238,7 @@ public function save(string $key, $value, int $ttl = 60)
 	 *
 	 * @param string $key Cache item name
 	 *
-	 * @return boolean
+	 * @return boolean Success or failure
 	 */
 	public function delete(string $key)
 	{
@@ -313,7 +313,7 @@ public function decrement(string $key, int $offset = 1)
 	/**
 	 * Will delete all items in the entire cache.
 	 *
-	 * @return boolean
+	 * @return boolean Success or failure
 	 */
 	public function clean()
 	{
diff --git a/system/Cache/Handlers/PredisHandler.php b/system/Cache/Handlers/PredisHandler.php
@@ -138,7 +138,7 @@ public function get(string $key)
 	 * @param mixed   $value The data to save
 	 * @param integer $ttl   Time To Live, in seconds (default 60)
 	 *
-	 * @return mixed
+	 * @return boolean Success or failure
 	 */
 	public function save(string $key, $value, int $ttl = 60)
 	{
@@ -176,7 +176,7 @@ public function save(string $key, $value, int $ttl = 60)
 	 *
 	 * @param string $key Cache item name
 	 *
-	 * @return boolean
+	 * @return boolean Success or failure
 	 */
 	public function delete(string $key)
 	{
@@ -242,7 +242,7 @@ public function decrement(string $key, int $offset = 1)
 	/**
 	 * Will delete all items in the entire cache.
 	 *
-	 * @return boolean
+	 * @return boolean Success or failure
 	 */
 	public function clean()
 	{
diff --git a/system/Cache/Handlers/RedisHandler.php b/system/Cache/Handlers/RedisHandler.php
@@ -169,7 +169,7 @@ public function get(string $key)
 	 * @param mixed   $value The data to save
 	 * @param integer $ttl   Time To Live, in seconds (default 60)
 	 *
-	 * @return mixed
+	 * @return boolean Success or failure
 	 */
 	public function save(string $key, $value, int $ttl = 60)
 	{
@@ -212,7 +212,7 @@ public function save(string $key, $value, int $ttl = 60)
 	 *
 	 * @param string $key Cache item name
 	 *
-	 * @return boolean
+	 * @return boolean Success or failure
 	 */
 	public function delete(string $key)
 	{
@@ -288,7 +288,7 @@ public function decrement(string $key, int $offset = 1)
 	/**
 	 * Will delete all items in the entire cache.
 	 *
-	 * @return boolean
+	 * @return boolean Success or failure
 	 */
 	public function clean()
 	{
diff --git a/system/Cache/Handlers/WincacheHandler.php b/system/Cache/Handlers/WincacheHandler.php
@@ -83,7 +83,7 @@ public function get(string $key)
 	 * @param mixed   $value The data to save
 	 * @param integer $ttl   Time To Live, in seconds (default 60)
 	 *
-	 * @return mixed
+	 * @return boolean Success or failure
 	 *
 	 * @codeCoverageIgnore
 	 */
@@ -101,7 +101,7 @@ public function save(string $key, $value, int $ttl = 60)
 	 *
 	 * @param string $key Cache item name
 	 *
-	 * @return boolean
+	 * @return boolean Success or failure
 	 *
 	 * @codeCoverageIgnore
 	 */
@@ -179,7 +179,7 @@ public function decrement(string $key, int $offset = 1)
 	 *
 	 * @return boolean
 	 *
-	 * @codeCoverageIgnore
+	 * @boolean Success or failure
 	 */
 	public function clean()
 	{

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public function remember(string $key, int $ttl, Closure $callback)`
`65`	`65`	`* @param mixed $value The data to save`
`66`	`66`	`* @param integer $ttl Time To Live, in seconds (default 60)`
`67`	`67`	`*`
`68`		`- * @return mixed`
	`68`	`+ * @return boolean Success or failure`
`69`	`69`	`*/`
`70`	`70`	`public function save(string $key, $value, int $ttl = 60)`
`71`	`71`	`{`
`@@ -79,7 +79,7 @@ public function save(string $key, $value, int $ttl = 60)`
`79`	`79`	`*`
`80`	`80`	`* @param string $key Cache item name`
`81`	`81`	`*`
`82`		`- * @return boolean`
	`82`	`+ * @return boolean Success or failure`
`83`	`83`	`*/`
`84`	`84`	`public function delete(string $key)`
`85`	`85`	`{`
`@@ -135,7 +135,7 @@ public function decrement(string $key, int $offset = 1)`
`135`	`135`	`/**`
`136`	`136`	`* Will delete all items in the entire cache.`
`137`	`137`	`*`
`138`		`- * @return boolean`
	`138`	`+ * @return boolean Success or failure`
`139`	`139`	`*/`
`140`	`140`	`public function clean()`
`141`	`141`	`{`
Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ public function get(string $key)`
`111`	`111`	`* @param mixed $value The data to save`
`112`	`112`	`* @param integer $ttl Time To Live, in seconds (default 60)`
`113`	`113`	`*`
`114`		`- * @return mixed`
	`114`	`+ * @return boolean Success or failure`
`115`	`115`	`*/`
`116`	`116`	`public function save(string $key, $value, int $ttl = 60)`
`117`	`117`	`{`
`@@ -149,7 +149,7 @@ public function save(string $key, $value, int $ttl = 60)`
`149`	`149`	`*`
`150`	`150`	`* @param string $key Cache item name`
`151`	`151`	`*`
`152`		`- * @return boolean`
	`152`	`+ * @return boolean Success or failure`
`153`	`153`	`*/`
`154`	`154`	`public function delete(string $key)`
`155`	`155`	`{`
`@@ -253,7 +253,7 @@ public function decrement(string $key, int $offset = 1)`
`253`	`253`	`/**`
`254`	`254`	`* Will delete all items in the entire cache.`
`255`	`255`	`*`
`256`		`- * @return boolean`
	`256`	`+ * @return boolean Success or failure`
`257`	`257`	`*/`
`258`	`258`	`public function clean()`
`259`	`259`	`{`
Original file line number	Diff line number	Diff line change
`@@ -202,7 +202,7 @@ public function get(string $key)`
`202`	`202`	`* @param mixed $value The data to save`
`203`	`203`	`* @param integer $ttl Time To Live, in seconds (default 60)`
`204`	`204`	`*`
`205`		`- * @return mixed`
	`205`	`+ * @return boolean Success or failure`
`206`	`206`	`*/`
`207`	`207`	`public function save(string $key, $value, int $ttl = 60)`
`208`	`208`	`{`
`@@ -238,7 +238,7 @@ public function save(string $key, $value, int $ttl = 60)`
`238`	`238`	`*`
`239`	`239`	`* @param string $key Cache item name`
`240`	`240`	`*`
`241`		`- * @return boolean`
	`241`	`+ * @return boolean Success or failure`
`242`	`242`	`*/`
`243`	`243`	`public function delete(string $key)`
`244`	`244`	`{`
`@@ -313,7 +313,7 @@ public function decrement(string $key, int $offset = 1)`
`313`	`313`	`/**`
`314`	`314`	`* Will delete all items in the entire cache.`
`315`	`315`	`*`
`316`		`- * @return boolean`
	`316`	`+ * @return boolean Success or failure`
`317`	`317`	`*/`
`318`	`318`	`public function clean()`
`319`	`319`	`{`
Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,7 @@ public function get(string $key)`
`138`	`138`	`* @param mixed $value The data to save`
`139`	`139`	`* @param integer $ttl Time To Live, in seconds (default 60)`
`140`	`140`	`*`
`141`		`- * @return mixed`
	`141`	`+ * @return boolean Success or failure`
`142`	`142`	`*/`
`143`	`143`	`public function save(string $key, $value, int $ttl = 60)`
`144`	`144`	`{`
`@@ -176,7 +176,7 @@ public function save(string $key, $value, int $ttl = 60)`
`176`	`176`	`*`
`177`	`177`	`* @param string $key Cache item name`
`178`	`178`	`*`
`179`		`- * @return boolean`
	`179`	`+ * @return boolean Success or failure`
`180`	`180`	`*/`
`181`	`181`	`public function delete(string $key)`
`182`	`182`	`{`
`@@ -242,7 +242,7 @@ public function decrement(string $key, int $offset = 1)`
`242`	`242`	`/**`
`243`	`243`	`* Will delete all items in the entire cache.`
`244`	`244`	`*`
`245`		`- * @return boolean`
	`245`	`+ * @return boolean Success or failure`
`246`	`246`	`*/`
`247`	`247`	`public function clean()`
`248`	`248`	`{`
Original file line number	Diff line number	Diff line change
`@@ -169,7 +169,7 @@ public function get(string $key)`
`169`	`169`	`* @param mixed $value The data to save`
`170`	`170`	`* @param integer $ttl Time To Live, in seconds (default 60)`
`171`	`171`	`*`
`172`		`- * @return mixed`
	`172`	`+ * @return boolean Success or failure`
`173`	`173`	`*/`
`174`	`174`	`public function save(string $key, $value, int $ttl = 60)`
`175`	`175`	`{`
`@@ -212,7 +212,7 @@ public function save(string $key, $value, int $ttl = 60)`
`212`	`212`	`*`
`213`	`213`	`* @param string $key Cache item name`
`214`	`214`	`*`
`215`		`- * @return boolean`
	`215`	`+ * @return boolean Success or failure`
`216`	`216`	`*/`
`217`	`217`	`public function delete(string $key)`
`218`	`218`	`{`
`@@ -288,7 +288,7 @@ public function decrement(string $key, int $offset = 1)`
`288`	`288`	`/**`
`289`	`289`	`* Will delete all items in the entire cache.`
`290`	`290`	`*`
`291`		`- * @return boolean`
	`291`	`+ * @return boolean Success or failure`
`292`	`292`	`*/`
`293`	`293`	`public function clean()`
`294`	`294`	`{`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ public function get(string $key)`
`83`	`83`	`* @param mixed $value The data to save`
`84`	`84`	`* @param integer $ttl Time To Live, in seconds (default 60)`
`85`	`85`	`*`
`86`		`- * @return mixed`
	`86`	`+ * @return boolean Success or failure`
`87`	`87`	`*`
`88`	`88`	`* @codeCoverageIgnore`
`89`	`89`	`*/`
`@@ -101,7 +101,7 @@ public function save(string $key, $value, int $ttl = 60)`
`101`	`101`	`*`
`102`	`102`	`* @param string $key Cache item name`
`103`	`103`	`*`
`104`		`- * @return boolean`
	`104`	`+ * @return boolean Success or failure`
`105`	`105`	`*`
`106`	`106`	`* @codeCoverageIgnore`
`107`	`107`	`*/`
`@@ -179,7 +179,7 @@ public function decrement(string $key, int $offset = 1)`
`179`	`179`	`*`
`180`	`180`	`* @return boolean`
`181`	`181`	`*`
`182`		`- * @codeCoverageIgnore`
	`182`	`+ * @boolean Success or failure`
`183`	`183`	`*/`
`184`	`184`	`public function clean()`
`185`	`185`	`{`