Support for PHP 7.1's nullable types.

Author: kkarkus

src/CheckerCommand.php

@@ -336,6 +336,21 @@ protected function processFile($file)
                             'method' => $name,
                             'line' => $method['line'],
                         ];
+                    } elseif (is_array($method['return'])) {
+                        $docblockTypes = explode('|', $method['docblock']['return']);
+                        sort($docblockTypes);
+                        if ($method['return'] != $docblockTypes) {
+                            $warnings = true;
+                            $this->warnings[] = [
+                                'type' => 'return-mismatch',
+                                'file' => $file,
+                                'class' => $name,
+                                'method' => $name,
+                                'line' => $method['line'],
+                                'return-type' => implode('|', $method['return']),
+                                'doc-type' => $method['docblock']['return'],
+                            ];
+                        }
                     } elseif ($method['docblock']['return'] != $method['return']) {
                         if ($method['return'] == 'array' && substr($method['docblock']['return'], -2) == '[]') {
                             // Do nothing because this is fine.

src/FileProcessor.php

@@ -5,6 +5,7 @@
 use PhpParser\Comment\Doc;
 use PhpParser\Node\Stmt;
 use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\NullableType;
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\Node\Stmt\Namespace_;
 use PhpParser\Node\Stmt\Use_;
@@ -93,8 +94,12 @@ protected function processStatements(array $statements, $prefix = '')
 
                     $type = $method->returnType;
 
-                    if (!is_null($type)) {
-                        $type = (string)$type;
+                    if (!$method->returnType instanceof NullableType) {
+                        if (!is_null($type)) {
+                            $type = (string)$type;
+                        }
+                    } else {
+                        $type = (string)$type->type;
                     }
 
                     if (isset($uses[$type])) {
@@ -103,6 +108,10 @@ protected function processStatements(array $statements, $prefix = '')
 
                     $type = substr($type, 0, 1) == '\\' ? substr($type, 1) : $type;
 
+                    if ($method->returnType instanceof NullableType) {
+                        $type = ['null', $type];
+                        sort($type);
+                    }
 
                     $thisMethod = [
                         'file' => $this->file,
@@ -117,8 +126,12 @@ protected function processStatements(array $statements, $prefix = '')
                     foreach ($method->params as $param) {
                         $type = $param->type;
 
-                        if (!is_null($type)) {
-                            $type = (string)$type;
+                        if (!$type instanceof NullableType) {
+                            if (!is_null($type)) {
+                                $type = (string)$type;
+                            }
+                        } else {
+                            $type = (string)$type->type;
                         }
 
                         if (isset($uses[$type])) {
@@ -177,13 +190,14 @@ protected function processDocblock($text, array $uses = [])
                     $type = (string)$type;
                 }
 
-                if (isset($uses[$type])) {
-                    $type = $uses[$type];
+                $types = [];
+                foreach (explode('|', $type) as $tmpType) {
+                    if (isset($uses[$tmpType])) {
+                        $tmpType = $uses[$tmpType];
+                    }
+                    $types[] = substr($tmpType, 0, 1) == '\\' ? substr($tmpType, 1) : $tmpType;
                 }
-
-                $type = substr($type, 0, 1) == '\\' ? substr($type, 1) : $type;
-
-                $rtn['params'][$param['var']] = $type;
+                $rtn['params'][$param['var']] = implode('|', $types);
             }
         }
 
@@ -196,13 +210,14 @@ protected function processDocblock($text, array $uses = [])
                 $type = (string)$type;
             }
 
-            if (isset($uses[$type])) {
-                $type = $uses[$type];
+            $types = [];
+            foreach (explode('|', $type) as $tmpType) {
+                if (isset($uses[$tmpType])) {
+                    $tmpType = $uses[$tmpType];
+                }
+                $types[] = substr($tmpType, 0, 1) == '\\' ? substr($tmpType, 1) : $tmpType;
             }
-
-            $type = substr($type, 0, 1) == '\\' ? substr($type, 1) : $type;
-
-            $rtn['return'] = $type;
+            $rtn['return'] = implode('|', $types);
         }
 
         return $rtn;