Error Identifier: propertyTag.internalEnum

← Back to propertyTag.*

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 InternalEnum {
		case A;
	}
}

namespace App {
	/**
	 * @property \Vendor\InternalEnum $status
	 */
	class MyClass {}
}

Why is it reported? #

A @property PHPDoc tag references an enum that is marked as @internal. Internal types are not part of the package’s public API and may change or be removed without notice.

How to fix it #

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

 namespace App {
 	/**
-	 * @property \Vendor\InternalEnum $status
+	 * @property \Vendor\PublicEnum $status
 	 */
 	class MyClass {}
 }

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 propertyTag.internalEnum to ignore this error using a comment:

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

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]