implemented str_contains FunctionTypeSpecifyingExtension
#1068
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,101 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace PHPStan\Type\Php; | ||
|
|
||
| use PhpParser\Node\Arg; | ||
| use PhpParser\Node\Expr\BinaryOp\BooleanAnd; | ||
| use PhpParser\Node\Expr\BinaryOp\NotIdentical; | ||
| use PhpParser\Node\Expr\FuncCall; | ||
| use PhpParser\Node\Name; | ||
| use PhpParser\Node\Scalar\String_; | ||
| use PHPStan\Analyser\Scope; | ||
| use PHPStan\Analyser\SpecifiedTypes; | ||
| use PHPStan\Analyser\TypeSpecifier; | ||
| use PHPStan\Analyser\TypeSpecifierAwareExtension; | ||
| use PHPStan\Analyser\TypeSpecifierContext; | ||
| use PHPStan\Reflection\FunctionReflection; | ||
| use PHPStan\Type\Accessory\AccessoryLiteralStringType; | ||
| use PHPStan\Type\Accessory\AccessoryNonEmptyStringType; | ||
| use PHPStan\Type\Accessory\AccessoryNumericStringType; | ||
| use PHPStan\Type\FunctionTypeSpecifyingExtension; | ||
| use PHPStan\Type\IntersectionType; | ||
| use PHPStan\Type\StringType; | ||
| use function array_key_exists; | ||
| use function count; | ||
| use function strtolower; | ||
|
|
||
| final class StrContainingTypeSpecifyingExtension implements FunctionTypeSpecifyingExtension, TypeSpecifierAwareExtension | ||
| { | ||
|
|
||
| /** @var array<string, array{0: int, 1: int}> */ | ||
| private array $strContainingFunctions = [ | ||
| 'fnmatch' => [1, 0], | ||
| 'str_contains' => [0, 1], | ||
| 'str_starts_with' => [0, 1], | ||
| 'str_ends_with' => [0, 1], | ||
| 'strpos' => [0, 1], | ||
| 'strrpos' => [0, 1], | ||
| 'stripos' => [0, 1], | ||
| 'strripos' => [0, 1], | ||
| 'strstr' => [0, 1], | ||
| ]; | ||
|
|
||
| private TypeSpecifier $typeSpecifier; | ||
|
|
||
| public function setTypeSpecifier(TypeSpecifier $typeSpecifier): void | ||
| { | ||
| $this->typeSpecifier = $typeSpecifier; | ||
| } | ||
|
|
||
| public function isFunctionSupported(FunctionReflection $functionReflection, FuncCall $node, TypeSpecifierContext $context): bool | ||
| { | ||
| return array_key_exists(strtolower($functionReflection->getName()), $this->strContainingFunctions) | ||
| && $context->truthy(); | ||
| } | ||
|
|
||
| public function specifyTypes(FunctionReflection $functionReflection, FuncCall $node, Scope $scope, TypeSpecifierContext $context): SpecifiedTypes | ||
| { | ||
| $args = $node->getArgs(); | ||
|
|
||
| if (count($args) >= 2) { | ||
| [$hackstackArg, $needleArg] = $this->strContainingFunctions[strtolower($functionReflection->getName())]; | ||
|
|
||
| $haystackType = $scope->getType($args[$hackstackArg]->value); | ||
| $needleType = $scope->getType($args[$needleArg]->value); | ||
|
|
||
| if ($needleType->isNonEmptyString()->yes() && $haystackType->isString()->yes()) { | ||
| $accessories = [ | ||
| new StringType(), | ||
| new AccessoryNonEmptyStringType(), | ||
| ]; | ||
|
|
||
| if ($haystackType->isLiteralString()->yes()) { | ||
| $accessories[] = new AccessoryLiteralStringType(); | ||
| } | ||
| if ($haystackType->isNumericString()->yes()) { | ||
| $accessories[] = new AccessoryNumericStringType(); | ||
| } | ||
|
|
||
| return $this->typeSpecifier->create( | ||
| $args[$hackstackArg]->value, | ||
| new IntersectionType($accessories), | ||
| $context, | ||
| false, | ||
| $scope, | ||
| new BooleanAnd( | ||
| new NotIdentical( | ||
| $args[$needleArg]->value, | ||
| new String_(''), | ||
| ), | ||
| new FuncCall(new Name('FAUX_FUNCTION'), [ | ||
| new Arg($args[$needleArg]->value), | ||
| ]), | ||
| ), | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| return new SpecifiedTypes(); | ||
| } | ||
|
|
||
| } | ||
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,123 @@ | ||
| <?php | ||
|
|
||
| namespace NonEmptyStringStrContains; | ||
|
|
||
| use function PHPStan\Testing\assertType; | ||
|
|
||
| class Foo { | ||
| /** | ||
| * @param non-empty-string $nonES | ||
| * @param numeric-string $numS | ||
| * @param literal-string $literalS | ||
| * @param non-empty-string&numeric-string $nonEAndNumericS | ||
| */ | ||
| public function strContains(string $s, string $s2, $nonES, $numS, $literalS, $nonEAndNumericS, int $i): void | ||
| { | ||
| if (str_contains($s, ':')) { | ||
| assertType('non-empty-string', $s); | ||
| } | ||
| assertType('string', $s); | ||
|
|
||
| if (str_contains($s, $s2)) { | ||
| assertType('string', $s); | ||
| } | ||
|
|
||
| if (str_contains($s, $nonES)) { | ||
| assertType('non-empty-string', $s); | ||
| } | ||
| if (str_contains($s, $numS)) { | ||
| assertType('non-empty-string', $s); | ||
| } | ||
| if (str_contains($s, $literalS)) { | ||
| assertType('string', $s); | ||
| } | ||
|
|
||
| if (str_contains($s, $nonEAndNumericS)) { | ||
| assertType('non-empty-string', $s); | ||
| } | ||
| if (str_contains($numS, $nonEAndNumericS)) { | ||
| assertType('non-empty-string&numeric-string', $numS); | ||
| } | ||
|
|
||
| if (str_contains($nonES, $s)) { | ||
| assertType('non-empty-string', $nonES); | ||
| } | ||
| if (str_contains($nonEAndNumericS, $s)) { | ||
| assertType('non-empty-string&numeric-string', $nonEAndNumericS); | ||
| } | ||
|
|
||
| if (str_contains($i, $s2)) { | ||
| assertType('int', $i); | ||
| } | ||
| } | ||
|
|
||
| public function variants(string $s) { | ||
| if (fnmatch("*gr[ae]y", $s)) { | ||
| assertType('non-empty-string', $s); | ||
| } | ||
| assertType('string', $s); | ||
|
|
||
| if (str_starts_with($s, ':')) { | ||
| assertType('non-empty-string', $s); | ||
| } | ||
| assertType('string', $s); | ||
|
|
||
| if (str_ends_with($s, ':')) { | ||
| assertType('non-empty-string', $s); | ||
| } | ||
| assertType('string', $s); | ||
|
|
||
| if (strpos($s, ':') !== false) { | ||
| assertType('non-empty-string', $s); | ||
| } | ||
| assertType('string', $s); | ||
| if (strpos($s, ':') === false) { | ||
| assertType('string', $s); | ||
| } | ||
| assertType('string', $s); | ||
|
|
||
| if (strpos($s, ':') === 5) { | ||
| assertType('string', $s); // could be non-empty-string | ||
| } | ||
| assertType('string', $s); | ||
| if (strpos($s, ':') !== 5) { | ||
| assertType('string', $s); | ||
| } | ||
| assertType('string', $s); | ||
|
|
||
| if (strrpos($s, ':') !== false) { | ||
| assertType('non-empty-string', $s); | ||
| } | ||
| assertType('string', $s); | ||
|
|
||
| if (stripos($s, ':') !== false) { | ||
| assertType('non-empty-string', $s); | ||
| } | ||
| assertType('string', $s); | ||
|
|
||
| if (strripos($s, ':') !== false) { | ||
| assertType('non-empty-string', $s); | ||
| } | ||
| assertType('string', $s); | ||
|
|
||
| if (strstr($s, ':') === 'hallo') { | ||
| assertType('string', $s); // could be non-empty-string | ||
| } | ||
| assertType('string', $s); | ||
| if (strstr($s, ':', true) === 'hallo') { | ||
| assertType('string', $s); // could be non-empty-string | ||
|
Comment on lines
+103
to
+108
There was a problem hiding this comment. optimal would be a non-empty-string here.. but the extension as-is cannot deliver it atm. I have no idea yet, how a type-specifying extension could evaluate a comparision like There was a problem hiding this comment. Comparison based inference can be implemented like df27a12 but |
||
| } | ||
| assertType('string', $s); | ||
| if (strstr($s, ':', true) !== false) { | ||
| assertType('non-empty-string', $s); | ||
| } | ||
| assertType('string', $s); | ||
| if (strstr($s, ':', true) === false) { | ||
| assertType('string', $s); | ||
| } else { | ||
| assertType('non-empty-string', $s); | ||
| } | ||
| assertType('string', $s); | ||
| } | ||
|
|
||
| } | ||
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,22 @@ | ||
| <?php | ||
|
|
||
| namespace NonEmptyStringImpossibleType; | ||
|
|
||
| class Foo { | ||
| private function isPrefixedInterface(string $shortClassName): bool | ||
| { | ||
| if (strlen($shortClassName) <= 3) { | ||
| return false; | ||
| } | ||
|
|
||
| if (! \str_starts_with($shortClassName, 'I')) { | ||
| return false; | ||
| } | ||
|
|
||
| if (! ctype_upper($shortClassName[1])) { | ||
| return false; | ||
| } | ||
|
|
||
| return ctype_lower($shortClassName[2]); | ||
| } | ||
| } |
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.
thx for getting this over the finishing line <3.
could you elaborate a bit, what this FAUX_FUNCTION thing is about?
is this a kind-of workaround, which should be encapsulated in a helper somehow, so the code gets readable for non-phpstan-hard-core users :-)?
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 kind of the soft force flag xD but I agree, it is hard to understand and workaround-ish, maybe it should end up in some kind of helper or smth like that hmm
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.
on the other hand this is veeery special and the expression is different for each case maybe
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.
The thing that's problematic for
str_contains()type-specifying extensions and similar is that PHPStan thinks the function isis_string_non_empty()because it narrows down the type tonon-empty-string. But there are other properties of the narrowed string than that - in this case that it contains another string which can't be expressed by the PHPStan typesystem.So when you call
str_contains($nonEmptyString)PHPStan thinks it'sis_string_non_empty($nonEmptyString)and that it has to be always true. But in fact it should beis_string_non_empty($nonEmptyString) && string_contains_string(...). So that's what I'm simulating here.I don't think we need a helper here.