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
added SscanfFunctionDynamicReturnTypeExtension return type extension #1434
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
424a524
added SscanfFunctionDynamicReturnTypeExtension return type extension
clxmstaab 753b157
Update SscanfFunctionDynamicReturnTypeExtension.php
clxmstaab 4ed94b7
support fscanf(), because of same formatting rules
clxmstaab 26693ed
fix tests
staabm File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace PHPStan\Type\Php; | ||
|
||
use PhpParser\Node\Expr\FuncCall; | ||
use PHPStan\Analyser\Scope; | ||
use PHPStan\Reflection\FunctionReflection; | ||
use PHPStan\Type\Constant\ConstantArrayTypeBuilder; | ||
use PHPStan\Type\Constant\ConstantIntegerType; | ||
use PHPStan\Type\Constant\ConstantStringType; | ||
use PHPStan\Type\DynamicFunctionReturnTypeExtension; | ||
use PHPStan\Type\FloatType; | ||
use PHPStan\Type\IntegerType; | ||
use PHPStan\Type\StringType; | ||
use PHPStan\Type\Type; | ||
use PHPStan\Type\TypeCombinator; | ||
use function count; | ||
use function in_array; | ||
use function preg_match_all; | ||
|
||
class SscanfFunctionDynamicReturnTypeExtension implements DynamicFunctionReturnTypeExtension | ||
{ | ||
|
||
public function isFunctionSupported(FunctionReflection $functionReflection): bool | ||
{ | ||
return in_array($functionReflection->getName(), ['sscanf', 'fscanf'], true); | ||
} | ||
|
||
public function getTypeFromFunctionCall( | ||
FunctionReflection $functionReflection, | ||
FuncCall $functionCall, | ||
Scope $scope, | ||
): ?Type | ||
{ | ||
$args = $functionCall->getArgs(); | ||
if (count($args) !== 2) { | ||
return null; | ||
} | ||
|
||
$formatType = $scope->getType($args[1]->value); | ||
|
||
if (!$formatType instanceof ConstantStringType) { | ||
return null; | ||
} | ||
|
||
if (preg_match_all('/%[cdeEfosux]{1}/', $formatType->getValue(), $matches) > 0) { | ||
$arrayBuilder = ConstantArrayTypeBuilder::createEmpty(); | ||
|
||
for ($i = 0; $i < count($matches[0]); $i++) { | ||
$type = new StringType(); | ||
|
||
if (in_array($matches[0][$i], ['%d', '%o', '%u', '%x'], true)) { | ||
$type = new IntegerType(); | ||
} | ||
|
||
if (in_array($matches[0][$i], ['%e', '%E', '%f'], true)) { | ||
$type = new FloatType(); | ||
} | ||
|
||
$arrayBuilder->setOffsetValueType(new ConstantIntegerType($i), $type); | ||
} | ||
|
||
return TypeCombinator::addNull($arrayBuilder->getArray()); | ||
} | ||
|
||
return null; | ||
} | ||
|
||
} |
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 |
---|---|---|
@@ -1,6 +1,38 @@ | ||
<?php | ||
|
||
namespace Sscanf; | ||
|
||
use function PHPStan\Testing\assertType; | ||
|
||
assertType('int|null', sscanf('20-20', '%d-%d', $first, $second)); | ||
assertType('array|null', sscanf('20-20', '%d-%d')); | ||
function foo(string $s) { | ||
assertType('int|null', sscanf('20-20', '%d-%d', $first, $second)); | ||
assertType('array{int, int}|null', sscanf('20-20', '%d-%d')); | ||
} | ||
|
||
function sscanfFormatInference(string $s) { | ||
assertType('int|null', sscanf($s, $s, $first, $second)); | ||
assertType('array|null', sscanf($s, $s)); | ||
|
||
assertType('array{string}|null', sscanf($s, '%c')); | ||
assertType('array{int}|null', sscanf($s, '%d')); | ||
assertType('array{float}|null', sscanf($s, '%e')); | ||
assertType('array{float}|null', sscanf($s, '%E')); | ||
assertType('array{float}|null', sscanf($s, '%f')); | ||
assertType('array{int}|null', sscanf($s, '%o')); | ||
assertType('array{string}|null', sscanf($s, '%s')); | ||
assertType('array{int}|null', sscanf($s, '%u')); | ||
assertType('array{int}|null', sscanf($s, '%x')); | ||
|
||
$mandate = "January 01 2000"; | ||
list($month, $day, $year) = sscanf($mandate, "%s %d %d"); | ||
assertType('string', $month); | ||
assertType('int', $day); | ||
assertType('int', $year); | ||
} | ||
|
||
function fscanfFormatInference($r) { | ||
list($month, $day, $year) = fscanf($r, "%s %d %d"); | ||
assertType('string', $month); | ||
assertType('int', $day); | ||
assertType('int', $year); | ||
} |
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.
https://3v4l.org/HgMjg