Merge pull request #6019 from wp-cli/try/phpstan

swissspidy · web-flow · commit 0187f2b4ce7e · 2024-11-26T20:13:58.000+01:00
Code quality improvements powered by PHPStan
diff --git a/php/WP_CLI/Configurator.php b/php/WP_CLI/Configurator.php
@@ -148,8 +148,8 @@ public function get_aliases() {
 	/**
 	 * Splits a list of arguments into positional, associative and config.
 	 *
-	 * @param array(string) $arguments
-	 * @return array(array)
+	 * @param array<string> $arguments
+	 * @return array<array<string>>
 	 */
 	public function parse_args( $arguments ) {
 		list( $positional_args, $mixed_args, $global_assoc, $local_assoc ) = self::extract_assoc( $arguments );
@@ -160,8 +160,8 @@ public function parse_args( $arguments ) {
 	/**
 	 * Splits positional args from associative args.
 	 *
-	 * @param array $arguments
-	 * @return array(array)
+	 * @param array<string> $arguments
+	 * @return array{0: array<string>, 1: array<array{0: string, 1: string|bool}>, 2: array<array{0: string, 1: string|bool}>, 3: array<array{0: string, 1: string|bool}>}
 	 */
 	public static function extract_assoc( $arguments ) {
 		$positional_args = [];
diff --git a/php/WP_CLI/Dispatcher/CommandFactory.php b/php/WP_CLI/Dispatcher/CommandFactory.php
@@ -23,8 +23,8 @@ class CommandFactory {
 	/**
 	 * Create a new CompositeCommand (or Subcommand if class has __invoke())
 	 *
-	 * @param string $name Represents how the command should be invoked
-	 * @param string $callable A subclass of WP_CLI_Command, a function, or a closure
+	 * @param string                                $name     Represents how the command should be invoked
+	 * @param string|callable-string|callable|array $callable A subclass of WP_CLI_Command, a function, or a closure
 	 * @param mixed $parent The new command's parent Composite (or Root) command
 	 */
 	public static function create( $name, $callable, $parent ) {
diff --git a/php/WP_CLI/Dispatcher/CompositeCommand.php b/php/WP_CLI/Dispatcher/CompositeCommand.php
@@ -277,7 +277,7 @@ private static function get_aliases( $subcommands ) {
 	/**
 	 * Composite commands can only be known by one name.
 	 *
-	 * @return false
+	 * @return string|false
 	 */
 	public function get_alias() {
 		return false;
diff --git a/php/WP_CLI/Exception/NonExistentKeyException.php b/php/WP_CLI/Exception/NonExistentKeyException.php
@@ -3,6 +3,7 @@
 namespace WP_CLI\Exception;
 
 use OutOfBoundsException;
+use WP_CLI\Traverser\RecursiveDataStructureTraverser;
 
 class NonExistentKeyException extends OutOfBoundsException {
 	/** @var RecursiveDataStructureTraverser */
diff --git a/php/WP_CLI/Extractor.php b/php/WP_CLI/Extractor.php
@@ -280,7 +280,7 @@ public static function zip_error_msg( $error_code ) {
 	/**
 	 * Return formatted error message from ProcessRun of tar command.
 	 *
-	 * @param Processrun $process_run
+	 * @param ProcessRun $process_run
 	 * @return string|int The error message of the process, if available;
 	 *                    otherwise the return code.
 	 */
diff --git a/php/WP_CLI/Fetchers/Base.php b/php/WP_CLI/Fetchers/Base.php
@@ -18,7 +18,7 @@ abstract class Base {
 	protected $msg;
 
 	/**
-	 * @param string $arg The raw CLI argument.
+	 * @param string|int $arg The raw CLI argument.
 	 * @return mixed|false The item if found; false otherwise.
 	 */
 	abstract public function get( $arg );
diff --git a/php/WP_CLI/Fetchers/Signup.php b/php/WP_CLI/Fetchers/Signup.php
@@ -18,7 +18,7 @@ class Signup extends Base {
 	 * Get a signup.
 	 *
 	 * @param int|string $signup
-	 * @return stdClass|false
+	 * @return object|false
 	 */
 	public function get( $signup ) {
 		return $this->get_signup( $signup );
@@ -28,7 +28,7 @@ public function get( $signup ) {
 	 * Get a signup by one of its identifying attributes.
 	 *
 	 * @param string $arg The raw CLI argument.
-	 * @return stdClass|false The item if found; false otherwise.
+	 * @return object|false The item if found; false otherwise.
 	 */
 	protected function get_signup( $arg ) {
 		global $wpdb;
diff --git a/php/WP_CLI/FileCache.php b/php/WP_CLI/FileCache.php
@@ -328,7 +328,7 @@ protected function ensure_dir_exists( $dir ) {
 			if ( ! @mkdir( $dir, 0777, true ) ) {
 				$message = "Failed to create directory '{$dir}'";
 				$error   = error_get_last();
-				if ( is_array( $error ) && array_key_exists( 'message', $error ) ) {
+				if ( is_array( $error ) ) {
 					$message .= ": {$error['message']}";
 				}
 				WP_CLI::warning( "{$message}." );
diff --git a/php/WP_CLI/Formatter.php b/php/WP_CLI/Formatter.php
@@ -286,7 +286,6 @@ private function show_multiple_fields( $data, $format, $ascii_pre_colorized = fa
 
 			default:
 				WP_CLI::error( 'Invalid format: ' . $format );
-				break;
 
 		}
 	}
diff --git a/php/WP_CLI/Inflector.php b/php/WP_CLI/Inflector.php
@@ -491,6 +491,10 @@ public static function pluralize( $word ) {
 				return self::$cache['pluralize'][ $word ];
 			}
 		}
+
+		// Just so a string is always returned.
+		// This should never be reached.
+		return $word;
 	}
 
 	/**
diff --git a/php/WP_CLI/Process.php b/php/WP_CLI/Process.php
@@ -43,9 +43,9 @@ class Process {
 	public static $run_times = [];
 
 	/**
-	 * @param string $command Command to execute.
-	 * @param string $cwd Directory to execute the command in.
-	 * @param array $env Environment variables to set when running the command.
+	 * @param string      $command Command to execute.
+	 * @param string|null $cwd     Directory to execute the command in.
+	 * @param array|null  $env     Environment variables to set when running the command.
 	 *
 	 * @return Process
 	 */
diff --git a/php/WP_CLI/RequestsLibrary.php b/php/WP_CLI/RequestsLibrary.php
@@ -164,7 +164,6 @@ public static function set_version( $version ) {
 	 * Get the current class name.
 	 *
 	 * @return string The current class name.
-	 * @throws RuntimeException if the class name is not set.
 	 */
 	public static function get_class_name() {
 		return self::$class_name;
diff --git a/php/WP_CLI/Runner.php b/php/WP_CLI/Runner.php
@@ -491,9 +491,7 @@ private function run_ssh_command( $connection_string ) {
 
 		$pre_cmd = getenv( 'WP_CLI_SSH_PRE_CMD' );
 		if ( $pre_cmd ) {
-			$message = WP_CLI::warning( "WP_CLI_SSH_PRE_CMD found, executing the following command(s) on the remote machine:\n $pre_cmd" );
-
-			WP_CLI::log( $message );
+			WP_CLI::warning( "WP_CLI_SSH_PRE_CMD found, executing the following command(s) on the remote machine:\n $pre_cmd" );
 
 			$pre_cmd = rtrim( $pre_cmd, ';' ) . '; ';
 		}
@@ -630,10 +628,10 @@ private function generate_ssh_command( $bits, $wp_command ) {
 
 			if ( empty( $bits['host'] ) || ( isset( $values['Host'] ) && $bits['host'] === $values['Host'] ) ) {
 				$bits['scheme'] = 'ssh';
-				$bits['host']   = $values['HostName'];
-				$bits['port']   = $values['Port'];
-				$bits['user']   = $values['User'];
-				$bits['key']    = $values['IdentityFile'];
+				$bits['host']   = isset( $values['HostName'] ) ? $values['HostName'] : '';
+				$bits['port']   = isset( $values['Port'] ) ? $values['Port'] : '';
+				$bits['user']   = isset( $values['User'] ) ? $values['User'] : '';
+				$bits['key']    = isset( $values['IdentityFile'] ) ? $values['IdentityFile'] : '';
 			}
 
 			// If we could not resolve the bits still, fallback to just `vagrant ssh`
@@ -1621,9 +1619,7 @@ static function ( $current_site, $domain, $path ) {
 							$explanation = 'Verify DOMAIN_CURRENT_SITE matches an existing site or use `--url=<url>` to override.';
 						}
 					}
-					if ( $explanation ) {
-						$message .= ' ' . $explanation;
-					}
+					$message .= ' ' . $explanation;
 					WP_CLI::error( $message );
 				},
 				10,
diff --git a/php/WP_CLI/SynopsisParser.php b/php/WP_CLI/SynopsisParser.php
@@ -101,12 +101,7 @@ public static function render( &$synopsis ) {
 				$value .= "{$rendered_arg} ";
 			}
 		}
-		$rendered = '';
-		foreach ( $bits as $v ) {
-			if ( ! empty( $v ) ) {
-				$rendered .= $v;
-			}
-		}
+		$rendered = implode( '', $bits );
 
 		$synopsis = array_merge(
 			$reordered_synopsis['positional'],
diff --git a/php/WP_CLI/Traverser/RecursiveDataStructureTraverser.php b/php/WP_CLI/Traverser/RecursiveDataStructureTraverser.php
@@ -128,7 +128,7 @@ public function delete_by_key( $key ) {
 	 *
 	 * @throws NonExistentKeyException
 	 *
-	 * @return static
+	 * @return self
 	 */
 	public function traverse_to( array $key_path ) {
 		$current = array_shift( $key_path );
@@ -139,13 +139,13 @@ public function traverse_to( array $key_path ) {
 
 		if ( ! $this->exists( $current ) ) {
 			$exception = new NonExistentKeyException( "No data exists for key \"{$current}\"" );
-			$exception->set_traverser( new static( $this->data, $current, $this->parent ) );
+			$exception->set_traverser( new self( $this->data, $current, $this->parent ) );
 			throw $exception;
 		}
 
 		foreach ( $this->data as $key => &$key_data ) {
 			if ( $key === $current ) {
-				$traverser = new static( $key_data, $key, $this );
+				$traverser = new self( $key_data, $key, $this );
 				return $traverser->traverse_to( $key_path );
 			}
 		}
diff --git a/php/WP_CLI/WpOrgApi.php b/php/WP_CLI/WpOrgApi.php
@@ -278,7 +278,7 @@ public function get_theme_info( $theme, $locale = 'en_US', array $fields = [] )
 	/**
 	 * Gets a set of salts in the format required by `wp-config.php`.
 	 *
-	 * @return bool|string False on failure. A string of PHP define() statements on success.
+	 * @return string A string of PHP define() statements.
 	 * @throws RuntimeException If the remote request fails.
 	 */
 	public function get_salts() {
@@ -323,7 +323,7 @@ private function json_get_request( $url, $headers = [], $options = [] ) {
 	 * @param string $url     URL to execute the GET request on.
 	 * @param array  $headers Optional. Associative array of headers.
 	 * @param array  $options Optional. Associative array of options.
-	 * @return string|false False on failure. Response body string on success.
+	 * @return string Response body.
 	 * @throws RuntimeException If the remote request fails.
 	 */
 	private function get_request( $url, $headers = [], $options = [] ) {
diff --git a/php/class-wp-cli.php b/php/class-wp-cli.php
@@ -262,7 +262,7 @@ public static function colorize( $string ) {
 	 *
 	 * @param string $when Identifier for the hook.
 	 * @param mixed $callback Callback to execute when hook is called.
-	 * @return null
+	 * @return void
 	 */
 	public static function add_hook( $when, $callback ) {
 		if ( array_key_exists( $when, self::$hooks_passed ) ) {
@@ -591,6 +591,8 @@ public static function add_command( $name, $callable, $args = [] ) {
 			);
 		}
 
+		/** @var Dispatcher\Subcommand $leaf_command */
+
 		if ( isset( $args['shortdesc'] ) ) {
 			$leaf_command->set_shortdesc( $args['shortdesc'] );
 		}
@@ -738,7 +740,7 @@ public static function remove_deferred_addition( $name ) {
 	 * @category Output
 	 *
 	 * @param string $message Message to display to the end user.
-	 * @return null
+	 * @return void
 	 */
 	public static function line( $message = '' ) {
 		echo $message . "\n";
@@ -788,7 +790,7 @@ public static function log( $message ) {
 	 * @category Output
 	 *
 	 * @param string $message Message to write to STDOUT.
-	 * @return null
+	 * @return void
 	 */
 	public static function success( $message ) {
 		if ( null === self::$logger ) {
@@ -826,7 +828,7 @@ public static function success( $message ) {
 	 * @param string|WP_Error|Exception|Throwable $message Message to write to STDERR.
 	 * @param string|bool $group Organize debug message to a specific group.
 	 * Use `false` to not group the message.
-	 * @return null
+	 * @return void
 	 */
 	public static function debug( $message, $group = false ) {
 		static $storage = [];
@@ -836,7 +838,7 @@ public static function debug( $message, $group = false ) {
 			return;
 		}
 
-		if ( ! empty( $storage ) && self::$logger ) {
+		if ( ! empty( $storage ) ) {
 			foreach ( $storage as $entry ) {
 				list( $stored_message, $stored_group ) = $entry;
 				self::$logger->debug( self::error_to_string( $stored_message ), $stored_group );
@@ -869,7 +871,7 @@ public static function debug( $message, $group = false ) {
 	 * @category Output
 	 *
 	 * @param string|WP_Error|Exception|Throwable $message Message to write to STDERR.
-	 * @return null
+	 * @return void
 	 */
 	public static function warning( $message ) {
 		if ( null === self::$logger ) {
@@ -1349,6 +1351,9 @@ public static function runcommand( $command, $options = [] ) {
 			$pipes = [];
 			$proc  = Utils\proc_open_compat( $runcommand, $descriptors, $pipes, getcwd() );
 
+			$stdout = '';
+			$stderr = '';
+
 			if ( $return ) {
 				$stdout = stream_get_contents( $pipes[1] );
 				fclose( $pipes[1] );
diff --git a/php/utils-wp.php b/php/utils-wp.php
diff --git a/php/utils.php b/php/utils.php

Original file line number	Diff line number	Diff line change
`@@ -277,7 +277,7 @@ private static function get_aliases( $subcommands ) {`
`277`	`277`	`/**`
`278`	`278`	`* Composite commands can only be known by one name.`
`279`	`279`	`*`
`280`		`- * @return false`
	`280`	`+ * @return string\|false`
`281`	`281`	`*/`
`282`	`282`	`public function get_alias() {`
`283`	`283`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -280,7 +280,7 @@ public static function zip_error_msg( $error_code ) {`
`280`	`280`	`/**`
`281`	`281`	`* Return formatted error message from ProcessRun of tar command.`
`282`	`282`	`*`
`283`		`- * @param Processrun $process_run`
	`283`	`+ * @param ProcessRun $process_run`
`284`	`284`	`* @return string\|int The error message of the process, if available;`
`285`	`285`	`* otherwise the return code.`
`286`	`286`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -328,7 +328,7 @@ protected function ensure_dir_exists( $dir ) {`
`328`	`328`	`if ( ! @mkdir( $dir, 0777, true ) ) {`
`329`	`329`	`$message = "Failed to create directory '{$dir}'";`
`330`	`330`	`$error = error_get_last();`
`331`		`- if ( is_array( $error ) && array_key_exists( 'message', $error ) ) {`
	`331`	`+ if ( is_array( $error ) ) {`
`332`	`332`	`$message .= ": {$error['message']}";`
`333`	`333`	`}`
`334`	`334`	`WP_CLI::warning( "{$message}." );`
Original file line number	Diff line number	Diff line change
`@@ -286,7 +286,6 @@ private function show_multiple_fields( $data, $format, $ascii_pre_colorized = fa`
`286`	`286`
`287`	`287`	`default:`
`288`	`288`	`WP_CLI::error( 'Invalid format: ' . $format );`
`289`		`- break;`
`290`	`289`
`291`	`290`	`}`
`292`	`291`	`}`
Original file line number	Diff line number	Diff line change
`@@ -491,6 +491,10 @@ public static function pluralize( $word ) {`
`491`	`491`	`return self::$cache['pluralize'][ $word ];`
`492`	`492`	`}`
`493`	`493`	`}`
	`494`	`+`
	`495`	`+ // Just so a string is always returned.`
	`496`	`+ // This should never be reached.`
	`497`	`+ return $word;`
`494`	`498`	`}`
`495`	`499`
`496`	`500`	`/**`