Error Identifier: staticProperty.internalInterface

← Back to staticProperty.*

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
	 * @property string $name
	 */
	interface Config {
	}
}

namespace App {
	function test(): mixed {
		return \Vendor\Config::$name; // error: Access to static property on internal interface Vendor\Config.
	}
}

Why is it reported? #

A static property is being accessed on an interface that is marked as @internal. Internal interfaces are not part of the public API of the package that defines them. They may change or be removed in any version without notice.

How to fix it #

Use the public API of the package instead of accessing static properties on internal interfaces:

 namespace App {
 	function test(): mixed {
-		return \Vendor\Config::$name;
+		return \Vendor\PublicConfig::$name;
 	}
 }

If the interface is internal to your own project, the error will not be reported when accessing it from within the same root namespace.

How to ignore this error #

You can use the identifier staticProperty.internalInterface to ignore this error using a comment:

// @phpstan-ignore staticProperty.internalInterface
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: staticProperty.internalInterface

Rules that report this error #

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