Merge pull request #60 from mRoca/feat/preg-replace-return-type

feat: infer `preg_replace_callback` return type

Author: shish

src/Type/Php/ReplaceSafeFunctionsDynamicReturnTypeExtension.php

@@ -16,12 +16,19 @@
 use PHPStan\Type\TypeCombinator;
 use PHPStan\Type\TypeUtils;
 
+/**
+ * This file has been copy-pasted from PHPStan's source code but with isFunctionSupported changed.
+ * For now, only preg_* functions are supported.
+ * @See https://github.com/phpstan/phpstan-src/blob/2.1.x/src/Type/Php/ReplaceFunctionsDynamicReturnTypeExtension.php
+ */
 class ReplaceSafeFunctionsDynamicReturnTypeExtension implements DynamicFunctionReturnTypeExtension
 {
 
-    /** @var array<string, int> */
+    /** @var array<string, int> The function name associated with the typed argument position used to type the return */
     private array $functions = [
         'Safe\preg_replace' => 2,
+        'Safe\preg_replace_callback' => 2,
+        'Safe\preg_replace_callback_array' => 1,
     ];
 
     public function isFunctionSupported(FunctionReflection $functionReflection): bool

tests/Type/Php/data/preg_match_checked.php

@@ -12,9 +12,9 @@
 
 // @phpstan-ignore-next-line - use of unsafe is intentional
 if(\preg_match($pattern, $string, $matches)) {
-    \PHPStan\Testing\assertType($type, $matches);
+    \PHPStan\Testing\assertSuperType($type, $matches);
 }
 
 if(\Safe\preg_match($pattern, $string, $matches)) {
-    \PHPStan\Testing\assertType($type, $matches);
+    \PHPStan\Testing\assertSuperType($type, $matches);
 }

tests/Type/Php/data/preg_match_unchecked.php

@@ -11,7 +11,7 @@
 
 // @phpstan-ignore-next-line - use of unsafe is intentional
 \preg_match($pattern, $string, $matches);
-\PHPStan\Testing\assertType($type, $matches);
+\PHPStan\Testing\assertSuperType($type, $matches);
 
 \Safe\preg_match($pattern, $string, $matches);
-\PHPStan\Testing\assertType($type, $matches);
+\PHPStan\Testing\assertSuperType($type, $matches);

tests/Type/Php/data/preg_replace_return.php

@@ -2,10 +2,33 @@
 
 namespace TheCodingMachine\Safe\PHPStan\Type\Php\data;
 
+// preg_replace
+
 // preg_replace with a string pattern should return a string
 $x = \Safe\preg_replace('/foo/', 'bar', 'baz');
 \PHPStan\Testing\assertType("string", $x);
 
 // preg_replace with an array pattern should return an array
 $x = \Safe\preg_replace(['/foo/'], ['bar'], ['baz']);
 \PHPStan\Testing\assertType("array", $x);
+
+// preg_replace_callback
+
+// preg_replace_callback with a string pattern should return a string
+$x = \Safe\preg_replace_callback('/foo/', fn (array $matches) => 'bar', 'baz');
+\PHPStan\Testing\assertType("string", $x);
+
+// preg_replace_callback with an array pattern should return an array
+$x = \Safe\preg_replace_callback(['/foo/'], fn (array $matches) => 'bar', ['baz']);
+\PHPStan\Testing\assertType("array", $x);
+
+
+// preg_replace_callback_array
+
+// preg_replace_callback_array with a string pattern should return a string
+$x = \Safe\preg_replace_callback_array(['/foo/' => fn (array $matches) => 'bar'], 'baz');
+\PHPStan\Testing\assertType("string", $x);
+
+// preg_replace_callback with an array pattern should return an array
+$x = \Safe\preg_replace_callback_array(['/foo/' => fn (array $matches) => 'bar'], ['baz']);
+\PHPStan\Testing\assertType("array", $x);