PHPDoc: use @return $this for fluent methods#1362
Merged
PowerKiKi merged 1 commit intoPHPOffice:masterfrom Mar 2, 2020
caugner:return-this
Merged
PHPDoc: use @return $this for fluent methods#1362PowerKiKi merged 1 commit intoPHPOffice:masterfrom caugner:return-this
PowerKiKi merged 1 commit intoPHPOffice:masterfrom
caugner:return-this
Conversation
Contributor
Author
|
@PowerKiKi Any chance to get this merged? This fixes errors reported by Psalm like this: |
Fluent methods, especially setters, return the object on which are called. This is documented in PHPDoc using the `$this` keyword, which is equivalent to `static` with the additional notion of object identity. This helps IDEs and static analysis tools provide more meaningful output.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is:
Checklist:
Why this change is needed?
@returnannotations used wrong casing (e.g.@return CSVinstead of@return Csv)@return staticwould be more appropriate to avoid inadvertent type narrowing.@return $thisannotation is more explicit than@return static.