Fix signatures for functions inside annotations when using PHP 7

xp-framework · Jun 25, 2023 · e70037e · e70037e
1 parent 70af1ed
commit e70037e
Show file tree

Hide file tree

Showing 3 changed files with 69 additions and 5 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -3,6 +3,11 @@ XP Reflection ChangeLog
 
 ## ?.?.? / ????-??-??
 
+* Fixed parameter default values, by-reference and variadic markers,
+  and parameter and return types being swallowed for functions inside
+  annotations when using PHP 7
+  (@thekid)
+
 ## 2.13.4 / 2023-06-25
 
 * Fixed parsing global imports and grouped imports containing aliases,

diff --git a/src/main/php/lang/meta/FromSyntaxTree.class.php b/src/main/php/lang/meta/FromSyntaxTree.class.php
@@ -83,12 +83,20 @@ private function parse($code, $resolver) {
 
         $params= '';
         foreach ($signature->parameters as $param) {
-          $params.= ', $'.$param->name;
+          $params.=
+            ', '.
+            ($param->type ? $param->type->literal() : '').
+            ($param->variadic ? '...' : '').
+            ($param->reference ? ' &$': ' $').
+            $param->name.
+            ($param->default ? '='.$param->default->expression : '')
+          ;
         }
+        $return= $signature->returns ? ':'.$signature->returns->literal() : '';
         if (0 === strncmp($code, ' throw ', 7)) {
-          return new Code('function('.substr($params, 2).') {'.$code.'; }');
+          return new Code('function('.substr($params, 2).')'.$return.' {'.$code.'; }');
         } else {
-          return new Code('function('.substr($params, 2).') { return'.$code.'; }');
+          return new Code('function('.substr($params, 2).')'.$return.' { return'.$code.'; }');
         }
       });
 
@@ -114,9 +122,17 @@ private function parse($code, $resolver) {
 
         $params= '';
         foreach ($signature->parameters as $param) {
-          $params.= ', $'.$param->name;
+          $params.=
+            ', '.
+            ($param->type ? $param->type->literal() : '').
+            ($param->variadic ? '...' : '').
+            ($param->reference ? ' &$': ' $').
+            $param->name.
+            ($param->default ? '='.$param->default->expression : '')
+          ;
         }
-        return new Code('function('.substr($params, 2).')'.$code.' }');
+        $return= $signature->returns ? ':'.$signature->returns->literal() : '';
+        return new Code('function('.substr($params, 2).')'.$return.$code.' }');
       };
 
       // Function expressions and function expressions used as statement

diff --git a/src/test/php/lang/reflection/unittest/AnnotationTest.class.php b/src/test/php/lang/reflection/unittest/AnnotationTest.class.php
@@ -1,5 +1,6 @@
 <?php namespace lang\reflection\unittest;
 
+use ReflectionFunction;
 use lang\reflection\{Annotation, CannotInstantiate, InvocationFailed};
 use lang\{IllegalStateException, Reflection, XPClass};
 use test\{Assert, Expect, Test, Values};
@@ -170,6 +171,48 @@ public function with_array_lambda() {
     Assert::equals(6100, $f[0]());
   }
 
+  #[Test, Values(['function(\$param= null) { }', 'fn(\$param= null) => null'])]
+  public function with_optional_param($function) {
+    $t= $this->declare('{}', '#[Annotated(eval: "'.$function.'")]');
+    $f= $t->annotation(Annotated::class)->argument(0);
+
+    Assert::true((new ReflectionFunction($f))->getParameters()[0]->isOptional());
+  }
+
+  #[Test, Values(['function(... \$param) { }', 'fn(... \$param) => null'])]
+  public function with_variadic_param($function) {
+    $t= $this->declare('{}', '#[Annotated(eval: "'.$function.'")]');
+    $f= $t->annotation(Annotated::class)->argument(0);
+
+    Assert::true((new ReflectionFunction($f))->getParameters()[0]->isVariadic());
+  }
+
+  #[Test, Values(['function(&\$param) { }', 'fn(&\$param) => null'])]
+  public function with_reference_param($function) {
+    $t= $this->declare('{}', '#[Annotated(eval: "'.$function.'")]');
+    $f= $t->annotation(Annotated::class)->argument(0);
+
+    Assert::true((new ReflectionFunction($f))->getParameters()[0]->isPassedByReference());
+  }
+
+  #[Test, Values(['function(int \$param) { }', 'fn(int \$param) => null'])]
+  public function with_param_type($function) {
+    $t= $this->declare('{}', '#[Annotated(eval: "'.$function.'")]');
+    $f= $t->annotation(Annotated::class)->argument(0);
+
+    $type= (new ReflectionFunction($f))->getParameters()[0]->getType();
+    Assert::equals('int', PHP_VERSION_ID >= 70100 ? $type->getName() : (string)$type);
+  }
+
+  #[Test, Values(['function(): int { return 6100; }', 'fn(): int => 6100'])]
+  public function with_return_type($function) {
+    $t= $this->declare('{}', '#[Annotated(eval: "'.$function.'")]');
+    $f= $t->annotation(Annotated::class)->argument(0);
+
+    $type= (new ReflectionFunction($f))->getReturnType();
+    Assert::equals('int', PHP_VERSION_ID >= 70100 ? $type->getName() : (string)$type);
+  }
+
   #[Test]
   public function multiple() {
     $t= $this->declare('{}', '#[Annotated, Enumeration([])]');