Error Identifier: sealed.internalTrait

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

// Defined in a third-party package:
// /** @internal */
// trait InternalTrait {}

use ThirdParty\InternalTrait;

/**
 * @phpstan-sealed InternalTrait
 */
interface HandlerProvider
{
}

Why is it reported? #

The @phpstan-sealed PHPDoc tag references a trait that is marked as @internal in another package. Internal traits are not part of the public API of their package and may change or be removed at any time. Referencing them in a @phpstan-sealed tag creates a dependency on an implementation detail that could break without notice.

How to fix it #

Reference only public (non-internal) types in @phpstan-sealed tags:

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

-use ThirdParty\InternalTrait;
+use ThirdParty\PublicClass;

 /**
- * @phpstan-sealed InternalTrait
+ * @phpstan-sealed PublicClass
  */
 interface HandlerProvider
 {
 }

If the trait is internal to the same package, the error will not be reported. The @internal restriction only applies to cross-package usage.

How to ignore this error #

You can use the identifier sealed.internalTrait to ignore this error using a comment:

// @phpstan-ignore sealed.internalTrait
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: sealed.internalTrait

Rules that report this error #

PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]

Edit this page on GitHub

Theme