-
Notifications
You must be signed in to change notification settings - Fork 523
Introduce class_implements dynamic return type #2023
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
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
df1bf6a
Introduce classImplements dynamic return type
VincentLanglet 4e97661
Add more support
VincentLanglet 656648a
Fix cs
VincentLanglet 5ea7a8a
Prefer to use method
VincentLanglet 6a3e0e3
Review
VincentLanglet f36ad40
More tests
VincentLanglet b75ff20
Improvements
VincentLanglet d818e88
Improvement
VincentLanglet 9de87a9
Fix
VincentLanglet 0d24986
Add regression test
VincentLanglet File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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
61 changes: 61 additions & 0 deletions
61
src/Type/Php/ClassImplementsFunctionReturnTypeExtension.php
This file contains hidden or 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,61 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace PHPStan\Type\Php; | ||
|
||
use PhpParser\Node\Expr\FuncCall; | ||
use PHPStan\Analyser\Scope; | ||
use PHPStan\Reflection\FunctionReflection; | ||
use PHPStan\Reflection\ParametersAcceptorSelector; | ||
use PHPStan\Type\ClassStringType; | ||
use PHPStan\Type\Constant\ConstantBooleanType; | ||
use PHPStan\Type\DynamicFunctionReturnTypeExtension; | ||
use PHPStan\Type\ObjectWithoutClassType; | ||
use PHPStan\Type\Type; | ||
use PHPStan\Type\TypeCombinator; | ||
use PHPStan\Type\UnionType; | ||
use function count; | ||
use function in_array; | ||
|
||
class ClassImplementsFunctionReturnTypeExtension implements DynamicFunctionReturnTypeExtension | ||
{ | ||
|
||
public function isFunctionSupported(FunctionReflection $functionReflection): bool | ||
{ | ||
return in_array( | ||
$functionReflection->getName(), | ||
['class_implements', 'class_uses', 'class_parents'], | ||
true, | ||
); | ||
} | ||
|
||
public function getTypeFromFunctionCall(FunctionReflection $functionReflection, FuncCall $functionCall, Scope $scope): ?Type | ||
{ | ||
if (count($functionCall->getArgs()) < 1) { | ||
return null; | ||
} | ||
|
||
$firstArgType = $scope->getType($functionCall->getArgs()[0]->value); | ||
$autoload = !isset($functionCall->getArgs()[1]) | ||
|| $scope->getType($functionCall->getArgs()[1]->value)->equals(new ConstantBooleanType(true)); | ||
|
||
$isObject = (new ObjectWithoutClassType())->isSuperTypeOf($firstArgType); | ||
|
||
$objectOrClassString = (new UnionType([new ObjectWithoutClassType(), new ClassStringType()])); | ||
if ( | ||
$autoload && $objectOrClassString->isSuperTypeOf($firstArgType)->yes() | ||
|| $isObject->yes() | ||
) { | ||
return TypeCombinator::remove( | ||
ParametersAcceptorSelector::selectSingle($functionReflection->getVariants())->getReturnType(), | ||
new ConstantBooleanType(false), | ||
); | ||
} | ||
|
||
if ($isObject->no() && $firstArgType->isClassStringType()->no()) { | ||
return new ConstantBooleanType(false); | ||
} | ||
|
||
return null; | ||
} | ||
|
||
} |
This file contains hidden or 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 hidden or 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,128 @@ | ||
<?php | ||
|
||
namespace ClassImplements; | ||
|
||
use function PHPStan\Testing\assertType; | ||
|
||
class ClassImplements | ||
{ | ||
/** | ||
* @param object|class-string $objectOrClassString | ||
* @param class-string $classString | ||
*/ | ||
public function test( | ||
object $object, | ||
object|string $objectOrClassString, | ||
object|string $objectOrString, | ||
string $classString, | ||
string $className, | ||
bool $bool, | ||
mixed $mixed, | ||
): void { | ||
assertType('array<string, class-string>', class_implements($object)); | ||
assertType('array<string, class-string>', class_implements($objectOrClassString)); | ||
assertType('array<string, class-string>|false', class_implements($objectOrString)); | ||
assertType('array<string, class-string>', class_implements($classString)); | ||
assertType('array<string, class-string>|false', class_implements($className)); | ||
assertType('false', class_implements('thisIsNotAClass')); | ||
|
||
assertType('array<string, class-string>', class_implements($object, true)); | ||
assertType('array<string, class-string>', class_implements($objectOrClassString, true)); | ||
assertType('array<string, class-string>|false', class_implements($objectOrString, true)); | ||
assertType('array<string, class-string>', class_implements($classString, true)); | ||
assertType('array<string, class-string>|false', class_implements($className, true)); | ||
assertType('false', class_implements('thisIsNotAClass', true)); | ||
|
||
assertType('array<string, class-string>', class_implements($object, false)); | ||
assertType('array<string, class-string>|false', class_implements($objectOrClassString, false)); | ||
assertType('array<string, class-string>|false', class_implements($objectOrString, false)); | ||
assertType('array<string, class-string>|false', class_implements($classString, false)); | ||
assertType('array<string, class-string>|false', class_implements($className, false)); | ||
assertType('false', class_implements('thisIsNotAClass', false)); | ||
|
||
assertType('array<string, class-string>', class_implements($object, $bool)); | ||
assertType('array<string, class-string>|false', class_implements($objectOrClassString, $bool)); | ||
assertType('array<string, class-string>|false', class_implements($objectOrString, $bool)); | ||
assertType('array<string, class-string>|false', class_implements($classString, $bool)); | ||
assertType('array<string, class-string>|false', class_implements($className, $bool)); | ||
assertType('false', class_implements('thisIsNotAClass', $bool)); | ||
|
||
assertType('array<string, class-string>', class_implements($object, $mixed)); | ||
assertType('array<string, class-string>|false', class_implements($objectOrClassString, $mixed)); | ||
assertType('array<string, class-string>|false', class_implements($objectOrString, $mixed)); | ||
assertType('array<string, class-string>|false', class_implements($classString, $mixed)); | ||
assertType('array<string, class-string>|false', class_implements($className, $mixed)); | ||
assertType('false', class_implements('thisIsNotAClass', $mixed)); | ||
|
||
assertType('array<string, class-string>', class_uses($object)); | ||
assertType('array<string, class-string>', class_uses($objectOrClassString)); | ||
assertType('array<string, class-string>|false', class_uses($objectOrString)); | ||
assertType('array<string, class-string>', class_uses($classString)); | ||
assertType('array<string, class-string>|false', class_uses($className)); | ||
assertType('false', class_uses('thisIsNotAClass')); | ||
|
||
assertType('array<string, class-string>', class_uses($object, true)); | ||
assertType('array<string, class-string>', class_uses($objectOrClassString, true)); | ||
assertType('array<string, class-string>|false', class_uses($objectOrString, true)); | ||
assertType('array<string, class-string>', class_uses($classString, true)); | ||
assertType('array<string, class-string>|false', class_uses($className, true)); | ||
assertType('false', class_uses('thisIsNotAClass', true)); | ||
|
||
assertType('array<string, class-string>', class_uses($object, false)); | ||
assertType('array<string, class-string>|false', class_uses($objectOrClassString, false)); | ||
assertType('array<string, class-string>|false', class_uses($objectOrString, false)); | ||
assertType('array<string, class-string>|false', class_uses($classString, false)); | ||
assertType('array<string, class-string>|false', class_uses($className, false)); | ||
assertType('false', class_uses('thisIsNotAClass', false)); | ||
|
||
assertType('array<string, class-string>', class_uses($object, $bool)); | ||
assertType('array<string, class-string>|false', class_uses($objectOrClassString, $bool)); | ||
assertType('array<string, class-string>|false', class_uses($objectOrString, $bool)); | ||
assertType('array<string, class-string>|false', class_uses($classString, $bool)); | ||
assertType('array<string, class-string>|false', class_uses($className, $bool)); | ||
assertType('false', class_uses('thisIsNotAClass', $bool)); | ||
|
||
assertType('array<string, class-string>', class_uses($object, $mixed)); | ||
assertType('array<string, class-string>|false', class_uses($objectOrClassString, $mixed)); | ||
assertType('array<string, class-string>|false', class_uses($objectOrString, $mixed)); | ||
assertType('array<string, class-string>|false', class_uses($classString, $mixed)); | ||
assertType('array<string, class-string>|false', class_uses($className, $mixed)); | ||
assertType('false', class_uses('thisIsNotAClass', $mixed)); | ||
|
||
assertType('array<string, class-string>', class_parents($object)); | ||
assertType('array<string, class-string>', class_parents($objectOrClassString)); | ||
assertType('array<string, class-string>|false', class_parents($objectOrString)); | ||
assertType('array<string, class-string>', class_parents($classString)); | ||
assertType('array<string, class-string>|false', class_parents($className)); | ||
assertType('false', class_parents('thisIsNotAClass', $className)); | ||
|
||
assertType('array<string, class-string>', class_parents($object, true)); | ||
assertType('array<string, class-string>', class_parents($objectOrClassString, true)); | ||
assertType('array<string, class-string>|false', class_parents($objectOrString, true)); | ||
assertType('array<string, class-string>', class_parents($classString, true)); | ||
assertType('array<string, class-string>|false', class_parents($className, true)); | ||
assertType('false', class_parents('thisIsNotAClass', true)); | ||
|
||
assertType('array<string, class-string>', class_parents($object, false)); | ||
assertType('array<string, class-string>|false', class_parents($objectOrClassString, false)); | ||
assertType('array<string, class-string>|false', class_parents($objectOrString, false)); | ||
assertType('array<string, class-string>|false', class_parents($classString, false)); | ||
assertType('array<string, class-string>|false', class_parents($className, false)); | ||
assertType('false', class_parents('thisIsNotAClass', false)); | ||
|
||
assertType('array<string, class-string>', class_parents($object, $bool)); | ||
assertType('array<string, class-string>|false', class_parents($objectOrClassString, $bool)); | ||
assertType('array<string, class-string>|false', class_parents($objectOrString, $bool)); | ||
assertType('array<string, class-string>|false', class_parents($classString, $bool)); | ||
assertType('array<string, class-string>|false', class_parents($className, $bool)); | ||
assertType('false', class_parents('thisIsNotAClass', $bool)); | ||
|
||
assertType('array<string, class-string>', class_parents($object, $mixed)); | ||
assertType('array<string, class-string>|false', class_parents($objectOrClassString, $mixed)); | ||
assertType('array<string, class-string>|false', class_parents($objectOrString, $mixed)); | ||
assertType('array<string, class-string>|false', class_parents($classString, $mixed)); | ||
assertType('array<string, class-string>|false', class_parents($className, $mixed)); | ||
assertType('false', class_parents('thisIsNotAClass', $mixed)); | ||
} | ||
|
||
} |
This file contains hidden or 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 hidden or 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,19 @@ | ||
<?php declare(strict_types = 1); | ||
|
||
namespace Bug4335; | ||
|
||
class HelloWorld | ||
{ | ||
public function sayHello(): void | ||
{ | ||
foreach (class_implements($this) as $k => $v) { | ||
var_dump($k, $v); | ||
} | ||
foreach (class_parents($this) as $k => $v) { | ||
var_dump($k, $v); | ||
} | ||
foreach (class_uses($this) as $k => $v) { | ||
var_dump($k, $v); | ||
} | ||
} | ||
} |
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.
$autoload
should be a TrinaryLogic. So you should do(new ConstantBooleanType(true))->isSuperTypeOf($secondArg)
. Because you might havetrue
(yes),bool
ormixed
(maybe), orfalse
(no).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.
Why ?
If I'm not sure that
true
is passed, I cannot remove thefalse
return type.So
bool
,mixed
orfalse
(ie, maybe and no) are working the same way.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.
Please test these scenarios.
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.
Tests added