Function with yield returns value

Author: kukulich

SlevomatCodingStandard/Helpers/FunctionHelper.php

@@ -125,19 +125,28 @@ public static function returnsValue(\PHP_CodeSniffer_File $codeSnifferFile, int
 	{
 		$tokens = $codeSnifferFile->getTokens();
 
-		for ($i = $tokens[$functionPointer]['scope_opener'] + 1; $i < $tokens[$functionPointer]['scope_closer']; $i++) {
-			if ($tokens[$i]['code'] !== T_RETURN) {
-				continue;
-			}
-
-			foreach (array_reverse($tokens[$i]['conditions'], true) as $conditionPointer => $conditionTokenCode) {
+		$isInSameLevel = function (int $pointer) use ($functionPointer, $tokens): bool {
+			foreach (array_reverse($tokens[$pointer]['conditions'], true) as $conditionPointer => $conditionTokenCode) {
 				if ($conditionTokenCode === T_CLOSURE || $conditionTokenCode === T_ANON_CLASS) {
-					continue 2;
+					return false;
 				} elseif ($conditionPointer === $functionPointer) {
-					$nextEffectiveTokenPointer = TokenHelper::findNextEffective($codeSnifferFile, $i + 1);
-					return $tokens[$nextEffectiveTokenPointer]['code'] !== T_SEMICOLON;
+					break;
 				}
 			}
+			return true;
+		};
+
+		for ($i = $tokens[$functionPointer]['scope_opener'] + 1; $i < $tokens[$functionPointer]['scope_closer']; $i++) {
+			if ($tokens[$i]['code'] === T_YIELD && $isInSameLevel($i)) {
+				return true;
+			}
+		}
+
+		for ($i = $tokens[$functionPointer]['scope_opener'] + 1; $i < $tokens[$functionPointer]['scope_closer']; $i++) {
+			if ($tokens[$i]['code'] === T_RETURN && $isInSameLevel($i)) {
+				$nextEffectiveTokenPointer = TokenHelper::findNextEffective($codeSnifferFile, $i + 1);
+				return $tokens[$nextEffectiveTokenPointer]['code'] !== T_SEMICOLON;
+			}
 		}
 
 		return false;

tests/Helpers/FunctionHelperTest.php

@@ -247,6 +247,10 @@ public function dataReturnsValueOrNot(): array
 			['returnsValue', true],
 			['returnsVariable', true],
 			['returnsValueInCondition', true],
+			['returnsGenerator', true],
+			['returnsGeneratorWithEarlyTermination', true],
+			['returnsGeneratorWithVeryEarlyTermination', true],
+			['generatorIsInClosure', false],
 			['noReturn', false],
 			['returnsVoid', false],
 			['containsClosure', false],

tests/Helpers/data/functionReturnsValueOrNot.php

@@ -23,6 +23,35 @@ public function returnsValueInCondition()
 		}
 	}
 
+	public function returnsGenerator(): \Generator
+	{
+		yield [];
+	}
+
+	public function returnsGeneratorWithEarlyTermination(): \Generator
+	{
+		if (true) {
+			yield [];
+			return;
+		}
+
+		yield [];
+	}
+
+	public function returnsGeneratorWithVeryEarlyTermination()
+	{
+		return;
+
+		yield [];
+	}
+
+	public function generatorIsInClosure()
+	{
+		$x = function (): \Generator {
+			yield [];
+		};
+	}
+
 	public function noReturn()
 	{
 		// Nothing