-
Notifications
You must be signed in to change notification settings - Fork 570
Fix wrong signature for DateInterval::createFromDateString in 8.3+ #5483
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 2.1.x
Are you sure you want to change the base?
Changes from 2 commits
7d17216
014a349
b5c1c72
21f8220
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace PHPStan\Type\Php; | ||
|
|
||
| use DateInterval; | ||
| use PhpParser\Node\Expr\StaticCall; | ||
| use PHPStan\Analyser\Scope; | ||
| use PHPStan\DependencyInjection\AutowiredService; | ||
| use PHPStan\Php\PhpVersion; | ||
| use PHPStan\Reflection\MethodReflection; | ||
| use PHPStan\Type\DynamicStaticMethodThrowTypeExtension; | ||
| use PHPStan\Type\NeverType; | ||
| use PHPStan\Type\Type; | ||
| use PHPStan\Type\TypeCombinator; | ||
| use function count; | ||
|
|
||
| #[AutowiredService] | ||
| final class DateIntervalCreateFromDateStringMethodThrowTypeExtension implements DynamicStaticMethodThrowTypeExtension | ||
| { | ||
|
|
||
| public function __construct(private PhpVersion $phpVersion) | ||
| { | ||
| } | ||
|
|
||
| public function isStaticMethodSupported(MethodReflection $methodReflection): bool | ||
| { | ||
| return $methodReflection->getName() === 'createFromDateString' && $methodReflection->getDeclaringClass()->getName() === DateInterval::class; | ||
| } | ||
|
|
||
| public function getThrowTypeFromStaticMethodCall(MethodReflection $methodReflection, StaticCall $methodCall, Scope $scope): ?Type | ||
| { | ||
| if (count($methodCall->getArgs()) === 0) { | ||
| return null; | ||
| } | ||
|
|
||
| if (!$this->phpVersion->hasDateTimeExceptions()) { | ||
| return null; | ||
| } | ||
|
|
||
| $valueType = $scope->getType($methodCall->getArgs()[0]->value); | ||
| $constantStrings = $valueType->getConstantStrings(); | ||
|
|
||
| foreach ($constantStrings as $constantString) { | ||
| try { | ||
| DateInterval::createFromDateString($constantString->getValue()); | ||
| } catch (\Exception) { // phpcs:ignore | ||
| return $methodReflection->getThrowType(); | ||
| } | ||
|
|
||
| $valueType = TypeCombinator::remove($valueType, $constantString); | ||
| } | ||
|
|
||
| if (!$valueType instanceof NeverType) { | ||
| return $methodReflection->getThrowType(); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,9 +6,11 @@ | |
| use PhpParser\Node\Expr\StaticCall; | ||
| use PHPStan\Analyser\Scope; | ||
| use PHPStan\DependencyInjection\AutowiredService; | ||
| use PHPStan\Php\PhpVersion; | ||
| use PHPStan\Reflection\MethodReflection; | ||
| use PHPStan\Type\Constant\ConstantBooleanType; | ||
| use PHPStan\Type\DynamicStaticMethodReturnTypeExtension; | ||
| use PHPStan\Type\NeverType; | ||
| use PHPStan\Type\ObjectType; | ||
| use PHPStan\Type\Type; | ||
| use Throwable; | ||
|
|
@@ -20,6 +22,10 @@ | |
| implements DynamicStaticMethodReturnTypeExtension | ||
| { | ||
|
|
||
| public function __construct(private PhpVersion $phpVersion) | ||
| { | ||
| } | ||
|
|
||
| public function getClass(): string | ||
| { | ||
| return DateInterval::class; | ||
|
|
@@ -44,13 +50,20 @@ | |
| foreach ($strings as $string) { | ||
| try { | ||
| $result = @DateInterval::createFromDateString($string->getValue()); | ||
| if ($this->phpVersion->hasDateTimeExceptions()) { | ||
| return new ObjectType(DateInterval::class); | ||
| } | ||
| } catch (Throwable) { | ||
| if ($this->phpVersion->hasDateTimeExceptions()) { | ||
| return new NeverType(); | ||
| } | ||
| $possibleReturnTypes[] = false; | ||
| continue; | ||
| } | ||
| // @phpstan-ignore instanceof.alwaysTrue (should only run for < 8.3 and then statement isn't true) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think you can get arround this by moving the above newly added |
||
| $possibleReturnTypes[] = $result instanceof DateInterval ? DateInterval::class : false; | ||
|
Check failure on line 64 in src/Type/Php/DateIntervalDynamicReturnTypeExtension.php
|
||
| } | ||
|
|
||
|
Check failure on line 66 in src/Type/Php/DateIntervalDynamicReturnTypeExtension.php
|
||
| // the error case, when wrong types are passed | ||
| if (count($possibleReturnTypes) === 0) { | ||
| return null; | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <?php // lint >= 8.3 | ||
|
|
||
| namespace Bug14479Php83; | ||
|
|
||
| use function PHPStan\Testing\assertType; | ||
|
|
||
| function test(string $input) { | ||
| assertType(\DateInterval::class, \DateInterval::createFromDateString($input)); | ||
| } | ||
|
|
||
| function test2() { | ||
| assertType('*NEVER*', \DateInterval::createFromDateString('foo')); | ||
| } |
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.
this extension needs testing.
see e.g. 5645c04#diff-0ec4f831901651eabb90c05586b3404e02c820361f0df02b7789a381c65d1f7d on how other *ThrowTypeExtensions have been tested in the past