Error Identifier: typeAlias.internalEnum

← Back to typeAlias.*

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); // lint >= 8.1

namespace ThirdParty {
	/** @internal */
	enum InternalStatus {
		case Active;
		case Inactive;
	}
}

namespace App {
	/**
	 * @phpstan-type StatusList list<\ThirdParty\InternalStatus>
	 */
	class MyClass
	{
	}
}

Why is it reported? #

The type alias defined with @phpstan-type references an enum that is marked as @internal. Internal symbols are not meant to be used outside the package or namespace that defines them. Referencing an internal enum in a type alias creates a dependency on an implementation detail that may change without notice in future versions of the package.

How to fix it #

Replace the internal enum with a public type in the type alias:

 <?php declare(strict_types = 1);
 
 namespace App;

-use ThirdParty\InternalStatus;
+use ThirdParty\PublicStatusInterface;

 /**
- * @phpstan-type StatusList list<InternalStatus>
+ * @phpstan-type StatusList list<PublicStatusInterface>
  */
 class MyClass
 {
 }

If the enum is internal to the same package, the error will not be reported. The @internal restriction only applies to cross-package usage.

How to ignore this error #

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

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

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]