Check whether function has return typehint

Author: adaamz

Diff for: composer.json

@@ -30,7 +30,8 @@
 	"autoload-dev": {
 		"classmap": ["tests/"],
 		"files": [
-			"tests/Rules/Functions/data/missing-function-parameter-typehint.php"
+			"tests/Rules/Functions/data/missing-function-parameter-typehint.php",
+			"tests/Rules/Functions/data/missing-function-return-typehint.php"
 		]
 	}
 }

Diff for: rules.neon

@@ -15,6 +15,7 @@ rules:
 	- PHPStan\Rules\DisallowedConstructs\DisallowedEmptyRule
 	- PHPStan\Rules\DisallowedConstructs\DisallowedImplicitArrayCreationRule
 	- PHPStan\Rules\Functions\MissingFunctionParameterTypehintRule
+	- PHPStan\Rules\Functions\MissingFunctionReturnTypehintRule
 	- PHPStan\Rules\Methods\MissingMethodParameterTypehintRule
 	- PHPStan\Rules\Methods\MissingMethodReturnTypehintRule
 	- PHPStan\Rules\Methods\WrongCaseOfInheritedMethodRule

Diff for: src/Rules/Functions/MissingFunctionReturnTypehintRule.php

@@ -0,0 +1,57 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Functions;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Broker\Broker;
+use PHPStan\Reflection\BrokerAwareExtension;
+use PHPStan\Type\MixedType;
+
+final class MissingFunctionReturnTypehintRule implements \PHPStan\Rules\Rule, BrokerAwareExtension
+{
+
+	/** @var Broker */
+	private $broker;
+
+	/**
+	 * @return string Class implementing \PhpParser\Node
+	 */
+	public function getNodeType(): string
+	{
+		return \PhpParser\Node\Stmt\Function_::class;
+	}
+
+	/**
+	 * @param \PhpParser\Node\Stmt\Function_ $node
+	 * @param \PHPStan\Analyser\Scope $scope
+	 *
+	 * @return string[] errors
+	 */
+	public function processNode(Node $node, Scope $scope): array
+	{
+		if ($scope->isInClass()) {
+			throw new \PHPStan\ShouldNotHappenException();
+		}
+
+		$functionReflection = $this->broker->getCustomFunction(new Node\Name($node->name, $node->getAttributes()), $scope);
+		$returnType = $functionReflection->getReturnType();
+
+		if ($returnType instanceof MixedType && !$returnType->isExplicitMixed()) {
+			return [
+				sprintf(
+					'Function %s() has no return typehint specified',
+					$functionReflection->getName()
+				),
+			];
+		}
+
+		return [];
+	}
+
+	public function setBroker(Broker $broker): void
+	{
+		$this->broker = $broker;
+	}
+
+}

Diff for: tests/Rules/Functions/MissingFunctionReturnTypehintRuleTest.php

@@ -0,0 +1,30 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Rules\Functions;
+
+class MissingFunctionReturnTypehintRuleTest extends \PHPStan\Testing\RuleTestCase
+{
+
+	protected function getRule(): \PHPStan\Rules\Rule
+	{
+		$rule = new MissingFunctionReturnTypehintRule();
+		$rule->setBroker($this->createBroker([], []));
+
+		return $rule;
+	}
+
+	public function testRule(): void
+	{
+		$this->analyse([__DIR__ . '/data/missing-function-return-typehint.php'], [
+			[
+				'Function globalFunction1() has no return typehint specified',
+				5,
+			],
+			[
+				'Function MissingFunctionReturnTypehint\namespacedFunction1() has no return typehint specified',
+				30,
+			],
+		]);
+	}
+
+}

Diff for: tests/Rules/Functions/data/missing-function-return-typehint.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace
+{
+	function globalFunction1($a, $b, $c)
+	{
+		return false;
+	}
+
+	function globalFunction2($a, $b, $c): bool
+	{
+		$closure = function($a, $b, $c) {
+
+		};
+		
+		return false;
+	}
+
+	/**
+	 * @return bool
+	 */
+	function globalFunction3($a, $b, $c)
+	{
+		return false;
+	}
+}
+
+namespace MissingFunctionReturnTypehint
+{
+	function namespacedFunction1($d, $e)
+	{
+		return 9;
+	};
+
+	function namespacedFunction2($d, $e): int
+	{
+		return 9;
+	};
+
+	/**
+	 * @return int
+	 */
+	function namespacedFunction3($d, $e)
+	{
+		return 9;
+	};
+}