mb_convert_encoding-can-return-false

Author: jack-worman

Diff for: resources/functionMap.php

@@ -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' => ['__benevolent<string|array<scalar|null|array<scalar|null>>|false>', 'val'=>'string|array<scalar|null|array<scalar|null>>', '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'],
 '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'],

Diff for: src/Type/Php/MbConvertEncodingFunctionReturnTypeExtension.php

@@ -5,10 +5,10 @@
 use PhpParser\Node\Expr\FuncCall;
 use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\FunctionReflection;
-use PHPStan\Type\BenevolentUnionType;
 use PHPStan\Type\Constant\ConstantBooleanType;
 use PHPStan\Type\DynamicFunctionReturnTypeExtension;
 use PHPStan\Type\Type;
+use PHPStan\Type\UnionType;
 
 final class MbConvertEncodingFunctionReturnTypeExtension implements DynamicFunctionReturnTypeExtension
 {
@@ -31,7 +31,7 @@ public function getTypeFromFunctionCall(
 
 		$argType = $scope->getType($args[0]->value);
 		if ($argType->isString()->yes() || $argType->isArray()->yes()) {
-			return new BenevolentUnionType([$argType, new ConstantBooleanType(false)]);
+			return new UnionType([$argType, new ConstantBooleanType(false)]);
 		}
 
 		return null;

Diff for: tests/PHPStan/Analyser/nsrt/bug-3336.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Bug3336;
+
+function (array $arr, string $str, $mixed): void {
+	\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());
+};

Diff for: tests/PHPStan/Analyser/nsrt/mb_convert_encoding.php

@@ -15,10 +15,10 @@ function test_mb_convert_encoding(
 	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'));
+	\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'));
 };