PHP 8.1 | WP_CLI\Iterators\CSV: fix "missing return type" deprecation warnings

jrfnl · jrfnl · commit 6ed0b4f6c08c · 2024-09-17T17:54:28.000+02:00
As of PHP 8.1, PHP started throwing deprecation warnings along the lines of: ``` Deprecated: Return type of [CLASS]::[METHOD]() should either be compatible with [PHP NATIVE INTERFACE]::[METHOD](): [TYPE], or the #[ReturnTypeWillChange] attribute should be used to temporarily suppress the notice ``` These type of deprecation notices relate to the [Return types for internal methods RFC](https://wiki.php.net/rfc/internal_method_return_types) in PHP 8.1. Basically, as of PHP 8.1, these methods in classes which implement PHP native interfaces are expected to have a return type declared. The return type can be the same as used in PHP itself or a more specific type. This complies with the Liskov principle of covariance, which allows the return type of a child overloaded method to be more specific than that of the parent. As this package still has a minimum PHP requirement of PHP 5.6, the return type (PHP 7.0 feature) can not be added, so I've added the attribute instead. While attributes are a PHP 8.0 feature only, due to the syntax choice for `#[]`, they will ignored in PHP < 8 and can be safely added. Note: these deprecations were visible in the test summary, but the tests - as they currently are - are not set up correctly to fail builds on deprecation notices, which is probably why this went unnoticed.
diff --git a/php/WP_CLI/Iterators/CSV.php b/php/WP_CLI/Iterators/CSV.php
@@ -4,6 +4,7 @@
 
 use Countable;
 use Iterator;
+use ReturnTypeWillChange;
 use SplFileObject;
 use WP_CLI;
 
@@ -33,6 +34,7 @@ public function __construct( $filename, $delimiter = ',' ) {
 		$this->delimiter = $delimiter;
 	}
 
+	#[ReturnTypeWillChange]
 	public function rewind() {
 		rewind( $this->file_pointer );
 
@@ -42,14 +44,17 @@ public function rewind() {
 		$this->next();
 	}
 
+	#[ReturnTypeWillChange]
 	public function current() {
 		return $this->current_element;
 	}
 
+	#[ReturnTypeWillChange]
 	public function key() {
 		return $this->current_index;
 	}
 
+	#[ReturnTypeWillChange]
 	public function next() {
 		$this->current_element = false;
 
@@ -76,12 +81,14 @@ public function next() {
 		}
 	}
 
+	#[ReturnTypeWillChange]
 	public function count() {
 		$file = new SplFileObject( $this->filename, 'r' );
 		$file->seek( PHP_INT_MAX );
 		return $file->key() + 1;
 	}
 
+	#[ReturnTypeWillChange]
 	public function valid() {
 		return is_array( $this->current_element );
 	}

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`use Countable;`
`6`	`6`	`use Iterator;`
	`7`	`+use ReturnTypeWillChange;`
`7`	`8`	`use SplFileObject;`
`8`	`9`	`use WP_CLI;`
`9`	`10`
`@@ -33,6 +34,7 @@ public function __construct( $filename, $delimiter = ',' ) {`
`33`	`34`	`$this->delimiter = $delimiter;`
`34`	`35`	`}`
`35`	`36`
	`37`	`+ #[ReturnTypeWillChange]`
`36`	`38`	`public function rewind() {`
`37`	`39`	`rewind( $this->file_pointer );`
`38`	`40`
`@@ -42,14 +44,17 @@ public function rewind() {`
`42`	`44`	`$this->next();`
`43`	`45`	`}`
`44`	`46`
	`47`	`+ #[ReturnTypeWillChange]`
`45`	`48`	`public function current() {`
`46`	`49`	`return $this->current_element;`
`47`	`50`	`}`
`48`	`51`
	`52`	`+ #[ReturnTypeWillChange]`
`49`	`53`	`public function key() {`
`50`	`54`	`return $this->current_index;`
`51`	`55`	`}`
`52`	`56`
	`57`	`+ #[ReturnTypeWillChange]`
`53`	`58`	`public function next() {`
`54`	`59`	`$this->current_element = false;`
`55`	`60`
`@@ -76,12 +81,14 @@ public function next() {`
`76`	`81`	`}`
`77`	`82`	`}`
`78`	`83`
	`84`	`+ #[ReturnTypeWillChange]`
`79`	`85`	`public function count() {`
`80`	`86`	`$file = new SplFileObject( $this->filename, 'r' );`
`81`	`87`	`$file->seek( PHP_INT_MAX );`
`82`	`88`	`return $file->key() + 1;`
`83`	`89`	`}`
`84`	`90`
	`91`	`+ #[ReturnTypeWillChange]`
`85`	`92`	`public function valid() {`
`86`	`93`	`return is_array( $this->current_element );`
`87`	`94`	`}`