Introduce PHPStan for Static Analysis (#213)

* Lowered level to 0 and fixed the errors
* Github action for PHPStan
* Name for PHPStan's job
* PHPStan plugin installer + PHP Stubs for WP_CLI
* PHPStan explicit install
* Github workflow changed

Author: lloc

.github/workflows/phpstan-ci.yml

@@ -0,0 +1,23 @@
+name: Run PHPStan
+
+on: [push]
+
+jobs:
+  run-phpstan:
+    name: Static Analysis
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 'latest'
+          coverage: none
+          tools: composer, cs2pr
+      - name: Install PHP dependencies
+        uses: ramsey/composer-install@v2
+        with:
+          composer-options: '--prefer-dist --no-scripts'
+      - name: PHPStan
+        run: composer phpstan

composer.json

@@ -20,14 +20,22 @@
     "composer/installers": "^1.0 || ^2.0"
   },
   "require-dev": {
+    "php-stubs/wp-cli-stubs": "^2.11",
     "phpcompatibility/phpcompatibility-wp": "^2.1.0",
+    "phpstan/extension-installer": "^1.4",
+    "phpstan/phpstan": "^1.12",
+    "szepeviktor/phpstan-wordpress": "^1.0",
     "wp-coding-standards/wpcs": "^3.1.0",
     "yoast/wp-test-utils": "^1.2"
   },
+  "scripts": {
+    "phpstan": "vendor/bin/phpstan analyse --memory-limit=1G"
+  },
   "config": {
     "allow-plugins": {
       "composer/installers": true,
-      "dealerdirect/phpcodesniffer-composer-installer": true
+      "dealerdirect/phpcodesniffer-composer-installer": true,
+      "phpstan/extension-installer": true
     },
     "sort-packages": true
   }

phpstan.neon.dist

@@ -0,0 +1,13 @@
+parameters:
+    level: 0
+    paths:
+        - wp-multi-network/includes
+        - wpmn-loader.php
+    scanFiles:
+        - %rootDir%/../../php-stubs/wp-cli-stubs/wp-cli-stubs.php
+        - %rootDir%/../../php-stubs/wp-cli-stubs/wp-cli-commands-stubs.php
+        #- %rootDir%/../../php-stubs/wp-cli-stubs/wp-cli-i18n-stubs.php
+        #- %rootDir%/../../php-stubs/wp-cli-stubs/wp-cli-tools-stubs.php
+    ignoreErrors:
+        - '/^Call to static method encode\(\) on an unknown class Requests_IDNAEncoder.$/'
+

wp-multi-network/includes/classes/class-wp-ms-network-command.php

@@ -11,7 +11,7 @@
  *
  * @since 1.3.0
  */
-class WP_MS_Network_Command extends WP_CLI_Command {
+class WP_MS_Network_Command {
 
 	/**
 	 * Default fields to display for each object.
@@ -260,7 +260,7 @@ public function list_( $args, $assoc_args ) {
 	 * @param array $assoc_args Associative CLI arguments.
 	 */
 	public function plugin( $args, $assoc_args ) {
-		$this->fetcher = new \WP_CLI\Fetchers\Plugin();
+		$fetchers_plugin = new \WP_CLI\Fetchers\Plugin();
 		$action        = array_shift( $args );
 		if ( ! in_array( $action, array( 'activate', 'deactivate' ), true ) ) {
 			WP_CLI::error( sprintf( '%s is not a supported action.', $action ) );
@@ -284,7 +284,7 @@ function ( $file ) {
 					}, array_keys( get_plugins() )
 				);
 			}
-			foreach ( $this->fetcher->get_many( $args ) as $plugin ) {
+			foreach ( $fetchers_plugin->get_many( $args ) as $plugin ) {
 				$status = $this->get_status( $plugin->file );
 				if ( $all && in_array( $status, array( 'active', 'active-network' ), true ) ) {
 					--$needing_activation;

wp-multi-network/includes/classes/class-wp-ms-networks-list-table.php

@@ -479,9 +479,9 @@ protected function handle_row_actions( $network, $column_name, $primary ) {
 		 *
 		 * @since 2.0.0
 		 *
-		 * @param array  Action links as $slug => $link_markup pairs.
-		 * @param int    The current network ID.
-		 * @param string The current network name.
+		 * @param array  $filtered_acions Action links as $slug => $link_markup pairs.
+		 * @param int    $network_id The current network ID.
+		 * @param string $network_sitename The current network name.
 		 */
 		$actions = apply_filters( 'manage_networks_action_links', array_filter( $actions ), $network->id, $network->sitename );
 

wp-multi-network/includes/classes/class-wp-ms-rest-networks-controller.php

@@ -449,10 +449,6 @@ public function update_item( $request ) {
 		}
 
 		if ( ! empty( $prepared_args ) ) {
-			if ( is_wp_error( $prepared_args ) ) {
-				return $prepared_args;
-			}
-
 			$domain = $prepared_args['domain'];
 			$path   = $prepared_args['path'];
 

wp-multi-network/includes/functions.php

@@ -74,9 +74,9 @@ function user_has_networks( $user_id = 0 ) {
 		 *
 		 * @since 2.0.0
 		 *
-		 * @param array|bool|null List of network IDs or false. Anything but null will short-circuit
-		 *                        the process.
-		 * @param int             User ID for which the networks should be returned.
+		 * @param array|bool|null $my_networks List of network IDs or false. Anything but null will short-circuit
+		 *                                     the process.
+		 * @param int             $user_id User ID for which the networks should be returned.
 		 */
 		$my_networks = apply_filters( 'networks_pre_user_is_network_admin', null, $user_id );
 		if ( null !== $my_networks ) {
@@ -89,8 +89,8 @@ function user_has_networks( $user_id = 0 ) {
 			 *
 			 * @since 2.0.0
 			 *
-			 * @param array|bool List of network IDs or false if no networks for the user.
-			 * @param int        User ID for which the networks should be returned.
+			 * @param array|bool $my_networks List of network IDs or false if no networks for the user.
+			 * @param int        $user_id User ID for which the networks should be returned.
 			 */
 			return apply_filters( 'networks_user_is_network_admin', $my_networks, $user_id );
 		}