Skip to content

Better typing for mb_convert_encoding #3749

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

Closed
wants to merge 3 commits into from
Closed

Better typing for mb_convert_encoding #3749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8cf6755
mb_convert_encoding-can-return-false
jack-worman Dec 21, 2024
e258559
mb_convert_encoding-can-return-false
jack-worman Feb 5, 2025
1efe151
Merge branch 'phpstan:2.1.x' into mb_convert_encoding-can-return-false
jack-worman Mar 23, 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
2 changes: 1 addition & 1 deletion resources/functionMap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6312,7 +6312,7 @@
'mb_check_encoding' => ['bool', 'var='=>'string|array<string>', 'encoding='=>'string'],
'mb_chr' => ['string|false', 'cp'=>'int', 'encoding='=>'string'],
'mb_convert_case' => ['string', 'sourcestring'=>'string', 'mode'=>'int', 'encoding='=>'string'],
'mb_convert_encoding' => ['string|array<int, string>|false', 'val'=>'string|array<int, string>', 'to_encoding'=>'string', 'from_encoding='=>'mixed'],
'mb_convert_encoding' => ['string|array<scalar|null|array<scalar|null>>|false', 'val'=>'string|array<scalar|null|array<scalar|null>>', 'to_encoding'=>'string', 'from_encoding='=>'mixed'],
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is there a way to represent a recursive type?
Or is only going 3 layers deep good enough?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think the best would be to use string|array<mixed>|false

'mb_convert_kana' => ['string', 'str'=>'string', 'option='=>'string', 'encoding='=>'string'],
'mb_convert_variables' => ['string|false', 'to_encoding'=>'string', 'from_encoding'=>'array|string', '&rw_vars'=>'string|array|object', '&...rw_vars='=>'string|array|object'],
'mb_decode_mimeheader' => ['string', 'string'=>'string'],
Expand Down
19 changes: 7 additions & 12 deletions src/Type/Php/MbConvertEncodingFunctionReturnTypeExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@
use PhpParser\Node\Expr\FuncCall;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\FunctionReflection;
use PHPStan\Type\ArrayType;
use PHPStan\Type\Constant\ConstantBooleanType;
use PHPStan\Type\DynamicFunctionReturnTypeExtension;
use PHPStan\Type\IntegerType;
use PHPStan\Type\StringType;
use PHPStan\Type\Type;
use PHPStan\Type\UnionType;

final class MbConvertEncodingFunctionReturnTypeExtension implements DynamicFunctionReturnTypeExtension
{
Expand All @@ -25,18 +24,14 @@ public function getTypeFromFunctionCall(
Scope $scope,
): ?Type
{
if (!isset($functionCall->getArgs()[0])) {
$args = $functionCall->getArgs();
if (!isset($args[0])) {
return null;
}

$argType = $scope->getType($functionCall->getArgs()[0]->value);
$isString = $argType->isString();
$isArray = $argType->isArray();
$compare = $isString->compareTo($isArray);
if ($compare === $isString) {
return new StringType();
} elseif ($compare === $isArray) {
return new ArrayType(new IntegerType(), new StringType());
$argType = $scope->getType($args[0]->value);
if ($argType->isString()->yes() || $argType->isArray()->yes()) {
return new UnionType([$argType, new ConstantBooleanType(false)]);
Copy link
Contributor

Choose a reason for hiding this comment

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

TypeCombinator::union($argType, new ConstantBooleanType(false))

should be used. And it's not ok for constants array or constant strings.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think #3914 does the job

}

return null;
Expand Down
10 changes: 5 additions & 5 deletions tests/PHPStan/Analyser/nsrt/bug-3336.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?php // lint < 8.0
Copy link
Contributor

Choose a reason for hiding this comment

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

Existing bug are generally not removed but updated. (to see the diff)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

reverted delete

<?php

namespace Bug3336;

function (array $arr, string $str, $mixed): void {
\PHPStan\Testing\assertType('array<int, string>', mb_convert_encoding($arr));
\PHPStan\Testing\assertType('string', mb_convert_encoding($str));
\PHPStan\Testing\assertType('array<int, string>|string|false', mb_convert_encoding($mixed));
\PHPStan\Testing\assertType('array<int, string>|string|false', mb_convert_encoding());
\PHPStan\Testing\assertType('array|false', mb_convert_encoding($arr));
\PHPStan\Testing\assertType('string|false', mb_convert_encoding($str));
\PHPStan\Testing\assertType('array<array<bool|float|int|string|null>|bool|float|int|string|null>|string|false', mb_convert_encoding($mixed));
\PHPStan\Testing\assertType('array<array<bool|float|int|string|null>|bool|float|int|string|null>|string|false', mb_convert_encoding());
};
24 changes: 24 additions & 0 deletions tests/PHPStan/Analyser/nsrt/mb_convert_encoding.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<?php

namespace PHPStan\Analyser\nsrt\mb_convert_encoding;

/**
* @param array{foo: string, bar: int} $structuredArray
* @param list<string> $stringList
* @param list<int> $intList
*/
function test_mb_convert_encoding(
mixed $mixed,
string $string,
array $mixedArray,
array $structuredArray,
array $stringList,
array $intList,
): void {
\PHPStan\Testing\assertType('array<array<bool|float|int|string|null>|bool|float|int|string|null>|string|false', mb_convert_encoding($mixed, 'UTF-8'));
\PHPStan\Testing\assertType('string|false', mb_convert_encoding($string, 'UTF-8'));
\PHPStan\Testing\assertType('array|false', mb_convert_encoding($mixedArray, 'UTF-8'));
\PHPStan\Testing\assertType('array{foo: string, bar: int}|false', mb_convert_encoding($structuredArray, 'UTF-8'));
\PHPStan\Testing\assertType('list<string>|false', mb_convert_encoding($stringList, 'UTF-8'));
\PHPStan\Testing\assertType('list<int>|false', mb_convert_encoding($intList, 'UTF-8'));
};
Loading