← Back to new.*

Error Identifier: new.internalInterface

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 */
interface Handler
{
}

class DefaultHandler implements Handler
{
}

<?php declare(strict_types = 1);

// In your code:

namespace App;

use SomeLibrary\DefaultHandler;

$handler = new DefaultHandler();

Why is it reported? #

The new expression instantiates a class that implements an interface marked as @internal. Internal types are not meant to be used outside of the package or namespace where they are defined. Instantiating classes that depend on internal interfaces creates a fragile dependency on implementation details that can change without notice.

How to fix it #

Use a public (non-internal) type instead. Check whether the library provides a public factory method or a public interface for the same purpose:

-$handler = new DefaultHandler();
+$handler = HandlerFactory::create();

If you control the internal interface, consider making it public or providing a public alternative.

How to ignore this error #

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

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

Rules that report this error #

• PHPStan\Rules\InternalTag\RestrictedInternalClassNameUsageExtension [1]

Edit this page on GitHub