Error Identifier: property.internalEnum

← Back to property.*

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;
		case Inactive;
	}
}

namespace App {
	class Foo {
		public \Vendor\InternalStatus $status; // error: Property $status references internal enum Vendor\InternalStatus in its type.
	}
}

Why is it reported? #

A property’s native type declaration references an enum that is marked as @internal. Internal enums are not part of the package’s public API and may change or be removed without notice in future versions. Using an internal enum in a property type creates a fragile dependency on implementation details.

How to fix it #

Use a public (non-internal) enum or type provided by the library:

 namespace App {
 	class Foo {
-		public \Vendor\InternalStatus $status;
+		public \Vendor\PublicStatus $status;
 	}
 }

If no public alternative exists, consider reaching out to the package maintainers to request a public API for your use case.

How to ignore this error #

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

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

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]
• PHPStan\Rules\InternalTag\RestrictedInternalPropertyUsageExtension [1] [2]