PHPStan Level 5 reached (#413)

lloc · web-flow · commit 93b8a915b7f9 · 2025-02-15T13:20:05.000+01:00
* PHPStan Level 5 reached

* Sort lines in .distignore
diff --git a/.distignore b/.distignore
@@ -1,9 +1,13 @@
-/.wordpress-org
+.distignore
+.gitattributes
+.gitignore
+.scrutinizer.yml
 /.git
 /.github
 /.idea
 /.phpunit.cache
 /.vscode
+/.wordpress-org
 /bin
 /build
 /diagrams
@@ -14,22 +18,18 @@
 /out
 /src
 /tests
-.distignore
-.gitattributes
-.gitignore
-.scrutinizer.yml
 Changelog.md
 Diagrams.md
 README.md
 composer.json
 composer.lock
+multisite-language-switcher.zip
 package-lock.json
 package.json
 patchwork.json
 phpcs.xml
 phpdoc.xml
-phpstan.neon
+phpstan.neon.dist
 phpunit.xml
 playwright.config.ts
-setup.sh
-multisite-language-switcher.zip
+setup.sh
diff --git a/MultisiteLanguageSwitcher.php b/MultisiteLanguageSwitcher.php
@@ -230,6 +230,16 @@ function msls_get_query(): ?\lloc\Msls\MslsOptionsQuery {
 		return \lloc\Msls\MslsOptionsQuery::create();
 	}
 
+	/**
+	 * Trivial void function for actions that do not return anything.
+	 *
+	 * @return void
+	 */
+	if ( ! function_exists( '__return_void' ) ) {
+		function __return_void(): void {
+		}
+	}
+
 	lloc\Msls\MslsPlugin::init();
 	lloc\Msls\MslsCli::init();
 }
diff --git a/build/translations.json b/build/translations.json
diff --git a/includes/ContentImport/ContentImporter.php b/includes/ContentImport/ContentImporter.php
@@ -25,15 +25,8 @@ class ContentImporter extends MslsRegistryInstance {
 	 * @var MslsMain
 	 */
 	protected $main;
-
-	/**
-	 * @var ImportLogger
-	 */
-	protected $logger;
-	/**
-	 * @var Relations
-	 */
-	protected $relations;
+	protected ?ImportLogger $logger;
+	protected ?Relations $relations;
 
 	/**
 	 * @var bool Whether the class should handle requests or not.
@@ -48,9 +41,9 @@ class ContentImporter extends MslsRegistryInstance {
 	/**
 	 * ContentImporter constructor.
 	 *
-	 * @param \lloc\Msls\MslsMain|null $main
+	 * @param ?MslsMain $main
 	 */
-	public function __construct( MslsMain $main = null ) {
+	public function __construct( ?MslsMain $main = null ) {
 		$this->main = $main ?: MslsMain::create();
 	}
 
@@ -237,9 +230,9 @@ public function handle( $handle ) {
 
 		// also prevent MSLS from saving
 		if ( false === $handle ) {
-			add_action( 'msls_main_save', '__return_false' );
+			add_action( 'msls_main_save', '__return_void' );
 		} else {
-			remove_action( 'msls_main_save', '__return_false' );
+			remove_action( 'msls_main_save', '__return_void' );
 		}
 	}
 
diff --git a/includes/ContentImport/Importers/Map.php b/includes/ContentImport/Importers/Map.php
@@ -41,7 +41,7 @@ function ( $factory ) use ( $import_coordinates ) {
 	/**
 	 * Returns a filtered list of factories that will provide the importers.
 	 *
-	 * @return array An associative array in the shape [ <string: $slug> => <ImportersFactory: $factory> ]
+	 * @return array<string, ImportersBaseFactory> An associative array in the shape [ <string: $slug> => <ImportersFactory: $factory> ]
 	 * @since TBD
 	 */
 	public function factories() {
diff --git a/includes/ContentImport/Relations.php b/includes/ContentImport/Relations.php
@@ -115,9 +115,9 @@ protected function create_local_to_source(): void {
 	/**
 	 * Sets a relation that should be created.
 	 *
-	 * @param OptionsTaxInterface $creator
-	 * @param string              $dest_lang
-	 * @param int                 $dest_post_id
+	 * @param OptionsInterface $creator
+	 * @param string           $dest_lang
+	 * @param int              $dest_post_id
 	 */
 	public function should_create( OptionsInterface $creator, $dest_lang, $dest_post_id ): void {
 		$this->to_create[] = array( $creator, $dest_lang, $dest_post_id );
diff --git a/includes/LinkInterface.php b/includes/LinkInterface.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace lloc\Msls;
+
+/**
+ * Interface for the link types
+ *
+ * @property string $txt
+ * @property string $src
+ * @property string $alt
+ * @property string $url
+ *
+ * @package Msls
+ * @phpstan-require-extends MslsLink
+ */
+interface LinkInterface {
+
+	public function __toString(): string;
+}
diff --git a/includes/MslsAdmin.php b/includes/MslsAdmin.php
@@ -426,13 +426,7 @@ public function content_priority(): void {
 	 */
 	public function render_rewrite( $key ): void {
 		$rewrite = get_post_type_object( $key )->rewrite;
-
-		$value = '';
-		if ( true === $rewrite ) {
-			$value = $key;
-		} elseif ( ! empty( $rewrite['slug'] ) ) {
-			$value = $rewrite['slug'];
-		}
+		$value   = $rewrite['slug'] ?? '';
 
         // phpcs:ignore WordPress.Security.EscapeOutput
 		echo ( new Text( "rewrite_{$key}", $value, 30, true ) )->render();
diff --git a/includes/MslsBlog.php b/includes/MslsBlog.php
@@ -110,7 +110,7 @@ public function get_alpha2() {
 	}
 
 	/**
-	 * @param MslsOptions $options
+	 * @param OptionsInterface $options
 	 *
 	 * @return string|null
 	 */
@@ -123,9 +123,9 @@ public function get_url( $options ) {
 	}
 
 	/**
-	 * @param MslsOptions $options
+	 * @param OptionsInterface $options
 	 *
-	 * @return string|null
+	 * @return ?string
 	 */
 	protected function get_permalink( $options ) {
 		$url = null;
diff --git a/includes/MslsLink.php b/includes/MslsLink.php
@@ -6,12 +6,8 @@
  * Link type: Image and text
  *
  * @package Msls
- * @property string $txt
- * @property string $src
- * @property string $alt
- * @property string $url
  */
-class MslsLink extends MslsGetSet {
+class MslsLink extends MslsGetSet implements LinkInterface {
 
 	/**
 	 * Output format
@@ -63,9 +59,9 @@ public static function get_types_description(): array {
 	 *
 	 * @param ?int $display
 	 *
-	 * @return MslsLink
+	 * @return LinkInterface
 	 */
-	public static function create( ?int $display ): MslsLink {
+	public static function create( ?int $display ): LinkInterface {
 		$types = self::get_types();
 		if ( ! in_array( $display, array_keys( $types ), true ) ) {
 			$display = 0;
@@ -75,13 +71,13 @@ public static function create( ?int $display ): MslsLink {
 
 		if ( has_filter( 'msls_link_create' ) ) {
 			/**
-			 * @param MslsLink $obj
+			 * @param LinkInterface $obj
 			 * @param int $display
 			 *
-			 * @return MslsLink
+			 * @return LinkInterface
 			 */
 			$obj = apply_filters( 'msls_link_create', $obj, $display );
-			if ( in_array( __CLASS__, $types ) || is_subclass_of( $obj, __CLASS__ ) ) {
+			if ( $obj instanceof LinkInterface ) {
 				return $obj;
 			}
 		}
@@ -102,10 +98,8 @@ public static function callback( $x ) {
 
 	/**
 	 * Handles the request to print the object
-	 *
-	 * @return string
 	 */
-	public function __toString() {
+	public function __toString(): string {
 		$temp = $this->get_arr();
 
 		return str_replace(
diff --git a/includes/MslsLinkImageOnly.php b/includes/MslsLinkImageOnly.php
@@ -7,7 +7,7 @@
  *
  * @package Msls
  */
-class MslsLinkImageOnly extends MslsLink {
+class MslsLinkImageOnly extends MslsLink implements LinkInterface {
 
 	/**
 	 * Output format
diff --git a/includes/MslsLinkTextImage.php b/includes/MslsLinkTextImage.php
@@ -7,7 +7,7 @@
  *
  * @package Msls
  */
-class MslsLinkTextImage extends MslsLink {
+class MslsLinkTextImage extends MslsLink implements LinkInterface {
 
 	/**
 	 * Output format
diff --git a/includes/MslsLinkTextOnly.php b/includes/MslsLinkTextOnly.php
@@ -7,7 +7,7 @@
  *
  * @package Msls
  */
-class MslsLinkTextOnly extends MslsLink {
+class MslsLinkTextOnly extends MslsLink implements LinkInterface {
 
 	/**
 	 * Output format
diff --git a/includes/MslsOptions.php b/includes/MslsOptions.php
@@ -59,7 +59,7 @@ class MslsOptions extends MslsGetSet implements OptionsInterface {
 	 *
 	 * @param int $id
 	 *
-	 * @return MslsOptions
+	 * @return OptionsInterface
 	 */
 	public static function create( $id = 0 ) {
 		if ( is_admin() ) {
@@ -195,12 +195,7 @@ public function set( $arr ): bool {
 		return true;
 	}
 
-	/**
-	 * @param string $language
-	 *
-	 * @return string
-	 */
-	public function get_permalink( $language ) {
+	public function get_permalink( string $language ): string {
 		/**
 		 * Filters the url by language
 		 *
@@ -240,10 +235,8 @@ public function get_tax_query() {
 
 	/**
 	 * Get current link
-	 *
-	 * @return string
 	 */
-	public function get_current_link() {
+	public function get_current_link(): string {
 		return home_url( '/' );
 	}
 
diff --git a/includes/MslsOptionsQueryAuthor.php b/includes/MslsOptionsQueryAuthor.php
@@ -48,7 +48,7 @@ public function has_value( string $language ): bool {
 	 *
 	 * @return string
 	 */
-	public function get_current_link() {
+	public function get_current_link(): string {
 		return get_author_posts_url( $this->author_id );
 	}
 }
diff --git a/includes/MslsOptionsQueryDay.php b/includes/MslsOptionsQueryDay.php
@@ -56,7 +56,7 @@ public function has_value( string $language ): bool {
 	 *
 	 * @return string
 	 */
-	public function get_current_link() {
+	public function get_current_link(): string {
 		return get_day_link( $this->year, $this->monthnum, $this->day );
 	}
 }
diff --git a/includes/MslsOptionsQueryPostType.php b/includes/MslsOptionsQueryPostType.php
@@ -43,7 +43,7 @@ public function has_value( string $language ): bool {
 	 *
 	 * @return string
 	 */
-	public function get_current_link() {
+	public function get_current_link(): string {
 		return (string) get_post_type_archive_link( $this->post_type );
 	}
 }
diff --git a/includes/MslsOptionsTax.php b/includes/MslsOptionsTax.php
@@ -93,7 +93,7 @@ public function get_postlink( $language ) {
 	 *
 	 * @return string
 	 */
-	public function get_current_link() {
+	public function get_current_link(): string {
 		return $this->get_term_link( $this->get_arg( 0, 0 ) );
 	}
 
diff --git a/includes/MslsOutput.php b/includes/MslsOutput.php
@@ -68,7 +68,7 @@ public function get( ?int $display, bool $filter = false, $exists = false ): arr
 					 * Returns HTML-link for an item of the output-arr
 					 *
 					 * @param string $url
-					 * @param MslsLink $link
+					 * @param LinkInterface $link
 					 * @param bool $is_current_blog
 					 *
 					 * @since 0.9.8
@@ -190,9 +190,9 @@ public function set_tags( array $arr = array() ): MslsOutput {
 	/**
 	 * Returns true if the requirements not fulfilled
 	 *
-	 * @param MslsOptions|null $thing
-	 * @param boolean          $exists
-	 * @param string           $language
+	 * @param ?OptionsInterface $thing
+	 * @param boolean           $exists
+	 * @param string            $language
 	 *
 	 * @return boolean
 	 */
diff --git a/includes/OptionsInterface.php b/includes/OptionsInterface.php
@@ -4,4 +4,9 @@
 
 interface OptionsInterface {
 
+	public function has_value( string $key ): bool;
+
+	public function get_current_link(): string;
+
+	public function get_permalink( string $language ): string;
 }
diff --git a/tests/phpunit/TestMslsAdmin.php b/tests/phpunit/TestMslsAdmin.php
@@ -260,12 +260,12 @@ function test_rewrite_pinko(): void {
 		$obj = $this->MslsAdminFactory();
 
 		$post_type          = \Mockery::mock( \WP_Post_Type::class );
-		$post_type->rewrite = true;
+		$post_type->rewrite = true; // this should not be possible
 
 		Functions\when( 'get_post_type_object' )->justReturn( $post_type );
 
 		$this->expectOutputString(
-			'<input type="text" class="regular-text" id="rewrite_pinko" name="msls[rewrite_pinko]" value="pinko" size="30" readonly="readonly"/>'
+			'<input type="text" class="regular-text" id="rewrite_pinko" name="msls[rewrite_pinko]" value="" size="30" readonly="readonly"/>'
 		);
 		$obj->rewrite_pinko( 'pinko' );
 	}

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ function ( $factory ) use ( $import_coordinates ) {`
`41`	`41`	`/**`
`42`	`42`	`* Returns a filtered list of factories that will provide the importers.`
`43`	`43`	`*`
`44`		`- * @return array An associative array in the shape [ <string: $slug> => <ImportersFactory: $factory> ]`
	`44`	`+ * @return array<string, ImportersBaseFactory> An associative array in the shape [ <string: $slug> => <ImportersFactory: $factory> ]`
`45`	`45`	`* @since TBD`
`46`	`46`	`*/`
`47`	`47`	`public function factories() {`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ public function get_alpha2() {`
`110`	`110`	`}`
`111`	`111`
`112`	`112`	`/**`
`113`		`- * @param MslsOptions $options`
	`113`	`+ * @param OptionsInterface $options`
`114`	`114`	`*`
`115`	`115`	`* @return string\|null`
`116`	`116`	`*/`
`@@ -123,9 +123,9 @@ public function get_url( $options ) {`
`123`	`123`	`}`
`124`	`124`
`125`	`125`	`/**`
`126`		`- * @param MslsOptions $options`
	`126`	`+ * @param OptionsInterface $options`
`127`	`127`	`*`
`128`		`- * @return string\|null`
	`128`	`+ * @return ?string`
`129`	`129`	`*/`
`130`	`130`	`protected function get_permalink( $options ) {`
`131`	`131`	`$url = null;`