Improve PHPDoc types in Cluster
#2109
Open
Conversation
This file contains 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
ruflin
reviewed
Aug 12, 2022
| @@ -11,6 +11,26 @@ | |||
| * @author Ray Ward <[email protected]> | |||
| * | |||
| * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html | |||
| * | |||
| * @phpstan-type HealthData = array{ | |||
There was a problem hiding this comment.
See my comment in the other PR related to these. The question is likely mostly for my understanding.
There was a problem hiding this comment.
thePanz
reviewed
Nov 30, 2022
Comment on lines
86
to
+87
| * @return string green, yellow or red | ||
| * @phpstan-return HealthStatus |
There was a problem hiding this comment.
We could use @return 'green'|'yellow'|'red' instead of introducing virtual class ;-)
see: https://phpstan.org/writing-php-code/phpdoc-types#literals-and-constants
thePanz
reviewed
Nov 30, 2022
| @@ -8,6 +8,20 @@ | |||
| * @author Ray Ward <[email protected]> | |||
| * | |||
| * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html | |||
| * | |||
| * @phpstan-import-type HealthStatus from \Elastica\Cluster\Health | |||
| * @phpstan-import-type ShardData from Shard | |||
There was a problem hiding this comment.
should we prefer a fully-qualified-class name here?
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.
In order to reach PHPStan level 6, we need to specify iterable types, in this case this is done in the
Clusternamespace.