← Back to attribute.*

Error Identifier: attribute.internalEnum

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);

// In package vendor/some-library:

namespace SomeLibrary;

/** @internal */
enum Priority: int
{
	case Low = 1;
	case High = 2;
}

<?php declare(strict_types = 1);

// In your code:

namespace App;

use SomeLibrary\Priority;

#[Priority]
class Foo
{
}

Why is it reported? #

An attribute 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 your attributes creates a fragile dependency on implementation details that can change without notice.

In the example above, the #[Priority] attribute references the internal Priority enum from SomeLibrary.

How to fix it #

Use a public (non-internal) type as the attribute instead. If the library provides a public attribute class or enum, use that. Otherwise, define your own attribute:

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

-use SomeLibrary\Priority;
+#[\Attribute]
+class Priority
+{
+	public function __construct(public int $level = 1)
+	{
+	}
+}

-#[Priority]
+#[Priority(level: 2)]
 class Foo
 {
 }

How to ignore this error #

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

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

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]

Edit this page on GitHub