Feature/phpstan upgrade (#431)

lloc · web-flow · commit d9563ebb36ca · 2025-03-17T12:11:41.000+01:00
* Upgrade and issues resolved
diff --git a/MultisiteLanguageSwitcher.php b/MultisiteLanguageSwitcher.php
@@ -208,9 +208,9 @@ function msls_get_post( int $id ): \lloc\Msls\MslsOptionsPost {
 	 * - is_tax
 	 *
 	 * @param int $id
-	 * @return \lloc\Msls\MslsOptionsTax
+	 * @return \lloc\Msls\OptionsTaxInterface
 	 */
-	function msls_get_tax( int $id ): \lloc\Msls\MslsOptionsTax {
+	function msls_get_tax( int $id ): \lloc\Msls\OptionsTaxInterface {
 		return \lloc\Msls\MslsOptionsTax::create( $id );
 	}
 
diff --git a/composer.json b/composer.json
@@ -12,15 +12,15 @@
   "require-dev": {
     "phpunit/phpunit": "^10",
     "brain/monkey": "^2.6",
-    "phpstan/phpstan": "^1.11",
-    "szepeviktor/phpstan-wordpress": "^1.3",
+    "phpstan/phpstan": "^2.1.0",
+    "szepeviktor/phpstan-wordpress": "^2.0.0",
     "phpstan/extension-installer": "^1.3",
     "antecedent/patchwork": "^2.1",
     "squizlabs/php_codesniffer": "^3.9",
     "phpcompatibility/php-compatibility": "^9.3",
     "wp-coding-standards/wpcs": "^3.0",
     "smeghead/php-class-diagram": "^1.3",
-    "phpstan/phpstan-mockery": "^1.1"
+    "phpstan/phpstan-mockery": "^2.0.0"
   },
   "autoload": {
     "psr-4": {
diff --git a/includes/Component/Icon/IconLabel.php b/includes/Component/Icon/IconLabel.php
@@ -3,7 +3,6 @@
 namespace lloc\Msls\Component\Icon;
 
 use lloc\Msls\Component\Icon;
-use lloc\Msls\MslsPlugin;
 
 /**
  * Class IconLabel
diff --git a/includes/ContentImport/AttachmentPathFinder.php b/includes/ContentImport/AttachmentPathFinder.php
@@ -93,7 +93,7 @@ public function filter_attachment_url( $url, $attachment_id ) {
 	protected function get_source_post( $attachment_id, $msls_imported ) {
 		$source_post = get_blog_post( $msls_imported['blog'], $msls_imported['post'] );
 
-		if ( empty( $source_post ) || ! $source_post instanceof \WP_Post ) {
+		if ( ! $source_post instanceof \WP_Post ) {
 			delete_post_meta( $attachment_id, self::LINKED );
 
 			return false;
diff --git a/includes/ContentImport/ContentImporter.php b/includes/ContentImport/ContentImporter.php
@@ -285,7 +285,7 @@ public function import_content( ImportCoordinates $import_coordinates, array $po
 		 * Returning a non `null` value here will override the creation of the importers map completely
 		 * and use the one returned in the filter.
 		 *
-		 * @param null $importers
+		 * @param ?array $importers
 		 * @param ImportCoordinates $import_coordinates
 		 */
 		$importers = apply_filters( 'msls_content_import_importers', null, $import_coordinates );
@@ -297,7 +297,7 @@ public function import_content( ImportCoordinates $import_coordinates, array $po
 		$this->logger    = $this->logger ?: new ImportLogger( $import_coordinates );
 		$this->relations = $this->relations ?: new Relations( $import_coordinates );
 
-		if ( ! empty( $importers ) && is_array( $importers ) ) {
+		if ( ! empty( $importers ) ) {
 			$source_post_id = $import_coordinates->source_post_id;
 			$dest_lang      = $import_coordinates->dest_lang;
 			$dest_post_id   = $import_coordinates->dest_post_id;
diff --git a/includes/ContentImport/ImportCoordinates.php b/includes/ContentImport/ImportCoordinates.php
@@ -26,7 +26,7 @@ class ImportCoordinates {
 	public $dest_post_id;
 
 	/**
-	 * @var \WP_Post
+	 * @var ?\WP_Post
 	 */
 	public $source_post;
 
@@ -55,9 +55,11 @@ public function validate() {
 		if ( ! get_blog_post( $this->source_blog_id, $this->source_post_id ) ) {
 			return false;
 		}
+
 		if ( ! get_blog_post( $this->dest_blog_id, $this->dest_post_id ) ) {
 			return false;
 		}
+
 		if ( ! $this->source_post instanceof \WP_Post ) {
 			return false;
 		}
diff --git a/includes/ContentImport/Importers/Map.php b/includes/ContentImport/Importers/Map.php
@@ -16,7 +16,7 @@ class Map extends MslsRegistryInstance {
 	public function make( ImportCoordinates $import_coordinates ) {
 		$importers = array_map(
 			function ( $factory ) use ( $import_coordinates ) {
-				/** @var ImportersFactory $factory */
+				/** @var ImportersBaseFactory $factory */
 				return $factory->make( $import_coordinates );
 			},
 			$this->factories()
diff --git a/includes/MslsAdmin.php b/includes/MslsAdmin.php
@@ -86,8 +86,7 @@ public function get_options_page_link(): string {
 	 */
 	public function __call( $method, $args ) {
 		$parts = explode( '_', $method, 2 );
-
-		if ( is_array( $parts ) && 'rewrite' === $parts[0] ) {
+		if ( count( $parts ) > 0 && 'rewrite' === $parts[0] ) {
 			$this->render_rewrite( $parts[1] );
 			return;
 		}
diff --git a/includes/MslsBlogCollection.php b/includes/MslsBlogCollection.php
@@ -134,14 +134,8 @@ public function get_blogs_of_reference_user( MslsOptions $options ) {
 		);
 
 		$blogs = get_blogs_of_user( $reference_user );
-
-		/**
-		 * @todo Check if this is still useful
-		 */
-		if ( is_array( $blogs ) ) {
-			foreach ( $blogs as $key => $blog ) {
-				$blogs[ $key ]->blog_id = $blog->userblog_id;
-			}
+		foreach ( $blogs as $key => $blog ) {
+			$blogs[ $key ]->blog_id = $blog->userblog_id;
 		}
 
 		return $blogs;
diff --git a/includes/MslsOptions.php b/includes/MslsOptions.php
@@ -370,7 +370,7 @@ public function get_available_languages(): array {
 	/**
 	 * The 'blog'-slug-problem :/
 	 *
-	 * @param string      $url
+	 * @param mixed       $url
 	 * @param MslsOptions $options
 	 *
 	 * @return string
diff --git a/includes/MslsOptionsTax.php b/includes/MslsOptionsTax.php
@@ -16,7 +16,7 @@ class MslsOptionsTax extends MslsOptions implements OptionsTaxInterface {
 	/**
 	 * @param int $id
 	 *
-	 * @return MslsOptionsTax
+	 * @return OptionsTaxInterface
 	 */
 	public static function create( $id = 0 ): OptionsTaxInterface {
 		$id = ! empty( $id ) ? (int) $id : get_queried_object_id();
@@ -33,23 +33,33 @@ public static function create( $id = 0 ): OptionsTaxInterface {
 		switch ( $req ) {
 			case 'category':
 				$options = new MslsOptionsTaxTermCategory( $id );
+				add_filter( 'msls_get_postlink', array( $options, 'check_base' ), 9, 2 );
 				break;
 			case 'post_tag':
 				$options = new MslsOptionsTaxTerm( $id );
+				add_filter( 'msls_get_postlink', array( $options, 'check_base' ), 9, 2 );
 				break;
 			default:
-				$options = new MslsOptionsTax( $id );
+				global $wp_rewrite;
+
+				$options             = new MslsOptionsTax( $id );
+				$options->with_front = ! empty( $wp_rewrite->extra_permastructs[ $options->get_tax_query() ]['with_front'] );
 		}
 
-		if ( method_exists( $options, 'check_base' ) ) {
-			add_filter( 'msls_get_postlink', array( $options, 'check_base' ), 9, 2 );
-		} else {
-			global $wp_rewrite;
+		return $options;
+	}
 
-			$options->with_front = ! empty( $wp_rewrite->extra_permastructs[ $options->get_tax_query() ]['with_front'] );
+	/**
+	 * @param int $id
+	 *
+	 * @return string
+	 */
+	public function get_content_type( int $id ): string {
+		if ( is_admin() ) {
+			return msls_content_types()->acl_request();
 		}
 
-		return $options;
+		return ( is_category() ? 'category' : is_tag( $id ) ) ? 'post_tag' : '';
 	}
 
 	/**
diff --git a/includes/MslsOptionsTaxTerm.php b/includes/MslsOptionsTaxTerm.php
@@ -23,7 +23,7 @@ class MslsOptionsTaxTerm extends MslsOptionsTax implements OptionsTaxInterface {
 	/**
 	 * Check and correct URL
 	 *
-	 * @param string             $url
+	 * @param mixed              $url
 	 * @param MslsOptionsTaxTerm $options
 	 *
 	 * @return string
diff --git a/includes/MslsPostTagClassic.php b/includes/MslsPostTagClassic.php
@@ -108,12 +108,12 @@ public function the_input( ?\WP_Term $tag, string $title_format, string $item_fo
 	/**
 	 * Prints options inputs
 	 *
-	 * @param MslsBlog       $blog
-	 * @param string         $type
-	 * @param MslsOptionsTax $mydata
-	 * @param string         $item_format
+	 * @param MslsBlog            $blog
+	 * @param string              $type
+	 * @param OptionsTaxInterface $mydata
+	 * @param string              $item_format
 	 */
-	public function print_option( MslsBlog $blog, string $type, MslsOptionsTax $mydata, string $item_format ): void {
+	public function print_option( MslsBlog $blog, string $type, OptionsTaxInterface $mydata, string $item_format ): void {
 		switch_to_blog( $blog->userblog_id );
 
 		$language  = $blog->get_language();
diff --git a/includes/MslsRequest.php b/includes/MslsRequest.php
@@ -17,29 +17,34 @@ public static function get_config( string $name ): array {
 		return $config;
 	}
 
-	public static function has_var( string $name, ?int $input_type = null ): bool {
+	public static function has_var( string $var_name, ?int $input_type = null ): bool {
 		if ( null === $input_type ) {
 			try {
-				list( $input_type, ) = self::get_config( $name );
+				list( $input_type, ) = self::get_config( $var_name );
 			} catch ( \InvalidArgumentException $e ) {
 				return false;
 			}
 		}
 
-		return filter_has_var( $input_type, $name );
+		return filter_has_var( $input_type, $var_name );
 	}
 
 	/**
 	 * @return mixed
 	 */
-	public static function get_var( string $name, ?int $input_type = null ) {
+	public static function get_var( string $var_name, ?int $input_type = null ) {
 		try {
-			list($type, $filter) = self::get_config( $name );
+			list($type, $filter) = self::get_config( $var_name );
 		} catch ( \InvalidArgumentException $e ) {
 			return null;
 		}
 
-		return filter_input( $input_type ?? $type, $name, $filter );
+		$type = $input_type ?? $type;
+		if ( in_array( $type, array( INPUT_POST, INPUT_GET, INPUT_COOKIE, INPUT_ENV, INPUT_SERVER ), true ) ) {
+			return filter_input( $type, $var_name, $filter );
+		}
+
+		return null;
 	}
 
 	/**
diff --git a/includes/MslsSqlCacher.php b/includes/MslsSqlCacher.php
@@ -8,7 +8,7 @@
  * @example https://gist.githubusercontent.com/lloc/2c232cef3f910acf692f/raw/91e5fe9ada922a82a32b83eaabad1e2a2ee50338/MslsSqlCacher.php
  *
  * @method mixed get_var( string $sql )
- * @method array get_results( string $sql )
+ * @method mixed[] get_results( string $sql )
  * @method string prepare( string $sql, mixed $a, $b = '', $c = '' )
  * @method mixed query( string $sql )
  * @property string $posts
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -1,6 +1,7 @@
 parameters:
     level: 6
     inferPrivatePropertyTypeFromConstructor: true
+    treatPhpDocTypesAsCertain: false
     paths:
         - MultisiteLanguageSwitcher.php
         - includes

Original file line number	Diff line number	Diff line change
`@@ -208,9 +208,9 @@ function msls_get_post( int $id ): \lloc\Msls\MslsOptionsPost {`
`208`	`208`	`* - is_tax`
`209`	`209`	`*`
`210`	`210`	`* @param int $id`
`211`		`- * @return \lloc\Msls\MslsOptionsTax`
	`211`	`+ * @return \lloc\Msls\OptionsTaxInterface`
`212`	`212`	`*/`
`213`		`- function msls_get_tax( int $id ): \lloc\Msls\MslsOptionsTax {`
	`213`	`+ function msls_get_tax( int $id ): \lloc\Msls\OptionsTaxInterface {`
`214`	`214`	`return \lloc\Msls\MslsOptionsTax::create( $id );`
`215`	`215`	`}`
`216`	`216`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ class ImportCoordinates {`
`26`	`26`	`public $dest_post_id;`
`27`	`27`
`28`	`28`	`/**`
`29`		`- * @var \WP_Post`
	`29`	`+ * @var ?\WP_Post`
`30`	`30`	`*/`
`31`	`31`	`public $source_post;`
`32`	`32`
`@@ -55,9 +55,11 @@ public function validate() {`
`55`	`55`	`if ( ! get_blog_post( $this->source_blog_id, $this->source_post_id ) ) {`
`56`	`56`	`return false;`
`57`	`57`	`}`
	`58`	`+`
`58`	`59`	`if ( ! get_blog_post( $this->dest_blog_id, $this->dest_post_id ) ) {`
`59`	`60`	`return false;`
`60`	`61`	`}`
	`62`	`+`
`61`	`63`	`if ( ! $this->source_post instanceof \WP_Post ) {`
`62`	`64`	`return false;`
`63`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -370,7 +370,7 @@ public function get_available_languages(): array {`
`370`	`370`	`/**`
`371`	`371`	`* The 'blog'-slug-problem :/`
`372`	`372`	`*`
`373`		`- * @param string $url`
	`373`	`+ * @param mixed $url`
`374`	`374`	`* @param MslsOptions $options`
`375`	`375`	`*`
`376`	`376`	`* @return string`