Implement TypeSpecifierContext->getReturnType()

Author: staabm

src/Analyser/TypeSpecifierContext.php

@@ -3,6 +3,7 @@
 namespace PHPStan\Analyser;
 
 use PHPStan\ShouldNotHappenException;
+use PHPStan\Type\MixedType;
 
 /**
  * @api
@@ -89,4 +90,8 @@ public function null(): bool
 		return $this->value === null;
 	}
 
+	public function getReturnType(): Type {
+		return new MixedType();
+	}
+
 }

tests/PHPStan/Analyser/TypeSpecifierContextReturnTypeExtension.neon

@@ -0,0 +1,5 @@
+services:
+	-
+		class: PHPStan\Analyser\TypeSpecifierContextReturnTypeExtension
+		tags:
+			- phpstan.typeSpecifier.methodTypeSpecifyingExtension

tests/PHPStan/Analyser/TypeSpecifierContextReturnTypeExtension.php

@@ -0,0 +1,58 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Analyser;
+
+use PhpParser\Node\Expr\MethodCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Analyser\SpecifiedTypes;
+use PHPStan\Analyser\TypeSpecifier;
+use PHPStan\Analyser\TypeSpecifierAwareExtension;
+use PHPStan\Analyser\TypeSpecifierContext;
+use PHPStan\Reflection\MethodReflection;
+use PHPStan\Rules\Properties\PropertyReflectionFinder;
+use PHPStan\Type\Accessory\HasPropertyType;
+use PHPStan\Type\IntersectionType;
+use PHPStan\Type\MethodTypeSpecifyingExtension;
+use PHPStan\Type\ObjectWithoutClassType;
+use PHPStan\Type\StringType;
+
+class TypeSpecifierContextReturnTypeExtension implements MethodTypeSpecifyingExtension, TypeSpecifierAwareExtension
+{
+
+	private TypeSpecifier $typeSpecifier;
+
+	public function setTypeSpecifier(TypeSpecifier $typeSpecifier): void
+	{
+		$this->typeSpecifier = $typeSpecifier;
+	}
+
+	public function getClass(): string
+	{
+		return \TypeSpecifierContextReturnTypeTest\ContextReturnType::class;
+	}
+
+	public function isMethodSupported(
+		MethodReflection $methodReflection,
+		MethodCall $node,
+		TypeSpecifierContext $context,
+	): bool
+	{
+		return str_starts_with($methodReflection->getName(), 'returns');
+	}
+
+	public function specifyTypes(
+		MethodReflection $methodReflection,
+		MethodCall $node,
+		Scope $scope,
+		TypeSpecifierContext $context,
+	): SpecifiedTypes
+	{
+		return $this->typeSpecifier->create(
+			$node->getArgs()[0]->value,
+			$context->getReturnType(),
+			$context,
+			$scope,
+		);
+	}
+
+}

tests/PHPStan/Analyser/TypeSpecifierContextReturnTypeTest.php

@@ -0,0 +1,36 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Analyser;
+
+use PHPStan\ShouldNotHappenException;
+use PHPStan\Testing\PHPStanTestCase;
+use PHPStan\Testing\TypeInferenceTestCase;
+
+class TypeSpecifierContextReturnTypeTest extends TypeInferenceTestCase
+{
+	public function dataContextReturnType(): iterable
+	{
+		yield from $this->gatherAssertTypes(__DIR__ . '/data/type-specifier-context-return-type.php');
+	}
+
+	/**
+	 * @dataProvider dataContextReturnType
+	 * @param mixed ...$args
+	 */
+	public function testContextReturnType(
+		string $assertType,
+		string $file,
+			   ...$args,
+	): void
+	{
+		$this->assertFileAsserts($assertType, $file, ...$args);
+	}
+
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [
+			__DIR__.'/TypeSpecifierContextReturnTypeExtension.neon'
+		];
+	}
+
+}

tests/PHPStan/Analyser/data/type-specifier-context-return-type.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace TypeSpecifierContextReturnTypeTest;
+
+use function PHPStan\Testing\assertType;
+
+class ContextReturnType {
+	public function returnsInt(int $specifiedContextReturnType): int {}
+
+	public function doFoo(int $i) {
+		assertType('int', $i);
+		if ($this->returnsInt($i) > 0) {
+			assertType('int<1, max>', $i);
+		} else {
+			assertType('int<min, 0>', $i);
+		}
+		assertType('int', $i);
+	}
+}