Node is not subtype of NodeInterface.. says phpstan.

[donquixote]

Bug report

When I use an inline @var doc to describe an entity which was only type-hinted from the entity interface, phpstan says the entity class is not a subtype of the entity interface.

This happens with Drupal entity classes, but not with regular old classes and interfaces like \Reflector and \ReflectionClass.

So I suspect it is a side effect from phpstan-drupal.

Code snippet that reproduces the problem

use Drupal\node\NodeInterface;
class C {
  /**
   * @param \Drupal\node\NodeInterface $node
   *
   * @return mixed
   */
  public function foo(NodeInterface $node): mixed {
    /** @var \Drupal\node\Entity\Node $node */
    return $node;
  }
}

 ------ ------------------------------------------------------------------------------------------------------------ 
  Line   src/Service/AdvancedEntityAutocompleteMatcher.php                                                           
 ------ ------------------------------------------------------------------------------------------------------------ 
  **     PHPDoc tag @var with type Drupal\node\Entity\Node is not subtype of native type Drupal\node\NodeInterface.  
         🪪  varTag.nativeType                                                                                       
 ------ ------------------------------------------------------------------------------------------------------------

Why would I do this?

I have a project with some magic __set() assign like $entity->x = $y. The entity is type-hinted using an entity interface, and phpstan (level 2) complains that the property does not exist.

For now I want a stop-gap solution that makes phpstan happy but does not change the code itself, because this part is not really tested yet.

[mglaman]

Mobile, so hard to find: but the README should have instructions how to turn off stubs and other magic things, can you try turning some stuff off and seeing what happens?

[mably]

Don't know if it's directly related but PHPStan cannot find NodeInterface when analyzing my module:

 ------ ----------------------------------------------------------------------- 
  Line   modules/term_glossary_per_node/src/Service/TermGlossaryPerNodeManager  
         .php                                                                   
 ------ ----------------------------------------------------------------------- 
  29     Class Drupal\node\NodeInterface not found.                             
         🪪  class.notFound                                                     
         💡  Learn more at https://phpstan.org/user-guide/discovering-symbols   
 ------ -----------------------------------------------------------------------

Related job: https://git.drupalcode.org/project/term_glossary/-/jobs/8286021

[mably]

Temporary workaround: add this to your composer.json file (thanks to @jsacksick):

"conflict": {
    "phpstan/phpstan": ">2.1.33"
},

Tested successfully.

EDIT: The problem is the requirement will bubble up to the project requirements.

[mglaman]

I've had no time to look into this. But didn't 2.1.34 introduce some performance work? Maybe phpstan-drupal is causing some conflicts with it. https://github.com/phpstan/phpstan/releases/tag/2.1.34 I'll try to dig in

[donquixote]

In a project where I had this problem, it has now gone away.
I have no idea why. Maybe core version.

EDIT: Yeah phpstan version could be it. Trying.

EDIT: No, I can't make sense of it.