@phpstan-require-use for requiring implementors/subclasses to use certain traits

[brandonkelly]

Feature request

Interfaces and abstract classes should be able to specify a @phpstan-require-use tag, which tells PHPStan that implementors and subclasses are expected to use a specified trait.

For example, yii\db\QueryInterface in Yii 2 expects that implementors will use yii\db\QueryTrait.

We’ve followed that convention in Craft CMS, e.g. with craft\base\FieldInterface + craft\base\FieldTrait.

With this convention, it’s not currently possible to make PHPStan happy when targeting PHP 8.2. (Prior PHP versions were only passable thanks to PHPStan assuming that trait-defined properties were actually just dynamic properties.)

Did PHPStan help you today? Did it make you happy in any way?

It was a huge help ensuring our unit tests looked good as we were upgrading to Codeception 5!

[ondrejmirtes]

This could be paired with annotations similar to @psalm-require-extends and @psalm-require-implements: https://psalm.dev/docs/annotating_code/supported_annotations/#psalm-require-extends

[brandonkelly]

Those would be great as well!

[staabm]

@brandonkelly @ben-challis or anyone else in need of require-use:

Recently I started implementing require-extends and require-implements phpdocs into phpstan.

Afterwards I can make require-use a priority, in case we find sponsors for it.

[ondrejmirtes]

I don't think that require-use is actually a good idea because we can't rely on the method signatures to stay the same. I think that require-extends and require-implements will be sufficient.

[brandonkelly]

@require-extends is perfect. I’ll go ahead and close this.

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.