Type property parameters via phpdoc #560
Closed
Conversation
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
And update the property constructor to better reflect that the $parameters are an array of values, not instances of the parameter class. Signed-off-by: Christoph Wurst <[email protected]>
ChristophWurst
added a commit
to nextcloud/server
that referenced
this pull request
Jan 3, 2022
Ref sabre-io/vobject#560 Signed-off-by: Christoph Wurst <[email protected]>
staabm
reviewed
Jan 3, 2022
| * List of parameters. | ||
| * | ||
| * @var array | ||
| * @var Parameter[] |
Member
There was a problem hiding this comment.
I think we should go one step further:
Suggested change
| * @var Parameter[] | |
| * @var array<string, Parameter> |
Contributor
Author
There was a problem hiding this comment.
I like that as well, yet I'm not sure how "official" that phpdoc syntax is.
Member
There was a problem hiding this comment.
its kind of proprietary syntax which is used in psalm, phpstan and most static analysis tooling.
we could also use a more tool targetting syntax, so we don't kill the "offical form":
Suggested change
| * @var Parameter[] | |
| * @phpstan-var array<string, Parameter> | |
| * @var Parameter[] |
Contributor
Author
There was a problem hiding this comment.
If you prefer this then I can add it
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
And update the property constructor to better reflect that the
$parameters are an array of values, not instances of the parameter
class.
I suppose this can be seen as part of sabre-io/dav#1368.
Context: I converted some Nextcloud code into strict code and the section with properties/parameters was not understood by PHPStorm until I made these changes.