Error Identifier: methodTag.internalClass

← Back to methodTag.*

Every error reported by PHPStan has an error identifier. Here’s a list of all error identifiers. In PHPStan Pro you can see the error identifier next to each error and filter errors by their identifiers.

Code example #

<?php declare(strict_types = 1);

namespace Vendor {
	/** @internal */
	class InternalResult {}
}

namespace App {
	/**
	 * @method \Vendor\InternalResult doFoo()
	 */
	class MyClass {}
}

Why is it reported? #

A @method PHPDoc tag references a class that is marked as @internal. Internal classes are not part of the public API of the package that defines them. Using internal types in @method tags creates a dependency on implementation details that may change without notice in future versions of the package.

How to fix it #

Use a public (non-internal) type from the package instead:

 namespace App {
 	/**
-	 * @method \Vendor\InternalResult doFoo()
+	 * @method \Vendor\PublicResult doFoo()
 	 */
 	class MyClass {}
 }

If no public alternative exists, contact the package maintainer to request a public API, or define a local interface in the application code.

How to ignore this error #

You can use the identifier methodTag.internalClass to ignore this error using a comment:

// @phpstan-ignore methodTag.internalClass
codeThatProducesTheError();

You can also use only the identifier key to ignore all errors of the same type in your configuration file in the ignoreErrors parameter:

parameters:
	ignoreErrors:
		-
			identifier: methodTag.internalClass

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]