Added support for type 'self' to @var and @return annotations, also initial support for 'static'

Author: theseer

src/collector/backend/parser/UnitCollectingVisitor.php

@@ -52,7 +52,7 @@ class UnitCollectingVisitor extends NodeVisitorAbstract {
         /**
          * @var \TheSeer\phpDox\DocBlock\Parser
          */
-        private $dockblocParser;
+        private $docBlockParser;
 
         /**
          * @var array
@@ -85,7 +85,7 @@ class UnitCollectingVisitor extends NodeVisitorAbstract {
          * @param ParseResult                     $result
          */
         public function __construct(DocBlockParser $parser, ParseResult $result) {
-            $this->dockblocParser = $parser;
+            $this->docBlockParser = $parser;
             $this->result = $result;
         }
 
@@ -99,14 +99,17 @@ public function enterNode(\PhpParser\Node $node) {
             } else if ($node instanceof NodeType\UseUse) {
                 $this->aliasMap[$node->alias] = join('\\', $node->name->parts);
             } else if ($node instanceof NodeType\Class_) {
+                $this->aliasMap['::unit'] = (string)$node->namespacedName;
                 $this->unit = $this->result->addClass((string)$node->namespacedName);
                 $this->processUnit($node);
                 return;
             } else if ($node instanceof NodeType\Interface_) {
+                $this->aliasMap['::unit'] = (string)$node->namespacedName;
                 $this->unit = $this->result->addInterface((string)$node->namespacedName);
                 $this->processUnit($node);
                 return;
             } else if ($node instanceof NodeType\Trait_) {
+                $this->aliasMap['::unit'] = (string)$node->namespacedName;
                 $this->unit = $this->result->addTrait((string)$node->namespacedName);
                 $this->processUnit($node);
                 return;
@@ -151,7 +154,7 @@ private function processUnit($node) {
 
             $docComment = $node->getDocComment();
             if ($docComment !== NULL) {
-                $block = $this->dockblocParser->parse($docComment, $this->aliasMap);
+                $block = $this->docBlockParser->parse($docComment, $this->aliasMap);
                 $this->unit->setDocBlock($block);
             }
 
@@ -234,7 +237,7 @@ private function processMethod(NodeType\ClassMethod $node) {
             $method->setVisibility($visibility);
             $docComment = $node->getDocComment();
             if ($docComment !== NULL) {
-                $block = $this->dockblocParser->parse($docComment, $this->aliasMap);
+                $block = $this->docBlockParser->parse($docComment, $this->aliasMap);
                 $method->setDocBlock($block);
             }
             $this->processMethodParams($method, $node->params);
@@ -280,7 +283,7 @@ private function processClassConstant(NodeType\ClassConst $node) {
             $const->setValue($constNode->getAttribute('originalValue'));
             $docComment = $node->getDocComment();
             if ($docComment !== NULL) {
-                $block = $this->dockblocParser->parse($docComment, $this->aliasMap);
+                $block = $this->docBlockParser->parse($docComment, $this->aliasMap);
                 $const->setDocBlock($block);
             }
         }
@@ -299,7 +302,7 @@ private function processProperty(NodeType\Property $node) {
             $member->setVisibility($visibility);
             $docComment = $node->getDocComment();
             if ($docComment !== NULL) {
-                $block = $this->dockblocParser->parse($docComment, $this->aliasMap);
+                $block = $this->docBlockParser->parse($docComment, $this->aliasMap);
                 $member->setDocBlock($block);
             }
             $member->setLine($node->getLine());

src/docblock/parser/GenericParser.php

@@ -45,7 +45,7 @@ class GenericParser {
         protected $payload;
 
         private $types = array(
-            '', 'mixed', '{unknown}', 'object', 'array', 'integer', 'int', 'float', 'string', 'boolean', 'resource'
+            '', 'mixed', '{unknown}', 'object', 'array', 'integer', 'int', 'float', 'string', 'boolean', 'resource', 'static'
         );
 
         public function __construct(Factory $factory, $name) {
@@ -76,6 +76,10 @@ protected function buildObject($classname, array $buffer) {
         }
 
         protected function lookupType($type) {
+            if ($type === 'self') {
+                return $this->aliasMap['::unit'];
+            }
+
             // Do not mess with scalar and fixed types
             if (in_array($type, $this->types)) {
                 return $type;
@@ -102,4 +106,4 @@ protected function lookupType($type) {
 
     }
 
-}
+}

tests/data/static/src/StaticAndSelf.php

@@ -0,0 +1,15 @@
+<?php
+class StaticAndSelf {
+
+    /**
+     * @var self
+     */
+    private $x;
+
+    /**
+     * @return static
+     */
+    public function foo() {
+        return new static();
+    }
+}

tests/data/static/test.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<phpdox xmlns="http://xml.phpdox.net/config" silent="false">
+
+    <project name="phpDox-issue172" source="${basedir}/src" workdir="${basedir}/xml">
+
+        <collector publiconly="false" backend="parser" />
+
+        <generator output="${basedir}/docs">
+            <build engine="html" enabled="true" output="html" />
+            <build engine="xml" enabled="true" output="xml" />
+        </generator>
+
+    </project>
+
+</phpdox>