added support for return $this in methods

Author: cebe

renderers/BaseRenderer.php

@@ -85,7 +85,10 @@ public function createTypeLink($types, $context = null, $title = null, $options
                     $type = substr($type, 0, -2);
                 }
 
-                if (($t = $this->apiContext->getType(ltrim($type, '\\'))) !== null) {
+                if ($type === '$this' && $context instanceof TypeDoc) {
+                    $title = '$this';
+                    $type = $context;
+                } elseif (($t = $this->apiContext->getType(ltrim($type, '\\'))) !== null) {
                     $type = $t;
                 } elseif ($type[0] !== '\\' && ($t = $this->apiContext->getType($this->resolveNamespace($context) . '\\' . ltrim($type, '\\'))) !== null) {
                     $type = $t;
@@ -97,6 +100,7 @@ public function createTypeLink($types, $context = null, $title = null, $options
                 $linkText = ltrim($type, '\\');
                 if ($title !== null) {
                     $linkText = $title;
+                    $title = null;
                 }
                 $phpTypes = [
                     'callable',
@@ -122,6 +126,7 @@ public function createTypeLink($types, $context = null, $title = null, $options
                 $linkText = $type->name;
                 if ($title !== null) {
                     $linkText = $title;
+                    $title = null;
                 }
                 $links[] = $this->generateLink($linkText, $this->generateApiUrl($type->name), $options) . $postfix;
             }

templates/html/ApiRenderer.php

@@ -224,40 +224,40 @@ public function renderClasses($names)
      * @param PropertyDoc $property
      * @return string
      */
-    public function renderPropertySignature($property)
+    public function renderPropertySignature($property, $context = null)
     {
         if ($property->getter !== null || $property->setter !== null) {
             $sig = [];
             if ($property->getter !== null) {
-                $sig[] = $this->renderMethodSignature($property->getter);
+                $sig[] = $this->renderMethodSignature($property->getter, $context);
             }
             if ($property->setter !== null) {
-                $sig[] = $this->renderMethodSignature($property->setter);
+                $sig[] = $this->renderMethodSignature($property->setter, $context);
             }
 
             return implode('<br />', $sig);
         }
 
-        return $this->createTypeLink($property->types) . ' ' . $this->createSubjectLink($property, $property->name) . ' '
+        return $this->createTypeLink($property->types, $context) . ' ' . $this->createSubjectLink($property, $property->name) . ' '
                 . ApiMarkdown::highlight('= ' . ($property->defaultValue === null ? 'null' : $property->defaultValue), 'php');
     }
 
     /**
      * @param MethodDoc $method
      * @return string
      */
-    public function renderMethodSignature($method)
+    public function renderMethodSignature($method, $context = null)
     {
         $params = [];
         foreach ($method->params as $param) {
-            $params[] = (empty($param->typeHint) ? '' : $param->typeHint . ' ')
+            $params[] = (empty($param->typeHint) ? '' : $this->createTypeLink($param->typeHint, $context) . ' ')
                 . ($param->isPassedByReference ? '<b>&</b>' : '')
                 . $param->name
                 . ($param->isOptional ? ' = ' . $param->defaultValue : '');
         }
 
         return ($method->isReturnByReference ? '<b>&</b>' : '')
-            . ($method->returnType === null ? 'void' : $this->createTypeLink($method->returnTypes))
+            . ($method->returnType === null ? 'void' : $this->createTypeLink($method->returnTypes, $context))
             . ' <strong>' . $this->createSubjectLink($method, $method->name) . '</strong>'
             . ApiMarkdown::highlight(str_replace('  ', ' ', '( ' . implode(', ', $params) . ' )'), 'php');
     }

templates/html/views/methodDetails.php

@@ -53,7 +53,7 @@
     </div>
 
     <table class="detail-table table table-striped table-bordered table-hover">
-        <tr><td colspan="3" class="signature"><?= $renderer->renderMethodSignature($method) ?></td></tr>
+        <tr><td colspan="3" class="signature"><?= $renderer->renderMethodSignature($method, $type) ?></td></tr>
         <?php if (!empty($method->params) || !empty($method->return) || !empty($method->exceptions)): ?>
             <?php foreach ($method->params as $param): ?>
                 <tr>
@@ -65,7 +65,7 @@
             <?php if (!empty($method->return)): ?>
                 <tr>
                   <th class="param-name-col">return</th>
-                  <td class="param-type-col"><?= $renderer->createTypeLink($method->returnTypes) ?></td>
+                  <td class="param-type-col"><?= $renderer->createTypeLink($method->returnTypes, $type) ?></td>
                   <td class="param-desc-col"><?= ApiMarkdown::process($method->return, $type) ?></td>
                 </tr>
             <?php endif; ?>

templates/html/views/propertyDetails.php

@@ -46,7 +46,7 @@
         </span>
     </div>
 
-    <div class="signature"><?php echo $renderer->renderPropertySignature($property); ?></div>
+    <div class="signature"><?php echo $renderer->renderPropertySignature($property, $type); ?></div>
 
     <?= ApiMarkdown::process($property->description, $type) ?>