FunctionReflection::isPure() and ExtendedMethodReflection::isPure()

phpstan · Feb 20, 2024 · 03d01ea · 03d01ea
1 parent e94a9fc
commit 03d01ea
Show file tree

Hide file tree

Showing 17 changed files with 117 additions and 0 deletions.
diff --git a/src/Reflection/Annotations/AnnotationMethodReflection.php b/src/Reflection/Annotations/AnnotationMethodReflection.php
@@ -155,4 +155,13 @@ public function isAbstract(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isPure(): TrinaryLogic
+	{
+		if ($this->hasSideEffects()->yes()) {
+			return TrinaryLogic::createNo();
+		}
+
+		return TrinaryLogic::createMaybe();
+	}
+
 }
diff --git a/src/Reflection/Dummy/ChangedTypeMethodReflection.php b/src/Reflection/Dummy/ChangedTypeMethodReflection.php
@@ -127,4 +127,9 @@ public function isAbstract(): TrinaryLogic
 		return $abstract;
 	}
 
+	public function isPure(): TrinaryLogic
+	{
+		return $this->reflection->isPure();
+	}
+
 }
diff --git a/src/Reflection/Dummy/DummyConstructorReflection.php b/src/Reflection/Dummy/DummyConstructorReflection.php
@@ -131,4 +131,9 @@ public function isAbstract(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isPure(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 }
diff --git a/src/Reflection/Dummy/DummyMethodReflection.php b/src/Reflection/Dummy/DummyMethodReflection.php
@@ -123,4 +123,9 @@ public function isAbstract(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isPure(): TrinaryLogic
+	{
+		return TrinaryLogic::createMaybe();
+	}
+
 }
diff --git a/src/Reflection/ExtendedMethodReflection.php b/src/Reflection/ExtendedMethodReflection.php
@@ -42,4 +42,13 @@ public function isFinalByKeyword(): TrinaryLogic;
 
 	public function isAbstract(): TrinaryLogic|bool;
 
+	/**
+	 * This indicates whether the method has phpstan-pure
+	 * or phpstan-impure annotation above it.
+	 *
+	 * In most cases asking hasSideEffects() is much more practical
+	 * as it also accounts for void return type (method being always impure).
+	 */
+	public function isPure(): TrinaryLogic;
+
 }
diff --git a/src/Reflection/FunctionReflection.php b/src/Reflection/FunctionReflection.php
@@ -43,4 +43,13 @@ public function getDocComment(): ?string;
 
 	public function returnsByReference(): TrinaryLogic;
 
+	/**
+	 * This indicates whether the function has phpstan-pure
+	 * or phpstan-impure annotation above it.
+	 *
+	 * In most cases asking hasSideEffects() is much more practical
+	 * as it also accounts for void return type (method being always impure).
+	 */
+	public function isPure(): TrinaryLogic;
+
 }
diff --git a/src/Reflection/Native/NativeFunctionReflection.php b/src/Reflection/Native/NativeFunctionReflection.php
@@ -92,6 +92,15 @@ public function hasSideEffects(): TrinaryLogic
 		return $this->hasSideEffects;
 	}
 
+	public function isPure(): TrinaryLogic
+	{
+		if ($this->hasSideEffects()->yes()) {
+			return TrinaryLogic::createNo();
+		}
+
+		return $this->hasSideEffects->negate();
+	}
+
 	private function isVoid(): bool
 	{
 		foreach ($this->variants as $variant) {

diff --git a/src/Reflection/Native/NativeMethodReflection.php b/src/Reflection/Native/NativeMethodReflection.php
@@ -153,6 +153,15 @@ public function hasSideEffects(): TrinaryLogic
 		return $this->hasSideEffects;
 	}
 
+	public function isPure(): TrinaryLogic
+	{
+		if ($this->hasSideEffects()->yes()) {
+			return TrinaryLogic::createNo();
+		}
+
+		return $this->hasSideEffects->negate();
+	}
+
 	private function isVoid(): bool
 	{
 		foreach ($this->variants as $variant) {

diff --git a/src/Reflection/Php/ClosureCallMethodReflection.php b/src/Reflection/Php/ClosureCallMethodReflection.php
@@ -168,4 +168,9 @@ public function isAbstract(): TrinaryLogic
 		return $abstract;
 	}
 
+	public function isPure(): TrinaryLogic
+	{
+		return $this->nativeMethodReflection->isPure();
+	}
+
 }
diff --git a/src/Reflection/Php/EnumCasesMethodReflection.php b/src/Reflection/Php/EnumCasesMethodReflection.php
@@ -135,4 +135,9 @@ public function isAbstract(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isPure(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 }
diff --git a/src/Reflection/Php/PhpFunctionFromParserNodeReflection.php b/src/Reflection/Php/PhpFunctionFromParserNodeReflection.php
@@ -281,4 +281,13 @@ public function returnsByReference(): TrinaryLogic
 		return TrinaryLogic::createFromBoolean($this->functionLike->returnsByRef());
 	}
 
+	public function isPure(): TrinaryLogic
+	{
+		if ($this->isPure === null) {
+			return TrinaryLogic::createMaybe();
+		}
+
+		return TrinaryLogic::createFromBoolean($this->isPure);
+	}
+
 }
diff --git a/src/Reflection/Php/PhpFunctionReflection.php b/src/Reflection/Php/PhpFunctionReflection.php
@@ -254,6 +254,15 @@ public function hasSideEffects(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}
 
+	public function isPure(): TrinaryLogic
+	{
+		if ($this->isPure === null) {
+			return TrinaryLogic::createMaybe();
+		}
+
+		return TrinaryLogic::createFromBoolean($this->isPure);
+	}
+
 	public function isBuiltin(): bool
 	{
 		return $this->reflection->isInternal();

diff --git a/src/Reflection/Php/PhpMethodReflection.php b/src/Reflection/Php/PhpMethodReflection.php
@@ -458,4 +458,13 @@ public function returnsByReference(): TrinaryLogic
 		return $this->reflection->returnsByReference();
 	}
 
+	public function isPure(): TrinaryLogic
+	{
+		if ($this->isPure === null) {
+			return TrinaryLogic::createMaybe();
+		}
+
+		return TrinaryLogic::createFromBoolean($this->isPure);
+	}
+
 }
diff --git a/src/Reflection/ResolvedMethodReflection.php b/src/Reflection/ResolvedMethodReflection.php
@@ -155,6 +155,11 @@ public function hasSideEffects(): TrinaryLogic
 		return $this->reflection->hasSideEffects();
 	}
 
+	public function isPure(): TrinaryLogic
+	{
+		return $this->reflection->hasSideEffects();
+	}
+
 	public function getAsserts(): Assertions
 	{
 		return $this->asserts ??= $this->reflection->getAsserts()->mapTypes(fn (Type $type) => TemplateTypeHelper::resolveTemplateTypes(

diff --git a/src/Reflection/Type/IntersectionTypeMethodReflection.php b/src/Reflection/Type/IntersectionTypeMethodReflection.php
@@ -166,6 +166,11 @@ public function hasSideEffects(): TrinaryLogic
 		return TrinaryLogic::lazyMaxMin($this->methods, static fn (MethodReflection $method): TrinaryLogic => $method->hasSideEffects());
 	}
 
+	public function isPure(): TrinaryLogic
+	{
+		return TrinaryLogic::lazyMaxMin($this->methods, static fn (ExtendedMethodReflection $method): TrinaryLogic => $method->isPure());
+	}
+
 	public function getDocComment(): ?string
 	{
 		return null;

diff --git a/src/Reflection/Type/UnionTypeMethodReflection.php b/src/Reflection/Type/UnionTypeMethodReflection.php
@@ -154,6 +154,11 @@ public function hasSideEffects(): TrinaryLogic
 		return TrinaryLogic::lazyExtremeIdentity($this->methods, static fn (MethodReflection $method): TrinaryLogic => $method->hasSideEffects());
 	}
 
+	public function isPure(): TrinaryLogic
+	{
+		return TrinaryLogic::lazyExtremeIdentity($this->methods, static fn (ExtendedMethodReflection $method): TrinaryLogic => $method->isPure());
+	}
+
 	public function getDocComment(): ?string
 	{
 		return null;

diff --git a/src/Reflection/WrappedExtendedMethodReflection.php b/src/Reflection/WrappedExtendedMethodReflection.php
@@ -125,6 +125,11 @@ public function hasSideEffects(): TrinaryLogic
 		return $this->method->hasSideEffects();
 	}
 
+	public function isPure(): TrinaryLogic
+	{
+		return TrinaryLogic::createMaybe();
+	}
+
 	public function getAsserts(): Assertions
 	{
 		return Assertions::createEmpty();