← Back to interface.*

Error Identifier: interface.extendsInternalClass

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 InternalClass
{
}

<?php declare(strict_types = 1);

// In your code:

namespace App;

use SomeLibrary\InternalClass;

interface MyInterface extends InternalClass
{
}

Why is it reported? #

An interface extends a type that is marked as @internal. Internal types are not part of the package’s public API and may change or be removed without notice. Depending on internal types in your interface definitions makes your code fragile.

How to fix it #

Use a public (non-internal) type instead. 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 interface.extendsInternalClass to ignore this error using a comment:

// @phpstan-ignore interface.extendsInternalClass
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: interface.extendsInternalClass

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]

Edit this page on GitHub