Add PHPStan to one-off traits (#852)

srtfisher · szepeviktor · web-flow · commit 50fcbbf47c2f · 2025-12-29T08:56:17.000-05:00
* Test traits too

* Add trait tests

* Exclude trait tests from PHPCS

* Fix phpstan path

* Fix indenting

* Fix indenting

* Work on linting for traits

* Work on linting for traits

* Add PHPStan to one-off traits

---------

Co-authored-by: Viktor Szépe &lt;viktor@szepe.net&gt;
diff --git a/.gitattributes b/.gitattributes
@@ -8,6 +8,7 @@
 /phpcs.xml export-ignore
 /phpstan-baseline.neon export-ignore
 /phpstan.neon export-ignore
+/phpstan/ export-ignore
 /phpunit.xml export-ignore
 /rector.php export-ignore
 /tests export-ignore
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+### Changed
+
+- Adds PHPStan testing to more traits.
+
 ## v1.16.0
 
 ### Added
diff --git a/phpcs.xml b/phpcs.xml
@@ -17,6 +17,7 @@
 	<arg name="severity" value="1" />
 
 	<exclude-pattern>bin/</exclude-pattern>
+	<exclude-pattern>phpstan/</exclude-pattern>
 	<exclude-pattern>tests/</exclude-pattern>
 
 	<rule ref="Alley-Interactive">
diff --git a/phpstan.neon b/phpstan.neon
@@ -5,12 +5,11 @@ parameters:
 	level: 8
 
 	paths:
-		- src/mantle
+		- src/mantle/
 		- mantle.php
+		- phpstan/
 
 	ignoreErrors:
-		-
-			identifier: trait.unused
 		-
 			identifier: staticMethod.resultUnused
 		# Will be fixed in PHPStan soon.
diff --git a/phpstan/AdminScreenTraitTest.php b/phpstan/AdminScreenTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class AdminScreenTraitTest
+{
+	use Mantle\Testing\Concerns\Admin_Screen;
+}
diff --git a/phpstan/CustomPostPermalinkTraitTest.php b/phpstan/CustomPostPermalinkTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class CustomPostPermalinkTraitTest
+{
+	use Mantle\Database\Model\Concerns\Custom_Post_Permalink;
+}
diff --git a/phpstan/CustomTermLinkTraitTest.php b/phpstan/CustomTermLinkTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class CustomTermLinkTraitTest
+{
+	use Mantle\Database\Model\Concerns\Custom_Term_Link;
+}
diff --git a/phpstan/DependencyAssertionsTraitTest.php b/phpstan/DependencyAssertionsTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class DependencyAssertionsTraitTest
+{
+	use Mantle\Testing\Concerns\Dependency_Assertions;
+}
diff --git a/phpstan/DispatchableTraitTest.php b/phpstan/DispatchableTraitTest.php
@@ -0,0 +1,13 @@
+<?php
+
+use Mantle\Contracts\Queue\Job;
+
+class DispatchableTraitTest implements Job
+{
+	use Mantle\Queue\Dispatchable;
+
+	public function handle(): void
+	{
+		// Job handling logic here.
+	}
+}
diff --git a/phpstan/MultisiteTestTraitTest.php b/phpstan/MultisiteTestTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class MultisiteTestTraitTest
+{
+	use Mantle\Testing\Concerns\Multisite_Test;
+}
diff --git a/phpstan/NetworkAdminScreenTraitTest.php b/phpstan/NetworkAdminScreenTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class NetworkAdminScreenTraitTest
+{
+	use Mantle\Testing\Concerns\Network_Admin_Screen;
+}
diff --git a/phpstan/PreventRemoteRequestsTraitTest.php b/phpstan/PreventRemoteRequestsTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class PreventRemoteRequestsTraitTest
+{
+	use Mantle\Testing\Concerns\Prevent_Remote_Requests;
+}
diff --git a/phpstan/QueueableTraitTest.php b/phpstan/QueueableTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class QueueableTraitTest
+{
+	use Mantle\Queue\Queueable;
+}
diff --git a/phpstan/RegisterMetaTraitTest.php b/phpstan/RegisterMetaTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class RegisterMetaTraitTest
+{
+	use Mantle\Database\Model\Registration\Register_Meta;
+}
diff --git a/phpstan/RegisterPostTypeTraitTest.php b/phpstan/RegisterPostTypeTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class RegisterPostTypeTraitTest
+{
+	use Mantle\Database\Model\Registration\Register_Post_Type;
+}
diff --git a/phpstan/RegisterRestFieldsTraitTest.php b/phpstan/RegisterRestFieldsTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class RegisterRestFieldsTraitTest
+{
+	use Mantle\Database\Model\Registration\Register_Rest_Fields;
+}
diff --git a/phpstan/RegisterTaxonomyTraitTest.php b/phpstan/RegisterTaxonomyTraitTest.php
@@ -0,0 +1,8 @@
+<?php
+
+use Mantle\Database\Model\Term;
+
+class RegisterTaxonomyTraitTest extends Term
+{
+	use Mantle\Database\Model\Registration\Register_Taxonomy;
+}
diff --git a/phpstan/ResetDataStructuresTraitTest.php b/phpstan/ResetDataStructuresTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class ResetDataStructuresTraitTest
+{
+	use Mantle\Testing\Concerns\Reset_Data_Structures;
+}
diff --git a/phpstan/ResetServerTraitTest.php b/phpstan/ResetServerTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class ResetServerTraitTest
+{
+	use Mantle\Testing\Concerns\Reset_Server;
+}
diff --git a/phpstan/SingleSiteTraitTest.php b/phpstan/SingleSiteTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class SingleSiteTraitTest
+{
+	use Mantle\Testing\Concerns\Single_Site_Test;
+}
diff --git a/phpstan/UnregisterAllMetaKeysTraitTest.php b/phpstan/UnregisterAllMetaKeysTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class UnregisterAllMetaKeysTraitTest
+{
+	use Mantle\Testing\Concerns\Unregister_All_Meta_Keys;
+}
diff --git a/phpstan/WarnRemoteRequestsTraitTest.php b/phpstan/WarnRemoteRequestsTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class WarnRemoteRequestsTraitTest
+{
+	use Mantle\Testing\Concerns\Warn_Remote_Requests;
+}
diff --git a/phpstan/WithFakerTraitTest.php b/phpstan/WithFakerTraitTest.php
@@ -0,0 +1,6 @@
+<?php
+
+class WithFakerTraitTest
+{
+	use Mantle\Testing\Concerns\With_Faker;
+}
diff --git a/src/mantle/database/model/concerns/trait-custom-post-permalink.php b/src/mantle/database/model/concerns/trait-custom-post-permalink.php
@@ -13,6 +13,8 @@
 
 /**
  * Define custom permalink structure for post models.
+ *
+ * @mixin \Mantle\Database\Model\Post
  */
 trait Custom_Post_Permalink {
 	/**
@@ -52,7 +54,7 @@ public static function filter_post_type_link( string $post_link, \WP_Post $post
 			return $post_link;
 		}
 
-		return Permalink_Generator::create( static::get_route(), static::find_or_fail( $post->ID ) );
+		return Permalink_Generator::create( (string) static::get_route(), static::find_or_fail( $post->ID ) );
 	}
 
 	/**
@@ -66,6 +68,6 @@ public static function filter_post_type_archive_link( string $link, string $post
 			return $link;
 		}
 
-		return Permalink_Generator::create( static::get_archive_route() );
+		return Permalink_Generator::create( (string) static::get_archive_route() );
 	}
 }
diff --git a/src/mantle/database/model/concerns/trait-custom-term-link.php b/src/mantle/database/model/concerns/trait-custom-term-link.php
@@ -12,11 +12,13 @@
 use function Mantle\Support\Helpers\add_filter;
 
 /**
- * Define custom permalink structure for post models.
+ * Define custom permalink structure for term models.
+ *
+ * @mixin \Mantle\Database\Model\Term
  */
 trait Custom_Term_Link {
 	/**
-	 * Boot the trait and add filters for the post type link single and archive link.
+	 * Boot the trait and add filters for the term link.
 	 */
 	public static function boot_custom_term_link(): void {
 		if ( static::get_route() ) {
@@ -36,6 +38,6 @@ public static function filter_term_link( string $term_link, \WP_Term $term, stri
 			return $term_link;
 		}
 
-		return Permalink_Generator::create( static::get_route(), static::find_or_fail( $term->term_id ) );
+		return Permalink_Generator::create( (string) static::get_route(), static::find_or_fail( $term->term_id ) );
 	}
 }
diff --git a/src/mantle/database/model/registration/trait-register-meta.php b/src/mantle/database/model/registration/trait-register-meta.php
@@ -15,13 +15,15 @@
 
 /**
  * Model Trait to register meta for a model.
+ *
+ * @mixin \Mantle\Database\Model\Model
  */
 trait Register_Meta {
 	/**
 	 * Register the object's meta.
 	 */
 	public static function boot_register_meta(): void {
-		\add_action( 'init', [ self::class, 'register_meta' ], 11 );
+		\add_action( 'init', [ self::class, 'register_meta' ], 11 ); // @phpstan-ignore-line return.void
 	}
 
 	/**
@@ -53,16 +55,16 @@ public static function boot_register_meta(): void {
 	 *                                         array with 'schema' or 'prepare_callback' keys instead of a boolean.
 	 * }
 	 * @phpstan-param array{
-	 *   object_subtype: string,
-	 *   type: string,
-	 *   description: string,
-	 *   single: bool,
-	 *   default: mixed,
-	 *   sanitize_callback: callable,
-	 *   auth_callback: callable,
-	 *   show_in_rest: bool|array{
-	 *      schema: array<mixed>,
-	 *      prepare_callback: callable,
+	 *   object_subtype?: string,
+	 *   type?: string,
+	 *   description?: string,
+	 *   single?: bool,
+	 *   default?: mixed,
+	 *   sanitize_callback?: callable,
+	 *   auth_callback?: callable,
+	 *   show_in_rest?: bool|array{
+	 *      schema?: array<mixed>,
+	 *      prepare_callback?: callable,
 	 *   }
 	 * } $args
 	 * @return bool True if the meta key was successfully registered in the global array, false if not.
@@ -83,7 +85,9 @@ public static function register_meta( string $meta_key, array $args = [] ): bool
 			$args,
 		);
 
-		return register_meta( static::get_object_type(), $meta_key, $args );
+		$object_type = static::get_object_type();
+
+		return $object_type ? register_meta( $object_type, $meta_key, $args ) : false;
 	}
 
 	/**
diff --git a/src/mantle/database/model/registration/trait-register-post-type.php b/src/mantle/database/model/registration/trait-register-post-type.php
@@ -12,6 +12,9 @@
 
 /**
  * Model Trait to allow a post type to be registered for a model.
+ *
+ * @mixin \Mantle\Database\Model\Post
+ * @mixin \Mantle\Contracts\Database\Registrable
  */
 trait Register_Post_Type {
 	use Custom_Post_Permalink;
@@ -31,10 +34,15 @@ public static function boot_register_post_type(): void {
 	public static function register_object(): void {
 		$post_type = static::get_object_name();
 
+		if ( ! $post_type ) {
+			throw new Model_Exception( 'Unable to register post type (no post type name provided).' );
+		}
+
 		if ( \post_type_exists( $post_type ) ) {
 			throw new Model_Exception( 'Unable to register post type (post type already exists): ' . $post_type );
 		}
 
+		// @phpstan-ignore argument.type
 		$register = \register_post_type( $post_type, static::get_registration_args() ); // phpcs:ignore WordPress.NamingConventions.ValidPostTypeSlug.NotStringLiteral
 
 		if ( is_wp_error( $register ) ) {
diff --git a/src/mantle/database/model/registration/trait-register-rest-fields.php b/src/mantle/database/model/registration/trait-register-rest-fields.php
@@ -16,6 +16,8 @@
 
 /**
  * Model Trait to REST Fields to be registered for a model.
+ *
+ * @mixin \Mantle\Database\Model\Post|\Mantle\Database\Model\Term
  */
 trait Register_Rest_Fields {
 	/**
@@ -47,7 +49,7 @@ public static function boot_register_rest_fields(): void {
 	 * @throws Model_Exception Thrown when registering a post type that is already registered.
 	 */
 	public static function register_fields(): void {
-		if ( ! isset( static::$rest_registrar ) ) {
+		if ( ! isset( static::$rest_registrar ) ) { // @phpstan-ignore-line isset.property
 			$class = static::class;
 			throw new Model_Exception( "REST field registrar is not defined for [{$class}]" );
 		}
@@ -59,15 +61,15 @@ public static function register_fields(): void {
 	 * Register a REST API field.
 	 *
 	 * @param REST_Field|string $attribute Field instance/field attribute to register.
-	 * @param Closure|string    $get_callback Callback for the field if $field isn't a field.
+	 * @param ?callable         $get_callback Callback for the field if $field isn't a field.
 	 * @return Rest_Field
 	 *
 	 * @throws Model_Exception Thrown on missing REST Registrar.
 	 *
 	 * @todo Allow for creation of a a REST Field from a SML REST Field.
 	 */
-	public static function register_field( $attribute, $get_callback = null ): Rest_Field {
-		if ( ! isset( static::$rest_registrar ) ) {
+	public static function register_field( $attribute, ?callable $get_callback = null ): Rest_Field {
+		if ( ! isset( static::$rest_registrar ) ) { // @phpstan-ignore-line isset.property
 			$class = static::class;
 			throw new Model_Exception( "REST field registrar is not defined for [{$class}]" );
 		}
@@ -82,9 +84,16 @@ public static function register_field( $attribute, $get_callback = null ): Rest_
 			throw new Model_Exception( "Missing callback for REST field [{$attribute}]" );
 		}
 
-		$field = new Rest_Field( [ static::get_object_name() ], $attribute, $get_callback );
+		$object_name = static::get_object_name();
+
+		if ( ! $object_name ) {
+			throw new Model_Exception( "Cannot register REST field [{$attribute}] on model with no object name." );
+		}
+
+		$field = new Rest_Field( [ $object_name ], $attribute, $get_callback );
 
 		static::$rest_fields[ $attribute ] = $field;
+
 		return $field;
 	}
 }
diff --git a/src/mantle/database/model/registration/trait-register-taxonomy.php b/src/mantle/database/model/registration/trait-register-taxonomy.php
diff --git a/src/mantle/testing/concerns/trait-admin-screen.php b/src/mantle/testing/concerns/trait-admin-screen.php
diff --git a/src/mantle/testing/concerns/trait-dependency-assertions.php b/src/mantle/testing/concerns/trait-dependency-assertions.php
diff --git a/src/mantle/testing/concerns/trait-makes-http-requests.php b/src/mantle/testing/concerns/trait-makes-http-requests.php
diff --git a/src/mantle/testing/concerns/trait-multisite-test.php b/src/mantle/testing/concerns/trait-multisite-test.php
diff --git a/src/mantle/testing/concerns/trait-network-admin-screen.php b/src/mantle/testing/concerns/trait-network-admin-screen.php
diff --git a/src/mantle/testing/concerns/trait-prevent-remote-requests.php b/src/mantle/testing/concerns/trait-prevent-remote-requests.php
diff --git a/src/mantle/testing/concerns/trait-single-site-test.php b/src/mantle/testing/concerns/trait-single-site-test.php
diff --git a/src/mantle/testing/concerns/trait-warn-remote-requests.php b/src/mantle/testing/concerns/trait-warn-remote-requests.php
diff --git a/src/mantle/testing/concerns/trait-wordpress-state.php b/src/mantle/testing/concerns/trait-wordpress-state.php

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +<?php
++
 +class AdminScreenTraitTest
 +{
 +	use Mantle\Testing\Concerns\Admin_Screen;
 +}