Error Identifier: staticMethod.internalClass

← Back to staticMethod.*

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 InternalService {
		public static function doFoo(): void {}
	}
}

namespace App {
	function test(): void {
		\Vendor\InternalService::doFoo(); // error: Call to static method doFoo() of internal class Vendor\InternalService from outside its root namespace Vendor.
	}
}

Why is it reported? #

A static method is being called on a class that is marked as @internal. Internal classes are not meant to be used outside of their own package, and calling methods on them creates a dependency on an implementation detail that can change at any time without following semantic versioning.

How to fix it #

Use the public API provided by the package instead of accessing internal classes directly:

 namespace App {
 	function test(): void {
-		\Vendor\InternalService::doFoo();
+		\Vendor\PublicService::doFoo();
 	}
 }

How to ignore this error #

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

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

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]
• PHPStan\Rules\InternalTag\RestrictedInternalMethodUsageExtension [1] [2]