Skip to content

Extract TooWideReturnTypeCheck #4260

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.

Sign up for GitHub

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 4 commits into from
Aug 30, 2025
Merged

Extract TooWideReturnTypeCheck #4260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a60d16c
Extract TooWideReturnTypeCheck
staabm Aug 26, 2025
e7d218d
Extract TooWideReturnTypeCheck->checkFunction()
staabm Aug 26, 2025
e503274
extract TooWideReturnTypeCheck->checkProperty()
staabm Aug 26, 2025
858ffb8
cs
staabm Aug 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 7 additions & 20 deletions src/Rules/TooWideTypehints/TooWideArrowFunctionReturnTypehintRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,7 @@
use PHPStan\DependencyInjection\RegisteredRule;
use PHPStan\Node\InArrowFunctionNode;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;
use PHPStan\Type\UnionType;
use PHPStan\Type\VerbosityLevel;
use function sprintf;

/**
* @implements Rule<InArrowFunctionNode>
Expand All @@ -19,6 +16,12 @@
final class TooWideArrowFunctionReturnTypehintRule implements Rule
{

public function __construct(
private TooWideTypeCheck $check,
)
{
}

public function getNodeType(): string
{
return InArrowFunctionNode::class;
Expand All @@ -41,23 +44,7 @@ public function processNode(Node $node, Scope $scope): array
return [];
}

$returnType = $scope->getType($expr);
if ($returnType->isNull()->yes()) {
return [];
}
$messages = [];
foreach ($functionReturnType->getTypes() as $type) {
if (!$type->isSuperTypeOf($returnType)->no()) {
continue;
}

$messages[] = RuleErrorBuilder::message(sprintf(
'Anonymous function never returns %s so it can be removed from the return type.',
$type->describe(VerbosityLevel::getRecommendedLevelByType($type)),
))->identifier('return.unusedType')->build();
}

return $messages;
return $this->check->checkAnonymousFunction($scope->getType($expr), $functionReturnType);
}

}
28 changes: 7 additions & 21 deletions src/Rules/TooWideTypehints/TooWideClosureReturnTypehintRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,9 @@
use PHPStan\DependencyInjection\RegisteredRule;
use PHPStan\Node\ClosureReturnStatementsNode;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;
use PHPStan\Type\TypeCombinator;
use PHPStan\Type\UnionType;
use PHPStan\Type\VerbosityLevel;
use function count;
use function sprintf;

/**
* @implements Rule<ClosureReturnStatementsNode>
Expand All @@ -21,6 +18,12 @@
final class TooWideClosureReturnTypehintRule implements Rule
{

public function __construct(
private TooWideTypeCheck $check,
)
{
}

public function getNodeType(): string
{
return ClosureReturnStatementsNode::class;
Expand Down Expand Up @@ -62,24 +65,7 @@ public function processNode(Node $node, Scope $scope): array
return [];
}

$returnType = TypeCombinator::union(...$returnTypes);
if ($returnType->isNull()->yes()) {
return [];
}

$messages = [];
foreach ($closureReturnType->getTypes() as $type) {
if (!$type->isSuperTypeOf($returnType)->no()) {
continue;
}

$messages[] = RuleErrorBuilder::message(sprintf(
'Anonymous function never returns %s so it can be removed from the return type.',
$type->describe(VerbosityLevel::getRecommendedLevelByType($type)),
))->identifier('return.unusedType')->build();
}

return $messages;
return $this->check->checkAnonymousFunction(TypeCombinator::union(...$returnTypes), $closureReturnType);
}

}
75 changes: 14 additions & 61 deletions src/Rules/TooWideTypehints/TooWideFunctionReturnTypehintRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,6 @@
use PHPStan\DependencyInjection\RegisteredRule;
use PHPStan\Node\FunctionReturnStatementsNode;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;
use PHPStan\Type\TypeCombinator;
use PHPStan\Type\TypeUtils;
use PHPStan\Type\UnionType;
use PHPStan\Type\VerbosityLevel;
use PHPStan\Type\VoidType;
use function count;
use function sprintf;

/**
Expand All @@ -23,6 +16,12 @@
final class TooWideFunctionReturnTypehintRule implements Rule
{

public function __construct(
private TooWideTypeCheck $check,
)
{
}

public function getNodeType(): string
{
return FunctionReturnStatementsNode::class;
Expand All @@ -33,61 +32,15 @@ public function processNode(Node $node, Scope $scope): array
$function = $node->getFunctionReflection();

$functionReturnType = $function->getReturnType();
$functionReturnType = TypeUtils::resolveLateResolvableTypes($functionReturnType);
if (!$functionReturnType instanceof UnionType) {
return [];
}
$statementResult = $node->getStatementResult();
if ($statementResult->hasYield()) {
return [];
}

$returnStatements = $node->getReturnStatements();
if (count($returnStatements) === 0) {
return [];
}

$returnTypes = [];
foreach ($returnStatements as $returnStatement) {
$returnNode = $returnStatement->getReturnNode();
if ($returnNode->expr === null) {
$returnTypes[] = new VoidType();
continue;
}

$returnTypes[] = $returnStatement->getScope()->getType($returnNode->expr);
}

if (!$statementResult->isAlwaysTerminating()) {
$returnTypes[] = new VoidType();
}

$returnType = TypeCombinator::union(...$returnTypes);

$messages = [];
foreach ($functionReturnType->getTypes() as $type) {
if (!$type->isSuperTypeOf($returnType)->no()) {
continue;
}

if ($type->isNull()->yes() && !$node->hasNativeReturnTypehint()) {
foreach ($node->getExecutionEnds() as $executionEnd) {
if ($executionEnd->getStatementResult()->isAlwaysTerminating()) {
continue;
}

continue 2;
}
}

$messages[] = RuleErrorBuilder::message(sprintf(
'Function %s() never returns %s so it can be removed from the return type.',
return $this->check->checkFunction(
$node,
$functionReturnType,
sprintf(
'Function %s()',
$function->getName(),
$type->describe(VerbosityLevel::getRecommendedLevelByType($type)),
))->identifier('return.unusedType')->build();
}

return $messages;
),
false,
);
}

}
77 changes: 9 additions & 68 deletions src/Rules/TooWideTypehints/TooWideMethodReturnTypehintRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,6 @@
use PHPStan\DependencyInjection\RegisteredRule;
use PHPStan\Node\MethodReturnStatementsNode;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;
use PHPStan\Type\TypeCombinator;
use PHPStan\Type\TypeUtils;
use PHPStan\Type\UnionType;
use PHPStan\Type\VerbosityLevel;
use PHPStan\Type\VoidType;
use function count;
use function sprintf;

/**
Expand All @@ -27,6 +20,7 @@ final class TooWideMethodReturnTypehintRule implements Rule
public function __construct(
#[AutowiredParameter(ref: '%checkTooWideReturnTypesInProtectedAndPublicMethods%')]
private bool $checkProtectedAndPublicMethods,
private TooWideTypeCheck $check,
)
{
}
Expand Down Expand Up @@ -56,69 +50,16 @@ public function processNode(Node $node, Scope $scope): array
}

$methodReturnType = $method->getReturnType();
$methodReturnType = TypeUtils::resolveLateResolvableTypes($methodReturnType);
if (!$methodReturnType instanceof UnionType) {
return [];
}
$statementResult = $node->getStatementResult();
if ($statementResult->hasYield()) {
return [];
}

$returnStatements = $node->getReturnStatements();
if (count($returnStatements) === 0) {
return [];
}

$returnTypes = [];
foreach ($returnStatements as $returnStatement) {
$returnNode = $returnStatement->getReturnNode();
if ($returnNode->expr === null) {
$returnTypes[] = new VoidType();
continue;
}

$returnTypes[] = $returnStatement->getScope()->getType($returnNode->expr);
}

if (!$statementResult->isAlwaysTerminating()) {
$returnTypes[] = new VoidType();
}

$returnType = TypeCombinator::union(...$returnTypes);
if (
!$isFirstDeclaration
&& !$method->isPrivate()
&& ($returnType->isNull()->yes() || $returnType->isTrue()->yes() || $returnType->isFalse()->yes())
) {
return [];
}

$messages = [];
foreach ($methodReturnType->getTypes() as $type) {
if (!$type->isSuperTypeOf($returnType)->no()) {
continue;
}

if ($type->isNull()->yes() && !$node->hasNativeReturnTypehint()) {
foreach ($node->getExecutionEnds() as $executionEnd) {
if ($executionEnd->getStatementResult()->isAlwaysTerminating()) {
continue;
}

continue 2;
}
}

$messages[] = RuleErrorBuilder::message(sprintf(
'Method %s::%s() never returns %s so it can be removed from the return type.',
return $this->check->checkFunction(
$node,
$methodReturnType,
sprintf(
'Method %s::%s()',
$method->getDeclaringClass()->getDisplayName(),
$method->getName(),
$type->describe(VerbosityLevel::getRecommendedLevelByType($type)),
))->identifier('return.unusedType')->build();
}

return $messages;
),
!$isFirstDeclaration && !$method->isPrivate(),
);
}

}
26 changes: 3 additions & 23 deletions src/Rules/TooWideTypehints/TooWidePropertyTypeRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,8 @@
use PHPStan\Rules\Properties\PropertyReflectionFinder;
use PHPStan\Rules\Properties\ReadWritePropertiesExtensionProvider;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;
use PHPStan\Type\NullType;
use PHPStan\Type\TypeCombinator;
use PHPStan\Type\UnionType;
use PHPStan\Type\VerbosityLevel;
use function count;
use function sprintf;

Expand All @@ -28,6 +25,7 @@ final class TooWidePropertyTypeRule implements Rule
public function __construct(
private ReadWritePropertiesExtensionProvider $extensionProvider,
private PropertyReflectionFinder $propertyReflectionFinder,
private TooWideTypeCheck $check,
)
{
}
Expand Down Expand Up @@ -100,27 +98,9 @@ public function processNode(Node $node, Scope $scope): array

$assignedType = TypeCombinator::union(...$assignedTypes);
$propertyDescription = $this->describePropertyByName($propertyReflection, $propertyName);
$verbosityLevel = VerbosityLevel::getRecommendedLevelByType($propertyType, $assignedType);
foreach ($propertyType->getTypes() as $type) {
if (!$type->isSuperTypeOf($assignedType)->no()) {
continue;
}

if ($property->getNativeType() === null && (new NullType())->isSuperTypeOf($type)->yes()) {
continue;
}

$errors[] = RuleErrorBuilder::message(sprintf(
'%s (%s) is never assigned %s so it can be removed from the property type.',
$propertyDescription,
$propertyType->describe($verbosityLevel),
$type->describe($verbosityLevel),
))
->identifier('property.unusedType')
->line($property->getStartLine())
->build();
foreach ($this->check->checkProperty($property, $propertyType, $propertyDescription, $assignedType) as $error) {
$errors[] = $error;
}

}
return $errors;
}
Expand Down
Loading
Loading