PHPStan issues addressed

lloc · lloc · commit 314a63496d26 · 2024-08-23T15:34:38.000+02:00
diff --git a/includes/ContentImport/ContentImporter.php b/includes/ContentImport/ContentImporter.php
@@ -50,7 +50,7 @@ class ContentImporter extends MslsRegistryInstance {
 	 * @param \lloc\Msls\MslsMain|null $main
 	 */
 	public function __construct( MslsMain $main = null ) {
-		$this->main = $main ?: MslsMain::init();
+		$this->main = $main ?: MslsMain::create();
 	}
 
 	/**
diff --git a/includes/MslsAdmin.php b/includes/MslsAdmin.php
@@ -29,13 +29,9 @@ class MslsAdmin extends MslsMain {
 	public const MAX_REFERENCE_USERS = 100;
 
 	/**
-	 * Factory
-	 *
 	 * @codeCoverageIgnore
-	 *
-	 * @return MslsAdmin
 	 */
-	public static function init() {
+	public static function init(): void {
 		$obj = MslsRegistry::get_object( __CLASS__ );
 		if ( ! $obj ) {
 			$obj = new static( msls_options(), msls_blog_collection() );
@@ -60,8 +56,6 @@ public static function init() {
 				add_filter( 'msls_admin_validate', array( $obj, 'set_blog_language' ) );
 			}
 		}
-
-		return $obj;
 	}
 
 	/**
diff --git a/includes/MslsBlogCollection.php b/includes/MslsBlogCollection.php
@@ -179,9 +179,9 @@ public function get_blog( $language ) {
 	 *
 	 * @param string $language
 	 *
-	 * @return string|null
+	 * @return ?int
 	 */
-	public function get_blog_id( $language ) {
+	public function get_blog_id( string $language ): ?int {
 		$blog    = $this->get_blog( $language );
 		$blog_id = ! is_null( $blog ) ? $blog->userblog_id : null;
 
diff --git a/includes/MslsContentFilter.php b/includes/MslsContentFilter.php
@@ -43,7 +43,7 @@ public function content_filter( string $content ) {
 	 * @return string
 	 */
 	public function filter_string( $pref = '<p id="msls">', $post = '</p>' ) {
-		$links_arr = MslsOutput::init()->get( 1, true, true );
+		$links_arr = MslsOutput::create()->get( 1, true, true );
 		$links_str = $this->format_available_languages( $links_arr );
 
 		/* translators: %s: list of languages */
diff --git a/includes/MslsCustomColumn.php b/includes/MslsCustomColumn.php
@@ -11,13 +11,9 @@
 class MslsCustomColumn extends MslsMain {
 
 	/**
-	 * Factory
-	 *
 	 * @codeCoverageIgnore
-	 *
-	 * @return MslsCustomColumn
 	 */
-	public static function init() {
+	public static function init(): void {
 		$options    = msls_options();
 		$collection = msls_blog_collection();
 		$obj        = new static( $options, $collection );
@@ -31,8 +27,6 @@ public static function init() {
 				add_action( 'trashed_post', array( $obj, 'delete' ) );
 			}
 		}
-
-		return $obj;
 	}
 
 	/**
diff --git a/includes/MslsCustomColumnTaxonomy.php b/includes/MslsCustomColumnTaxonomy.php
@@ -11,13 +11,9 @@
 class MslsCustomColumnTaxonomy extends MslsCustomColumn {
 
 	/**
-	 * Factory
-	 *
 	 * @codeCoverageIgnore
-	 *
-	 * @return MslsCustomColumnTaxonomy
 	 */
-	public static function init() {
+	public static function init(): void {
 		$options    = msls_options();
 		$collection = msls_blog_collection();
 		$obj        = new static( $options, $collection );
@@ -31,8 +27,6 @@ public static function init() {
 				add_action( "delete_{$taxonomy}", array( $obj, 'delete' ) );
 			}
 		}
-
-		return $obj;
 	}
 
 	/**
diff --git a/includes/MslsCustomFilter.php b/includes/MslsCustomFilter.php
@@ -13,13 +13,9 @@
 class MslsCustomFilter extends MslsMain {
 
 	/**
-	 * Init
-	 *
 	 * @codeCoverageIgnore
-	 *
-	 * @return MslsCustomFilter
 	 */
-	public static function init() {
+	public static function init(): void {
 		$options    = msls_options();
 		$collection = msls_blog_collection();
 		$obj        = new static( $options, $collection );
@@ -37,8 +33,6 @@ function () {
 				);
 			}
 		}
-
-		return $obj;
 	}
 
 	/**
diff --git a/includes/MslsMain.php b/includes/MslsMain.php
@@ -38,10 +38,8 @@ public function __construct( MslsOptions $options, MslsBlogCollection $collectio
 	 * Factory
 	 *
 	 * @codeCoverageIgnore
-	 *
-	 * @return static
 	 */
-	public static function init() {
+	public static function create() {
 		return new static( msls_options(), msls_blog_collection() );
 	}
 
diff --git a/includes/MslsMetaBox.php b/includes/MslsMetaBox.php
@@ -89,13 +89,9 @@ public static function get_suggested_fields( $json, $args ) {
 	}
 
 	/**
-	 * Init
-	 *
 	 * @codeCoverageIgnore
-	 *
-	 * @return MslsMetaBox
 	 */
-	public static function init(): MslsMetaBox {
+	public static function init(): void {
 		$options = msls_options();
 		$obj     = new static( $options, msls_blog_collection() );
 
@@ -104,8 +100,6 @@ public static function init(): MslsMetaBox {
 			add_action( 'save_post', array( $obj, 'set' ) );
 			add_action( 'trashed_post', array( $obj, 'delete' ) );
 		}
-
-		return $obj;
 	}
 
 	/**
diff --git a/includes/MslsOutput.php b/includes/MslsOutput.php
@@ -14,22 +14,18 @@ class MslsOutput extends MslsMain {
 	/**
 	 * Holds the format for the output
 	 *
-	 * @var array $tags
+	 * @var array<string, string>
 	 */
-	protected $tags;
+	protected array $tags;
 
 	/**
-	 * Creates and gets the output as an array
-	 *
 	 * @param int  $display
 	 * @param bool $filter
 	 * @param bool $exists
 	 *
-	 * @return array
-	 * @uses MslsLink
-	 * @uses MslsOptions
+	 * @return string[]
 	 */
-	public function get( $display, $filter = false, $exists = false ) {
+	public function get( int $display, bool $filter = false, bool $exists = false ) {
 		$arr = array();
 
 		$blogs = $this->collection->get_filtered( $filter );
diff --git a/includes/MslsPlugin.php b/includes/MslsPlugin.php
@@ -29,13 +29,9 @@ public function __construct( MslsOptions $options ) {
 	}
 
 	/**
-	 * Factory
-	 *
 	 * @codeCoverageIgnore
-	 *
-	 * @return MslsPlugin
 	 */
-	public static function init() {
+	public static function init(): void {
 		$obj = new self( msls_options() );
 
 		add_action( 'plugins_loaded', array( $obj, 'init_i18n_support' ) );
@@ -103,8 +99,6 @@ function () {
 				}
 			);
 		}
-
-		return $obj;
 	}
 
 	/**
@@ -116,7 +110,7 @@ public static function get_output() {
 		static $obj = null;
 
 		if ( is_null( $obj ) ) {
-			$obj = MslsOutput::init();
+			$obj = MslsOutput::create();
 		}
 
 		return $obj;
diff --git a/includes/MslsPostTag.php b/includes/MslsPostTag.php
@@ -21,15 +21,17 @@ class MslsPostTag extends MslsMain {
 	 * Echo a JSON-ified array of posts of the given post-type and
 	 * the requested search-term and then die silently
 	 */
-	public static function suggest() {
+	public static function suggest(): void {
 		$json = new MslsJson();
 
 		if ( MslsRequest::has_var( MslsFields::FIELD_BLOG_ID ) ) {
 			switch_to_blog(
 				MslsRequest::get_var( MslsFields::FIELD_BLOG_ID )
 			);
 
-			$args = array(
+			$post_type = MslsRequest::get( MslsFields::FIELD_POST_TYPE, '' );
+			$args      = array(
+				'taxonomy'   => sanitize_text_field( $post_type ),
 				'orderby'    => 'name',
 				'order'      => 'ASC',
 				'number'     => 10,
@@ -49,19 +51,18 @@ public static function suggest() {
 			 *
 			 * @since 0.9.9
 			 */
-			$args      = (array) apply_filters( 'msls_post_tag_suggest_args', $args );
-			$post_type = MslsRequest::get( MslsFields::FIELD_POST_TYPE, '' );
-			foreach ( get_terms( sanitize_text_field( $post_type ), $args ) as $term ) {
+			$args = (array) apply_filters( 'msls_post_tag_suggest_args', $args );
+			foreach ( get_terms( $args ) as $term ) {
 				/**
 				 * Manipulates the term object before using it
 				 *
-				 * @param \StdClass $term
+				 * @param int|string|\WP_Term $term
 				 *
 				 * @since 0.9.9
 				 */
 				$term = apply_filters( 'msls_post_tag_suggest_term', $term );
 
-				if ( is_object( $term ) ) {
+				if ( $term instanceof \WP_Term ) {
 					$json->add( $term->term_id, $term->name );
 				}
 			}
@@ -75,10 +76,8 @@ public static function suggest() {
 	 * Init
 	 *
 	 * @codeCoverageIgnore
-	 *
-	 * @return MslsPostTag
 	 */
-	public static function init() {
+	public static function init(): void {
 		$options    = msls_options();
 		$collection = msls_blog_collection();
 		$class      = $options->activate_autocomplete ? self::class : MslsPostTagClassic::class;
@@ -91,8 +90,6 @@ public static function init() {
 			add_action( "edited_{$taxonomy}", array( $obj, 'set' ) );
 			add_action( "create_{$taxonomy}", array( $obj, 'set' ) );
 		}
-
-		return $obj;
 	}
 
 	/**
@@ -207,7 +204,7 @@ public function the_input( ?\WP_Term $tag, string $title_format, string $item_fo
 	 *
 	 * @codeCoverageIgnore
 	 */
-	public function set( $term_id ) {
+	public function set( $term_id ): void {
 		if ( MslsContentTypes::create()->acl_request() ) {
 			$this->save( $term_id, MslsOptionsTax::class );
 		}
diff --git a/includes/MslsWidget.php b/includes/MslsWidget.php
@@ -62,7 +62,7 @@ public function widget( $args, $instance ) {
 			$title = $args['before_title'] . esc_attr( $title ) . $args['after_title'];
 		}
 
-		$content = MslsOutput::init()->__toString();
+		$content = MslsOutput::create()->__toString();
 		if ( '' === $content ) {
 			$text    = __( 'No available translations found', 'multisite-language-switcher' );
 			$content = apply_filters( 'msls_widget_alternative_content', $text );

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ class ContentImporter extends MslsRegistryInstance {`
`50`	`50`	`* @param \lloc\Msls\MslsMain\|null $main`
`51`	`51`	`*/`
`52`	`52`	`public function __construct( MslsMain $main = null ) {`
`53`		`- $this->main = $main ?: MslsMain::init();`
	`53`	`+ $this->main = $main ?: MslsMain::create();`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -179,9 +179,9 @@ public function get_blog( $language ) {`
`179`	`179`	`*`
`180`	`180`	`* @param string $language`
`181`	`181`	`*`
`182`		`- * @return string\|null`
	`182`	`+ * @return ?int`
`183`	`183`	`*/`
`184`		`- public function get_blog_id( $language ) {`
	`184`	`+ public function get_blog_id( string $language ): ?int {`
`185`	`185`	`$blog = $this->get_blog( $language );`
`186`	`186`	`$blog_id = ! is_null( $blog ) ? $blog->userblog_id : null;`
`187`	`187`
Original file line number	Diff line number	Diff line change
`@@ -38,10 +38,8 @@ public function __construct( MslsOptions $options, MslsBlogCollection $collectio`
`38`	`38`	`* Factory`
`39`	`39`	`*`
`40`	`40`	`* @codeCoverageIgnore`
`41`		`- *`
`42`		`- * @return static`
`43`	`41`	`*/`
`44`		`- public static function init() {`
	`42`	`+ public static function create() {`
`45`	`43`	`return new static( msls_options(), msls_blog_collection() );`
`46`	`44`	`}`
`47`	`45`