extract comments of functions prepended with echo, print or return #6

Author: oscarotero

src/PhpNodeVisitor.php

@@ -15,6 +15,7 @@ class PhpNodeVisitor implements NodeVisitor
     protected $validFunctions;
     protected $filename;
     protected $functions = [];
+    protected $bufferComments = [];
 
     public function __construct(string $filename, array $validFunctions = null)
     {
@@ -36,9 +37,19 @@ public function enterNode(Node $node)
                 $this->functions[] = $this->createFunction($node);
             }
 
+            $this->bufferComments = [];
             return null;
         }
 
+        switch ($node->getType()) {
+            case 'Stmt_Echo':
+            case 'Stmt_Return':
+            case 'Expr_Print':
+                $this->bufferComments = $node->getComments();
+                return null;
+        }
+
+        $this->bufferComments = [];
         return null;
     }
 
@@ -70,6 +81,10 @@ protected function createFunction(FuncCall $node): ParsedFunction
             $function->addComment(static::getComment($comment));
         }
 
+        foreach ($this->bufferComments as $comment) {
+            $function->addComment(static::getComment($comment));
+        }
+
         foreach ($node->args as $argument) {
             $value = $argument->value;
 

tests/assets/functions.php

@@ -1,14 +1,14 @@
 <?php
 //This comment is related with the first function
 
-fn1('arg1', 'arg2', 3);
+print(fn1('arg1', 'arg2', 3));
 fn2($var);
 fn3(fn4('arg4'), 'arg5', fn5(6, 7.5));
 fn6(['arr']);
 fn7(CONSTANT_1);
 // fn_8();
 /* ALLOW: This is a comment to fn9 */
-fn9(ARG_8);
+return fn9(ARG_8);
 
 /* Comment to fn10 */ fn10();
 
@@ -19,7 +19,7 @@
     Related comment 
     number one
 */
-fn12(
+echo fn12(
     /* Related comment 2 */
     'arg11',
     /* ALLOW: Related comment 3 */