Error Identifier: class.extendsInternalTrait

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 vendor/some-package/src/InternalTrait.php:
// /** @internal */
// trait InternalTrait {}

// In your code:
class MyClass extends \SomePackage\InternalTrait
{
}

Why is it reported? #

The class extends a type that is marked as @internal and is a trait. Internal types are not part of the package’s public API and may change or be removed without notice in future versions. Additionally, traits cannot be extended in PHP – they should be used with the use keyword instead.

How to fix it #

Do not extend internal traits. If a trait is needed, use the use keyword with a non-internal trait, and rely on the package’s public API:

 <?php declare(strict_types = 1);
 
-class MyClass extends \SomePackage\InternalTrait
+class MyClass
 {
+    // Use the package's public API instead
 }

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

// @phpstan-ignore class.extendsInternalTrait
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: class.extendsInternalTrait

Rules that report this error #

PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]

Edit this page on GitHub

Theme