Error Identifier: assert.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 Checker
{
	/**
	 * @phpstan-assert InternalHelper $value
	 */
	public function assertHelper(mixed $value): void
	{
		// ...
	}
}

Why is it reported? #

A @phpstan-assert PHPDoc tag references a class that is marked as @internal. Internal types are not part of the package’s public API and may change or be removed without notice in future versions. Depending on internal types in your assertions creates a fragile dependency on implementation details.

How to fix it #

Use a public (non-internal) type in the @phpstan-assert tag instead:

 <?php declare(strict_types = 1);
 
 class Checker
 {
 	/**
-	 * @phpstan-assert InternalHelper $value
+	 * @phpstan-assert PublicHelper $value
 	 */
 	public function assertHelper(mixed $value): void
 	{
 		// ...
 	}
 }

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

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

Rules that report this error #

PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]

Edit this page on GitHub

Theme