Merge pull request #231 from arogachev/224-has-return-by-reference

Add has return by reference for function and methods

Author: jaapio

src/phpDocumentor/Reflection/Php/Factory/Function_.php

@@ -54,7 +54,8 @@ protected function doCreate(
             $object->fqsen,
             $this->createDocBlock($object->getDocComment(), $context->getTypeContext()),
             new Location($object->getLine()),
-            (new Type())->fromPhpParser($object->getReturnType())
+            (new Type())->fromPhpParser($object->getReturnType()),
+            $object->byRef
         );
 
         $file->addFunction($function);

src/phpDocumentor/Reflection/Php/Factory/Method.php

@@ -67,7 +67,8 @@ protected function doCreate(
             $object->isStatic(),
             $object->isFinal(),
             new Location($object->getLine()),
-            (new Type())->fromPhpParser($object->getReturnType())
+            (new Type())->fromPhpParser($object->getReturnType()),
+            $object->byRef
         );
         $methodContainer->addMethod($method);
 

src/phpDocumentor/Reflection/Php/Function_.php

@@ -45,14 +45,18 @@ final class Function_ implements Element, MetaDataContainerInterface
     /** @var Type */
     private $returnType;
 
+    /** @var bool */
+    private $hasReturnByReference;
+
     /**
      * Initializes the object.
      */
     public function __construct(
         Fqsen $fqsen,
         ?DocBlock $docBlock = null,
         ?Location $location = null,
-        ?Type $returnType = null
+        ?Type $returnType = null,
+        bool $hasReturnByReference = null
     ) {
         if ($location === null) {
             $location = new Location(-1);
@@ -62,10 +66,11 @@ public function __construct(
             $returnType = new Mixed_();
         }
 
-        $this->fqsen      = $fqsen;
-        $this->docBlock   = $docBlock;
-        $this->location   = $location;
-        $this->returnType = $returnType;
+        $this->fqsen                = $fqsen;
+        $this->docBlock             = $docBlock;
+        $this->location             = $location;
+        $this->returnType           = $returnType;
+        $this->hasReturnByReference = $hasReturnByReference;
     }
 
     /**
@@ -119,4 +124,9 @@ public function getReturnType(): Type
     {
         return $this->returnType;
     }
+
+    public function getHasReturnByReference(): bool
+    {
+        return $this->hasReturnByReference;
+    }
 }

src/phpDocumentor/Reflection/Php/Method.php

@@ -55,6 +55,9 @@ final class Method implements Element, MetaDataContainerInterface
     /** @var Type */
     private $returnType;
 
+    /** @var bool */
+    private $hasReturnByReference;
+
     /**
      * Initializes the all properties.
      *
@@ -68,7 +71,8 @@ public function __construct(
         bool $static = false,
         bool $final = false,
         ?Location $location = null,
-        ?Type $returnType = null
+        ?Type $returnType = null,
+        bool $hasReturnByReference = null
     ) {
         $this->fqsen      = $fqsen;
         $this->visibility = $visibility;
@@ -86,11 +90,12 @@ public function __construct(
             $returnType = new Mixed_();
         }
 
-        $this->abstract   = $abstract;
-        $this->static     = $static;
-        $this->final      = $final;
-        $this->location   = $location;
-        $this->returnType = $returnType;
+        $this->abstract             = $abstract;
+        $this->static               = $static;
+        $this->final                = $final;
+        $this->location             = $location;
+        $this->returnType           = $returnType;
+        $this->hasReturnByReference = $hasReturnByReference;
     }
 
     /**
@@ -185,4 +190,9 @@ public function getReturnType(): Type
     {
         return $this->returnType;
     }
+
+    public function getHasReturnByReference(): bool
+    {
+        return $this->hasReturnByReference;
+    }
 }