Skip to content

Improve trim on numeric string #4130

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 1 commit into from
Jul 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions src/Type/Php/LtrimFunctionReturnTypeExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use PHPStan\DependencyInjection\AutowiredService;
use PHPStan\Reflection\FunctionReflection;
use PHPStan\Type\Accessory\AccessoryLowercaseStringType;
use PHPStan\Type\Accessory\AccessoryNumericStringType;
use PHPStan\Type\Accessory\AccessoryUppercaseStringType;
use PHPStan\Type\ClassStringType;
use PHPStan\Type\Constant\ConstantStringType;
Expand All @@ -17,6 +18,7 @@
use PHPStan\Type\TypeCombinator;
use function count;
use function ltrim;
use function preg_match;

#[AutowiredService]
final class LtrimFunctionReturnTypeExtension implements DynamicFunctionReturnTypeExtension
Expand Down Expand Up @@ -69,6 +71,8 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,
}
} elseif ($trimConstantString->getValue() === '\\' && $string->isClassString()->yes()) {
$result[] = new ClassStringType();
} elseif (preg_match('/\d/', $trimConstantString->getValue()) === 0 && $string->isNumericString()->yes()) {
$result[] = new AccessoryNumericStringType();
} else {
return $defaultType;
}
Expand Down
24 changes: 14 additions & 10 deletions src/Type/Php/TrimFunctionDynamicReturnTypeExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
use PHPStan\DependencyInjection\AutowiredService;
use PHPStan\Reflection\FunctionReflection;
use PHPStan\Type\Accessory\AccessoryLowercaseStringType;
use PHPStan\Type\Accessory\AccessoryNumericStringType;
use PHPStan\Type\Accessory\AccessoryUppercaseStringType;
use PHPStan\Type\Constant\ConstantStringType;
use PHPStan\Type\DynamicFunctionReturnTypeExtension;
Expand All @@ -16,6 +17,7 @@
use PHPStan\Type\TypeCombinator;
use function count;
use function in_array;
use function preg_match;
use function rtrim;
use function trim;

Expand Down Expand Up @@ -66,18 +68,20 @@ public function getTypeFromFunctionCall(
$functionName = $functionReflection->getName();

foreach ($trimConstantStrings as $trimConstantString) {
if (count($stringConstantStrings) === 0) {
if (count($stringConstantStrings) > 0) {
foreach ($stringConstantStrings as $stringConstantString) {
$result[] = new ConstantStringType(
$functionName === 'rtrim'
? rtrim($stringConstantString->getValue(), $trimConstantString->getValue())
: trim($stringConstantString->getValue(), $trimConstantString->getValue()),
true,
);
}
} elseif (preg_match('/\d/', $trimConstantString->getValue()) === 0 && $stringType->isNumericString()->yes()) {
$result[] = new AccessoryNumericStringType();
} else {
return $defaultType;
}

foreach ($stringConstantStrings as $stringConstantString) {
$result[] = new ConstantStringType(
$functionName === 'rtrim'
? rtrim($stringConstantString->getValue(), $trimConstantString->getValue())
: trim($stringConstantString->getValue(), $trimConstantString->getValue()),
true,
);
}
}

return TypeCombinator::union(...$result);
Expand Down
33 changes: 33 additions & 0 deletions tests/PHPStan/Analyser/nsrt/numeric-string-trim.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?php

namespace NumericStringTrim;

use function PHPStan\Testing\assertType;

class Foo
{

/**
* @param numeric-string $numericString
* @param string $string
*/
public function doTrim(string $numericString, string $string): void
{
assertType('string', trim($numericString, $string));
assertType('string', ltrim($numericString, $string));
assertType('string', rtrim($numericString, $string));

assertType('numeric-string', trim($numericString, '-'));
assertType('numeric-string', ltrim($numericString, '-'));
assertType('numeric-string', rtrim($numericString, '-'));

assertType('string', trim($numericString, '0'));
assertType('string', ltrim($numericString, '0'));
assertType('string', rtrim($numericString, '0'));

assertType('string', trim($numericString, '-0'));
assertType('string', ltrim($numericString, '-0'));
assertType('string', rtrim($numericString, '-0'));
}

}
Loading