Error Identifier: catch.internalClass

← Back to catch.*

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 */
	class InternalException extends \Exception {}
}

namespace App {
	function doFoo(): void
	{
		try {
			throw new \Exception();
		} catch (\Vendor\InternalException $e) {
		}
	}
}

Why is it reported? #

A catch block is catching an exception class that is marked as @internal. Internal classes are not meant to be used outside of the package or namespace where they are defined. Catching internal exceptions creates a dependency on implementation details that may change without notice in future versions.

How to fix it #

Catch a public (non-internal) parent exception class instead:

 try {
 	throw new \Exception();
-} catch (\Vendor\InternalException $e) {
+} catch (\RuntimeException $e) {
 }

If the library provides a public exception class or interface for this purpose, catch that instead.

How to ignore this error #

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

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

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]