Skip to content

Respect phpstan level in ParameterCastableToNumberRule #4873

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

Open
VincentLanglet wants to merge 1 commit into
base: 2.1.x
Choose a base branch
from
+69 −9
Open

Respect phpstan level in ParameterCastableToNumberRule #4873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion src/Rules/Functions/ParameterCastableToNumberRule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use PHPStan\Rules\ParameterCastableToStringCheck;
use PHPStan\Rules\Rule;
use PHPStan\Type\ErrorType;
use PHPStan\Type\MixedType;
use PHPStan\Type\Type;
use function count;
use function in_array;
Expand Down Expand Up @@ -69,7 +70,7 @@

$castFn = $this->phpVersion->supportsObjectsInArraySumProduct()
? static fn (Type $t) => $t->toNumber()
: static fn (Type $t) => !$t->isObject()->no() ? new ErrorType() : $t->toNumber();
: static fn (Type $t) => $t instanceof MixedType || $t->isObject()->no() ? $t->toNumber() : new ErrorType();

Check warning on line 73 in src/Rules/Functions/ParameterCastableToNumberRule.php

View workflow job for this annotation

GitHub Actions / Mutation Testing (8.3, ubuntu-latest) 

Escaped Mutant for Mutator "PHPStan\Infection\TrinaryLogicMutator":

@@ @@
 
 		$castFn = $this->phpVersion->supportsObjectsInArraySumProduct()
 			? static fn (Type $t) => $t->toNumber()
-			: static fn (Type $t) => $t instanceof MixedType || $t->isObject()->no() ? $t->toNumber() : new ErrorType();
+			: static fn (Type $t) => $t instanceof MixedType || !$t->isObject()->yes() ? $t->toNumber() : new ErrorType();
 
 		$error = $this->parameterCastableToStringCheck->checkParameter(
 			$origArgs[0],

Check warning on line 73 in src/Rules/Functions/ParameterCastableToNumberRule.php

View workflow job for this annotation

GitHub Actions / Mutation Testing (8.4, ubuntu-latest) 

Escaped Mutant for Mutator "PHPStan\Infection\TrinaryLogicMutator":

@@ @@
 
 		$castFn = $this->phpVersion->supportsObjectsInArraySumProduct()
 			? static fn (Type $t) => $t->toNumber()
-			: static fn (Type $t) => $t instanceof MixedType || $t->isObject()->no() ? $t->toNumber() : new ErrorType();
+			: static fn (Type $t) => $t instanceof MixedType || !$t->isObject()->yes() ? $t->toNumber() : new ErrorType();
 
 		$error = $this->parameterCastableToStringCheck->checkParameter(
 			$origArgs[0],
Copy link
Contributor Author

@VincentLanglet VincentLanglet Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MixedType should not be transform automatically to ErrorType, we will rely on the ruleLevelHelper inside the parameterCastableToStringCheck to decide.


$error = $this->parameterCastableToStringCheck->checkParameter(
$origArgs[0],
Expand Down
24 changes: 17 additions & 7 deletions src/Rules/ParameterCastableToStringCheck.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
use PHPStan\Analyser\ArgumentsNormalizer;
use PHPStan\Analyser\Scope;
use PHPStan\DependencyInjection\AutowiredService;
use PHPStan\Node\Expr\TypeExpr;
use PHPStan\Reflection\ParameterReflection;
use PHPStan\Type\ErrorType;
use PHPStan\Type\Type;
Expand Down Expand Up @@ -34,22 +35,31 @@
return null;
}

$typeResult = $this->ruleLevelHelper->findTypeToCheck(
$arrayTypeResult = $this->ruleLevelHelper->findTypeToCheck(
$scope,
$parameter->value,
'',
static fn (Type $type): bool => $type->isArray()->yes() && !$castFn($type->getIterableValueType()) instanceof ErrorType,
Copy link
Contributor Author

@VincentLanglet VincentLanglet Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The following change follows the same idea than https://github.com/phpstan/phpstan-src/pull/4166/changes for instance.

&& and || doesn't work always very well in UnionTypeCriteriaCallback it's sometimes better to split the check into multiple findTypeToCheck calls.

Here this allows to transform the iterable value type $type->getIterableValueType() into a StrictMixed when it's a Mixed for instance or array<mixed> is never reported at any level.

static fn (Type $type): bool => $type->isArray()->yes(),

Check warning on line 42 in src/Rules/ParameterCastableToStringCheck.php

View workflow job for this annotation

GitHub Actions / Mutation Testing (8.3, ubuntu-latest) 

Escaped Mutant for Mutator "PHPStan\Infection\TrinaryLogicMutator":

@@ @@
 			$scope,
 			$parameter->value,
 			'',
-			static fn (Type $type): bool => $type->isArray()->yes(),
+			static fn (Type $type): bool => !$type->isArray()->no(),
 		);
 
 		$arrayType = $arrayTypeResult->getType();

Check warning on line 42 in src/Rules/ParameterCastableToStringCheck.php

View workflow job for this annotation

GitHub Actions / Mutation Testing (8.4, ubuntu-latest) 

Escaped Mutant for Mutator "PHPStan\Infection\TrinaryLogicMutator":

@@ @@
 			$scope,
 			$parameter->value,
 			'',
-			static fn (Type $type): bool => $type->isArray()->yes(),
+			static fn (Type $type): bool => !$type->isArray()->no(),
 		);
 
 		$arrayType = $arrayTypeResult->getType();
);

$arrayType = $arrayTypeResult->getType();
if (!$arrayType->isArray()->yes()) {
return null;
}

$typeResult = $this->ruleLevelHelper->findTypeToCheck(
$scope,
new TypeExpr($arrayType->getIterableValueType()),
'',
static fn (Type $type): bool => !$castFn($type) instanceof ErrorType,
);

if (
! $typeResult->getType()->isArray()->yes()
|| !$castFn($typeResult->getType()->getIterableValueType()) instanceof ErrorType
) {
if (!$castFn($typeResult->getType()) instanceof ErrorType) {
return null;
}

return RuleErrorBuilder::message(
sprintf($errorMessageTemplate, $parameterName, $functionName, $typeResult->getType()->describe(VerbosityLevel::typeOnly())),
sprintf($errorMessageTemplate, $parameterName, $functionName, $arrayTypeResult->getType()->describe(VerbosityLevel::typeOnly())),
)->identifier('argument.type')->build();
}

Expand Down
41 changes: 40 additions & 1 deletion tests/PHPStan/Rules/Functions/ParameterCastableToNumberRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,18 @@
class ParameterCastableToNumberRuleTest extends RuleTestCase
{

private bool $checkUnion = true;

private bool $checkExplicitMixed = true;

private bool $checkImplicitMixed = true;

protected function getRule(): Rule
{
$broker = self::createReflectionProvider();
return new ParameterCastableToNumberRule(
$broker,
new ParameterCastableToStringCheck(new RuleLevelHelper($broker, true, false, true, true, true, false, true)),
new ParameterCastableToStringCheck(new RuleLevelHelper($broker, true, false, $this->checkUnion, $this->checkExplicitMixed, $this->checkImplicitMixed, false, true)),
self::getContainer()->getByType(PhpVersion::class),
);
}
Expand Down Expand Up @@ -213,6 +219,39 @@ public function testBug13775Bis(): void
$this->analyse([__DIR__ . '/data/bug-13775-bis.php'], $this->hackPhp74ErrorMessages($errors));
}

public function testBug13775TerWithoutMixed(): void
{
$this->checkExplicitMixed = false;
$this->checkImplicitMixed = false;

$this->analyse([__DIR__ . '/data/bug-13775-ter.php'], $this->hackPhp74ErrorMessages([
[
'Parameter #1 $array of function array_sum expects an array of values castable to number, array<int, int|string> given.',
9,
],
[
'Parameter #1 $array of function array_product expects an array of values castable to number, array<int, int|string> given.',
10,
],
]));
}

public function testBug13775TerWithoutUnion(): void
{
$this->checkUnion = false;

$this->analyse([__DIR__ . '/data/bug-13775-ter.php'], $this->hackPhp74ErrorMessages([
[
'Parameter #1 $array of function array_sum expects an array of values castable to number, array<int, mixed> given.',
5,
],
[
'Parameter #1 $array of function array_product expects an array of values castable to number, array<int, mixed> given.',
6,
],
]));
}

public function testBug12146(): void
{
$this->analyse([__DIR__ . '/data/bug-12146.php'], $this->hackPhp74ErrorMessages([
Expand Down
10 changes: 10 additions & 0 deletions tests/PHPStan/Rules/Functions/data/bug-13775-ter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?php declare(strict_types = 1);

/** @var mixed $a */
$a = doFoo();
echo array_sum([$a]) . "\n\n";
echo array_product([$a]) . "\n\n";

$b = rand(0, 1) ? 42 : '';
echo array_sum([$b]) . "\n\n";
echo array_product([$b]) . "\n\n";
Loading