Error Identifier: methodTag.internalEnum

← 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 */
	enum InternalStatus {
		case Active;
	}
}

namespace App {
	/**
	 * @method \Vendor\InternalStatus getStatus()
	 */
	class MyClass {}
}

Why is it reported? #

A @method PHPDoc tag references an enum that is marked as @internal. Internal types are not meant to be used outside of the package or namespace where they are defined. Depending on internal types in @method tags creates a fragile dependency on implementation details that can change without notice.

How to fix it #

Use a public (non-internal) type in the @method tag instead:

 namespace App {
 	/**
-	 * @method \Vendor\InternalStatus getStatus()
+	 * @method \Vendor\PublicStatus getStatus()
 	 */
 	class MyClass {}
 }

If the library provides a public alternative, use that. Otherwise, define your own type that serves the same purpose.

How to ignore this error #

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

// @phpstan-ignore methodTag.internalEnum
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.internalEnum

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]