Error Identifier: attribute.internalClass

← Back to attribute.*

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 */
	#[\Attribute]
	class InternalAttribute {}
}

namespace App {
	use Vendor\InternalAttribute;

	#[InternalAttribute]
	class Foo {}
}

Why is it reported? #

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

How to fix it #

Use a public (non-internal) attribute class instead:

 namespace App;

-use Vendor\InternalAttribute;
+use Vendor\PublicAttribute;

-#[InternalAttribute]
+#[PublicAttribute]
 class Foo {}

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

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

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]