Error Identifier: traitUse.internalClass

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 */
class InternalHelper
{
}

<?php declare(strict_types = 1);

// In your code:

namespace App;

use SomeLibrary\InternalHelper;

class Foo
{
    use InternalHelper;
}

Why is it reported? #

The use statement inside a class body references a class that is marked as @internal. Internal classes are not part of the public API of the package that defines them. They may change or be removed in any version without notice.

While using a class in a use statement is already incorrect (only traits can be used this way), the internal access error is also reported because the referenced symbol is internal to another package.

How to fix it #

Only traits can be used in a class body use statement. If you need functionality from the library, look for a public trait, interface, or class that provides it:

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

-use SomeLibrary\InternalHelper;
+use SomeLibrary\PublicTrait;

 class Foo
 {
-    use InternalHelper;
+    use PublicTrait;
 }

If the class is internal to your own project, the error will not be reported when referencing it from within the same root namespace.

How to ignore this error #

You can use the identifier traitUse.internalClass to ignore this error using a comment:

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

Rules that report this error #

PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]

Edit this page on GitHub

Theme