Drupal Check incorrectly reporting "missing methods" on Interfaces, when methods actually exist on implementing class.

[lhridley]

How is drupal-check installed?

drupal-check is installed globally via Composer

Environment:

• OS: Linux
• PHP Version: 8.0
• Drupal core: 10.x.x (aliased as 9.3)

Describe the bug
Expected Behavior -- no detected errors

Actual Behavior -- errors flagged for "undefined method" on Interface.

The classes in question actually extends a Drupal Class that implements Drupal\Core\Entity\EntityInterface, but the declaration of the methods are not required on the Interface itself. So, it appears that the scanner is incorrectly flagging this as an "undefined method" on the Interface, even though the method is defined for the module's class in questions.

Console output

Link to public project Github Actions output:

• https://github.com/80-20-Components/environment_indicator/runs/4623029598?check_suite_focus=true#step:12:22
• https://github.com/80-20-Components/environment_indicator/runs/4623029598?check_suite_focus=true#step:12:24
• https://github.com/80-20-Components/environment_indicator/runs/4623029598?check_suite_focus=true#step:12:26
• https://github.com/80-20-Components/environment_indicator/runs/4623029598?check_suite_focus=true#step:12:33
• https://github.com/80-20-Components/environment_indicator/runs/4623029598?check_suite_focus=true#step:12:35
• https://github.com/80-20-Components/environment_indicator/runs/4623029598?check_suite_focus=true#step:12:37

[mglaman]

You need to type hint your code, then.

[lhridley]

Thank @mglaman !

[mglaman]

@lhridley sorry for the quick reply earlier, so use /** @var */ or my favorite instanceof in if or assert.

Should I add documentation about this in this project, phpstan-drupal, or even Drupal.org?

[lhridley]

Hey @mglaman -- your comment is sufficient to point me in the right direction, but the error thrown is a bit cryptic.

A more helpful and informative message would be extremely useful thought.

If the message can't be made more informative somehow, then some documentation would be most helpful.

[mglaman]

The message can't really be improved. And we can't easily enhance it. So documentation on how to write more "aware" code vis type hinting is needed.

[mglaman]

I've started here: https://www.drupal.org/docs/develop/development-tools/phpstan

I'll add a page about non-existent methods and type hinting later today