Docblock comments on DataList shadow SS_List's more useful PHPDoc types in PHPStorm (::first, ::byID, ::find, ::filter, etc.) about silverstripe-framework

[emteknetnz]

Targetting 5.2 is fine for this particular enhancement, it's not changing the functional behaviour of any classes.

Means you'll get your patch release immediately instead of having to wait several months.

[emteknetnz]

Closing because this is an issue with PHPStorm, not with Silverstripe

The type hinting works correctly in VSCode, at least with the PHP Intelephense plugin - with the example above I was correctly type hinted for a Member. Type hinting was greatly improved in 5.2 with generic type hints

[MasonD]

@emteknetnz I don't understand this stance? I agree that 5.2 is a huge improvement, and was running my own stubs with generic type hints before 5.2. But the reason for adding the generic type hints is to improve dev experience, and the current types don't work with PHPStorm's analysis but would work with just the inclusion of @inheritDoc.

Is there something I'm missing about @inheritDoc that would make its inclusion in the docblocks of DataList methods in order to support PHPStorm unfeasible? If it degrades the experience in other editors I'd concede that that's not a trade to make, but if all it does is improve PHPStorm support, I think that's worth it. I'd be willing to create the PR.

[kinglozzer]

Seems like a pretty trivial fix, and given the prevalence of PHPStorm I think it’s worthwhile. Some of the comments in DataList do contain a bit more (DataObject-specific) info than the methods they’re overriding, so rather than using @inheritDoc it might be better to copy the return types down in some places. Do you want to have a crack at a PR @MasonD?

[MasonD]

Sure. Which branch would you like me to target it on?

[kinglozzer]

I think 5 rather than 5.2, because I suppose this is more an enhancement for PHPStorm users than an bug fix

[emteknetnz]

Linked PR has been merged, it will be automatically tagged shortly