Introduce @internal getOnlyVariant() method on FunctionReflection…

…/ExtendedMethodReflection to use instead of `selectSingle()`
phpstan · Sep 26, 2024 · 714877b · 714877b
1 parent 1322aaf
commit 714877b
Show file tree

Hide file tree

Showing 28 changed files with 149 additions and 43 deletions.
diff --git a/src/Analyser/MutatingScope.php b/src/Analyser/MutatingScope.php
@@ -5514,7 +5514,7 @@ private function exactInstantiation(New_ $node, string $className): ?Type
 
 		$assignedToProperty = $node->getAttribute(NewAssignedToPropertyVisitor::ATTRIBUTE_NAME);
 		if ($assignedToProperty !== null) {
-			$constructorVariant = ParametersAcceptorSelector::selectSingle($constructorMethod->getVariants());
+			$constructorVariant = $constructorMethod->getOnlyVariant();
 			$classTemplateTypes = $classReflection->getTemplateTypeMap()->getTypes();
 			$originalClassTemplateTypes = $classTemplateTypes;
 			foreach ($constructorVariant->getParameters() as $parameter) {

diff --git a/src/Reflection/Annotations/AnnotationMethodReflection.php b/src/Reflection/Annotations/AnnotationMethodReflection.php
@@ -7,6 +7,7 @@
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ExtendedMethodReflection;
 use PHPStan\Reflection\FunctionVariantWithPhpDocs;
+use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Generic\TemplateTypeMap;
 use PHPStan\Type\MixedType;
@@ -83,6 +84,11 @@ public function getVariants(): array
 		return $this->variants;
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		return $this->getVariants()[0];
+	}
+
 	public function getNamedArgumentsVariants(): ?array
 	{
 		return null;

diff --git a/src/Reflection/ClassReflection.php b/src/Reflection/ClassReflection.php
@@ -1305,7 +1305,7 @@ private function findAttributeFlags(): ?int
 				return null;
 			}
 			$attributeConstructor = $attributeClass->getConstructor();
-			$attributeConstructorVariant = ParametersAcceptorSelector::selectSingle($attributeConstructor->getVariants());
+			$attributeConstructorVariant = $attributeConstructor->getOnlyVariant();
 
 			if (count($arguments) === 0) {
 				$flagType = $attributeConstructorVariant->getParameters()[0]->getDefaultValue();

diff --git a/src/Reflection/Dummy/ChangedTypeMethodReflection.php b/src/Reflection/Dummy/ChangedTypeMethodReflection.php
@@ -7,8 +7,10 @@
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ExtendedMethodReflection;
 use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
+use PHPStan\ShouldNotHappenException;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Type;
+use function count;
 use function is_bool;
 
 final class ChangedTypeMethodReflection implements ExtendedMethodReflection
@@ -62,6 +64,16 @@ public function getVariants(): array
 		return $this->variants;
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		$variants = $this->getVariants();
+		if (count($variants) !== 1) {
+			throw new ShouldNotHappenException();
+		}
+
+		return $variants[0];
+	}
+
 	public function getNamedArgumentsVariants(): ?array
 	{
 		return $this->namedArgumentsVariants;

diff --git a/src/Reflection/Dummy/DummyConstructorReflection.php b/src/Reflection/Dummy/DummyConstructorReflection.php
@@ -7,6 +7,7 @@
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ExtendedMethodReflection;
 use PHPStan\Reflection\FunctionVariantWithPhpDocs;
+use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Generic\TemplateTypeMap;
 use PHPStan\Type\MixedType;
@@ -66,6 +67,11 @@ public function getVariants(): array
 		];
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		return $this->getVariants()[0];
+	}
+
 	public function getNamedArgumentsVariants(): ?array
 	{
 		return null;

diff --git a/src/Reflection/Dummy/DummyMethodReflection.php b/src/Reflection/Dummy/DummyMethodReflection.php
@@ -6,6 +6,7 @@
 use PHPStan\Reflection\ClassMemberReflection;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ExtendedMethodReflection;
+use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
 use PHPStan\Reflection\ReflectionProviderStaticAccessor;
 use PHPStan\Reflection\TrivialParametersAcceptor;
 use PHPStan\TrinaryLogic;
@@ -58,6 +59,11 @@ public function getVariants(): array
 		];
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		return $this->getVariants()[0];
+	}
+
 	public function getNamedArgumentsVariants(): ?array
 	{
 		return null;

diff --git a/src/Reflection/ExtendedMethodReflection.php b/src/Reflection/ExtendedMethodReflection.php
@@ -27,6 +27,11 @@ interface ExtendedMethodReflection extends MethodReflection
 	 */
 	public function getVariants(): array;
 
+	/**
+	 * @internal
+	 */
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs;
+
 	/**
 	 * @return ParametersAcceptorWithPhpDocs[]|null
 	 */

diff --git a/src/Reflection/FunctionReflection.php b/src/Reflection/FunctionReflection.php
@@ -18,6 +18,11 @@ public function getFileName(): ?string;
 	 */
 	public function getVariants(): array;
 
+	/**
+	 * @internal
+	 */
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs;
+
 	/**
 	 * @return ParametersAcceptorWithPhpDocs[]|null
 	 */

diff --git a/src/Reflection/Native/NativeFunctionReflection.php b/src/Reflection/Native/NativeFunctionReflection.php
@@ -5,8 +5,10 @@
 use PHPStan\Reflection\Assertions;
 use PHPStan\Reflection\FunctionReflection;
 use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
+use PHPStan\ShouldNotHappenException;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Type;
+use function count;
 
 final class NativeFunctionReflection implements FunctionReflection
 {
@@ -46,14 +48,21 @@ public function getFileName(): ?string
 		return null;
 	}
 
-	/**
-	 * @return ParametersAcceptorWithPhpDocs[]
-	 */
 	public function getVariants(): array
 	{
 		return $this->variants;
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		$variants = $this->getVariants();
+		if (count($variants) !== 1) {
+			throw new ShouldNotHappenException();
+		}
+
+		return $variants[0];
+	}
+
 	public function getNamedArgumentsVariants(): ?array
 	{
 		return $this->namedArgumentsVariants;

diff --git a/src/Reflection/Native/NativeMethodReflection.php b/src/Reflection/Native/NativeMethodReflection.php
@@ -10,10 +10,12 @@
 use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
 use PHPStan\Reflection\Php\BuiltinMethodReflection;
 use PHPStan\Reflection\ReflectionProvider;
+use PHPStan\ShouldNotHappenException;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypehintHelper;
 use ReflectionException;
+use function count;
 use function strtolower;
 
 final class NativeMethodReflection implements ExtendedMethodReflection
@@ -109,6 +111,16 @@ public function getVariants(): array
 		return $this->variants;
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		$variants = $this->getVariants();
+		if (count($variants) !== 1) {
+			throw new ShouldNotHappenException();
+		}
+
+		return $variants[0];
+	}
+
 	public function getNamedArgumentsVariants(): ?array
 	{
 		return $this->namedArgumentsVariants;

diff --git a/src/Reflection/Php/ClosureCallMethodReflection.php b/src/Reflection/Php/ClosureCallMethodReflection.php
@@ -10,6 +10,7 @@
 use PHPStan\Reflection\Native\NativeParameterReflection;
 use PHPStan\Reflection\ParameterReflection;
 use PHPStan\Reflection\ParameterReflectionWithPhpDocs;
+use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
 use PHPStan\Reflection\PassedByReference;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\ClosureType;
@@ -105,6 +106,11 @@ public function getVariants(): array
 		];
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		return $this->getVariants()[0];
+	}
+
 	public function getNamedArgumentsVariants(): ?array
 	{
 		return null;

diff --git a/src/Reflection/Php/EnumCasesMethodReflection.php b/src/Reflection/Php/EnumCasesMethodReflection.php
@@ -7,6 +7,7 @@
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Reflection\ExtendedMethodReflection;
 use PHPStan\Reflection\FunctionVariantWithPhpDocs;
+use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
 use PHPStan\ShouldNotHappenException;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Generic\TemplateTypeMap;
@@ -75,6 +76,11 @@ public function getVariants(): array
 		];
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		return $this->getVariants()[0];
+	}
+
 	public function getNamedArgumentsVariants(): ?array
 	{
 		return null;

diff --git a/src/Reflection/Php/ExitFunctionReflection.php b/src/Reflection/Php/ExitFunctionReflection.php
@@ -69,6 +69,11 @@ public function getVariants(): array
 		];
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		return $this->getVariants()[0];
+	}
+
 	/**
 	 * @return ParametersAcceptorWithPhpDocs[]
 	 */

diff --git a/src/Reflection/Php/PhpFunctionFromParserNodeReflection.php b/src/Reflection/Php/PhpFunctionFromParserNodeReflection.php
@@ -116,6 +116,11 @@ public function getVariants(): array
 		return $this->variants;
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		return $this;
+	}
+
 	public function getNamedArgumentsVariants(): ?array
 	{
 		return null;

diff --git a/src/Reflection/Php/PhpFunctionReflection.php b/src/Reflection/Php/PhpFunctionReflection.php
@@ -107,6 +107,11 @@ public function getVariants(): array
 		return $this->variants;
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		return $this->getVariants()[0];
+	}
+
 	public function getNamedArgumentsVariants(): ?array
 	{
 		return null;

diff --git a/src/Reflection/Php/PhpMethodReflection.php b/src/Reflection/Php/PhpMethodReflection.php
@@ -212,6 +212,11 @@ public function getVariants(): array
 		return $this->variants;
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		return $this->getVariants()[0];
+	}
+
 	public function getNamedArgumentsVariants(): ?array
 	{
 		return null;

diff --git a/src/Reflection/Php/UniversalObjectCratesClassReflectionExtension.php b/src/Reflection/Php/UniversalObjectCratesClassReflectionExtension.php
@@ -4,7 +4,6 @@
 
 use PHPStan\Reflection\Annotations\AnnotationsPropertiesClassReflectionExtension;
 use PHPStan\Reflection\ClassReflection;
-use PHPStan\Reflection\ParametersAcceptorSelector;
 use PHPStan\Reflection\PropertiesClassReflectionExtension;
 use PHPStan\Reflection\PropertyReflection;
 use PHPStan\Reflection\ReflectionProvider;
@@ -66,13 +65,13 @@ public function getProperty(ClassReflection $classReflection, string $propertyNa
 		}
 
 		if ($classReflection->hasNativeMethod('__get')) {
-			$readableType = ParametersAcceptorSelector::selectSingle($classReflection->getNativeMethod('__get')->getVariants())->getReturnType();
+			$readableType = $classReflection->getNativeMethod('__get')->getOnlyVariant()->getReturnType();
 		} else {
 			$readableType = new MixedType();
 		}
 
 		if ($classReflection->hasNativeMethod('__set')) {
-			$writableType = ParametersAcceptorSelector::selectSingle($classReflection->getNativeMethod('__set')->getVariants())->getParameters()[1]->getType();
+			$writableType = $classReflection->getNativeMethod('__set')->getOnlyVariant()->getParameters()[1]->getType();
 		} else {
 			$writableType = new MixedType();
 		}

diff --git a/src/Reflection/ResolvedMethodReflection.php b/src/Reflection/ResolvedMethodReflection.php
@@ -52,6 +52,11 @@ public function getVariants(): array
 		return $this->variants = $this->resolveVariants($this->reflection->getVariants());
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		return $this->getVariants()[0];
+	}
+
 	public function getNamedArgumentsVariants(): ?array
 	{
 		$variants = $this->namedArgumentVariants;

diff --git a/src/Reflection/Type/IntersectionTypeMethodReflection.php b/src/Reflection/Type/IntersectionTypeMethodReflection.php
@@ -10,6 +10,7 @@
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\ParametersAcceptor;
 use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
+use PHPStan\ShouldNotHappenException;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
@@ -94,6 +95,16 @@ public function getVariants(): array
 		), $this->methods[0]->getVariants());
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		$variants = $this->getVariants();
+		if (count($variants) !== 1) {
+			throw new ShouldNotHappenException();
+		}
+
+		return $variants[0];
+	}
+
 	public function getNamedArgumentsVariants(): ?array
 	{
 		return null;

diff --git a/src/Reflection/Type/UnionTypeMethodReflection.php b/src/Reflection/Type/UnionTypeMethodReflection.php
@@ -8,6 +8,7 @@
 use PHPStan\Reflection\ExtendedMethodReflection;
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Reflection\ParametersAcceptorSelector;
+use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
 use PHPStan\TrinaryLogic;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
@@ -82,6 +83,11 @@ public function getVariants(): array
 		return [ParametersAcceptorSelector::combineAcceptors($variants)];
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		return $this->getVariants()[0];
+	}
+
 	public function getNamedArgumentsVariants(): ?array
 	{
 		return null;

diff --git a/src/Reflection/WrappedExtendedMethodReflection.php b/src/Reflection/WrappedExtendedMethodReflection.php
@@ -87,6 +87,11 @@ public function getVariants(): array
 		return $variants;
 	}
 
+	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+	{
+		return $this->getVariants()[0];
+	}
+
 	public function getNamedArgumentsVariants(): ?array
 	{
 		return null;
-Original file line number
+Diff line change
@@ Expand Up / @@ -69,6 +69,11 @@ public function getVariants(): array @@
     		];
     	}
+    	public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
+    	{
+    		return $this->getVariants()[0];
+    	}
     	/**
     	 * @return ParametersAcceptorWithPhpDocs[]
     	 */
@@ Expand Down @@