Improve class constant static analysis #7154
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # AmbiguousConstantInheritance | ||
|
|
||
| Emitted when a constant is inherited from multiple sources. | ||
|
|
||
| ```php | ||
| <?php | ||
|
|
||
| interface Foo | ||
| { | ||
| /** @var non-empty-string */ | ||
| public const CONSTANT='foo'; | ||
| } | ||
|
|
||
| interface Bar | ||
| { | ||
| /** | ||
| * @var non-empty-string | ||
| */ | ||
| public const CONSTANT='bar'; | ||
| } | ||
|
|
||
| interface Baz extends Foo, Bar {} | ||
| ``` | ||
|
|
||
| ```php | ||
| <?php | ||
|
|
||
| interface Foo | ||
| { | ||
| /** @var non-empty-string */ | ||
| public const CONSTANT='foo'; | ||
| } | ||
|
|
||
| class Bar | ||
| { | ||
| /** @var non-empty-string */ | ||
| public const CONSTANT='bar'; | ||
| } | ||
|
|
||
| class Baz extends Bar implements Foo {} | ||
| ``` | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # LessSpecificClassConstantType | ||
|
|
||
| Emitted when a constant type in a child is less specific than the type in the parent. | ||
|
|
||
| ```php | ||
| <?php | ||
|
|
||
| class Foo | ||
| { | ||
| /** @var int<1,max> */ | ||
| public const CONSTANT = 3; | ||
|
|
||
| public static function bar(): array | ||
| { | ||
| return str_split("foobar", static::CONSTANT); | ||
| } | ||
| } | ||
|
|
||
| class Bar extends Foo | ||
| { | ||
| /** @var int */ | ||
| public const CONSTANT = -1; | ||
| } | ||
|
|
||
| Bar::bar(); // Error: str_split argument 2 must be greater than 0 | ||
| ``` | ||
|
|
||
| This issue will always show up when overriding a constant that doesn't have a docblock type. Psalm will infer the most specific type for the constant that it can, you have to add a type annotation to tell it what type constraint you wish to be applied. Otherwise Psalm has no way of telling if you mean for the constant to be a literal `1`, `int<1, max>`, `int`, `numeric`, etc. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # OverriddenInterfaceConstant | ||
|
|
||
| Emitted when a constant declared on an interface is overridden by a child (illegal in PHP < 8.1). | ||
|
|
||
| ```php | ||
| <?php | ||
|
|
||
| interface Foo | ||
| { | ||
| public const BAR='baz'; | ||
| } | ||
|
|
||
| interface Bar extends Foo | ||
| { | ||
| public const BAR='foobar'; | ||
| } | ||
| ``` |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this an issue when the type are compatibles?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's an issue even when it's the same exact thing: https://3v4l.org/tjYML
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh, I thought "ambiguous" was too tame a word for something that broke at compile time, I was wrong!