Error Identifier: instanceof.internalEnum

← Back to instanceof.*

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 StatusEnum {
		case Active;
	}
}

namespace App {
	function checkStatus(object $obj): void
	{
		if ($obj instanceof \Vendor\StatusEnum) {
		}
	}
}

Why is it reported? #

The type used in the instanceof expression is an enum that has been marked as @internal. Internal enums are not part of the public API of the package that defines them. Relying on internal types in instanceof checks creates a dependency on implementation details that may change without notice in future versions of the package.

How to fix it #

Use a public interface or class provided by the package instead:

 function checkStatus(object $obj): void
 {
-	if ($obj instanceof \Vendor\StatusEnum) {
+	if ($obj instanceof \Vendor\PublicStatusInterface) {
 	}
 }

If no public alternative exists, contact the package maintainer to request a public API.

How to ignore this error #

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

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

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]