Add Type::isScalar()

phpstan · Dec 28, 2022 · 1e7b58a · 1e7b58a
1 parent a5b5090
commit 1e7b58a
Show file tree

Hide file tree

Showing 33 changed files with 251 additions and 0 deletions.
diff --git a/src/Type/Accessory/AccessoryArrayListType.php b/src/Type/Accessory/AccessoryArrayListType.php
@@ -322,6 +322,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function toNumber(): Type
 	{
 		return new ErrorType();

diff --git a/src/Type/Accessory/AccessoryLiteralStringType.php b/src/Type/Accessory/AccessoryLiteralStringType.php
@@ -236,6 +236,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function traverse(callable $cb): Type
 	{
 		return $this;

diff --git a/src/Type/Accessory/AccessoryNonEmptyStringType.php b/src/Type/Accessory/AccessoryNonEmptyStringType.php
@@ -236,6 +236,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function traverse(callable $cb): Type
 	{
 		return $this;

diff --git a/src/Type/Accessory/AccessoryNonFalsyStringType.php b/src/Type/Accessory/AccessoryNonFalsyStringType.php
@@ -236,6 +236,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function traverse(callable $cb): Type
 	{
 		return $this;

diff --git a/src/Type/Accessory/AccessoryNumericStringType.php b/src/Type/Accessory/AccessoryNumericStringType.php
@@ -239,6 +239,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function traverse(callable $cb): Type
 	{
 		return $this;

diff --git a/src/Type/Accessory/HasOffsetType.php b/src/Type/Accessory/HasOffsetType.php
@@ -239,6 +239,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createMaybe();
+	}
+
 	public function getKeysArray(): Type
 	{
 		return new NonEmptyArrayType();

diff --git a/src/Type/Accessory/HasOffsetValueType.php b/src/Type/Accessory/HasOffsetValueType.php
@@ -290,6 +290,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createMaybe();
+	}
+
 	public function toNumber(): Type
 	{
 		return new ErrorType();

diff --git a/src/Type/Accessory/NonEmptyArrayType.php b/src/Type/Accessory/NonEmptyArrayType.php
@@ -307,6 +307,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function toNumber(): Type
 	{
 		return new ErrorType();

diff --git a/src/Type/Accessory/OversizedArrayType.php b/src/Type/Accessory/OversizedArrayType.php
@@ -306,6 +306,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function toNumber(): Type
 	{
 		return new ErrorType();

diff --git a/src/Type/ArrayType.php b/src/Type/ArrayType.php
@@ -327,6 +327,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isOffsetAccessible(): TrinaryLogic
 	{
 		return TrinaryLogic::createYes();

diff --git a/src/Type/BooleanType.php b/src/Type/BooleanType.php
@@ -113,6 +113,11 @@ public function isBoolean(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function tryRemove(Type $typeToRemove): ?Type
 	{
 		if ($typeToRemove instanceof ConstantBooleanType) {

diff --git a/src/Type/CallableType.php b/src/Type/CallableType.php
@@ -392,6 +392,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createMaybe();
+	}
+
 	public function isCommonCallable(): bool
 	{
 		return $this->isCommonCallable;

diff --git a/src/Type/ClosureType.php b/src/Type/ClosureType.php
@@ -461,6 +461,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	/**
 	 * @param mixed[] $properties
 	 */

diff --git a/src/Type/FloatType.php b/src/Type/FloatType.php
@@ -191,6 +191,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function traverse(callable $cb): Type
 	{
 		return $this;

diff --git a/src/Type/IntegerType.php b/src/Type/IntegerType.php
@@ -123,6 +123,11 @@ public function isInteger(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function tryRemove(Type $typeToRemove): ?Type
 	{
 		if ($typeToRemove instanceof IntegerRangeType || $typeToRemove instanceof ConstantIntegerType) {

diff --git a/src/Type/IntersectionType.php b/src/Type/IntersectionType.php
@@ -534,6 +534,11 @@ public function isVoid(): TrinaryLogic
 		return $this->intersectResults(static fn (Type $type): TrinaryLogic => $type->isVoid());
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return $this->intersectResults(static fn (Type $type): TrinaryLogic => $type->isScalar());
+	}
+
 	public function isOffsetAccessible(): TrinaryLogic
 	{
 		return $this->intersectResults(static fn (Type $type): TrinaryLogic => $type->isOffsetAccessible());

diff --git a/src/Type/IterableType.php b/src/Type/IterableType.php
@@ -330,6 +330,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function inferTemplateTypes(Type $receivedType): TemplateTypeMap
 	{
 		if ($receivedType instanceof UnionType || $receivedType instanceof IntersectionType) {

diff --git a/src/Type/MixedType.php b/src/Type/MixedType.php
@@ -776,6 +776,17 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		if ($this->subtractedType !== null) {
+			if ($this->subtractedType->isSuperTypeOf(new UnionType([new BooleanType(), new FloatType(), new IntegerType(), new StringType()]))->yes()) {
+				return TrinaryLogic::createNo();
+			}
+		}
+
+		return TrinaryLogic::createMaybe();
+	}
+
 	public function tryRemove(Type $typeToRemove): ?Type
 	{
 		if ($this->isSuperTypeOf($typeToRemove)->yes()) {

diff --git a/src/Type/NeverType.php b/src/Type/NeverType.php
@@ -403,6 +403,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	/**
 	 * @param mixed[] $properties
 	 */

diff --git a/src/Type/NonexistentParentClassType.php b/src/Type/NonexistentParentClassType.php
@@ -134,6 +134,11 @@ public function toArrayKey(): Type
 		return new ErrorType();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	/**
 	 * @param mixed[] $properties
 	 */

diff --git a/src/Type/NullType.php b/src/Type/NullType.php
@@ -247,6 +247,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function getSmallerType(): Type
 	{
 		return new NeverType();

diff --git a/src/Type/ObjectType.php b/src/Type/ObjectType.php
@@ -909,6 +909,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	private function isExtraOffsetAccessibleClass(): TrinaryLogic
 	{
 		$classReflection = $this->getClassReflection();

diff --git a/src/Type/ResourceType.php b/src/Type/ResourceType.php
@@ -2,6 +2,7 @@
 
 namespace PHPStan\Type;
 
+use PHPStan\TrinaryLogic;
 use PHPStan\Type\Constant\ConstantArrayType;
 use PHPStan\Type\Constant\ConstantIntegerType;
 use PHPStan\Type\Traits\NonArrayTypeTrait;
@@ -82,6 +83,11 @@ public function toArrayKey(): Type
 		return new ErrorType();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	/**
 	 * @param mixed[] $properties
 	 */

diff --git a/src/Type/StaticType.php b/src/Type/StaticType.php
@@ -496,6 +496,11 @@ public function isVoid(): TrinaryLogic
 		return $this->getStaticObjectType()->isVoid();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return $this->getStaticObjectType()->isScalar();
+	}
+
 	/**
 	 * @return ParametersAcceptor[]
 	 */

diff --git a/src/Type/StrictMixedType.php b/src/Type/StrictMixedType.php
@@ -222,6 +222,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isOffsetAccessible(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();

diff --git a/src/Type/StringType.php b/src/Type/StringType.php
@@ -209,6 +209,11 @@ public function isClassStringType(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function hasMethod(string $methodName): TrinaryLogic
 	{
 		if ($this->isClassStringType()->yes()) {

diff --git a/src/Type/Traits/LateResolvableTypeTrait.php b/src/Type/Traits/LateResolvableTypeTrait.php
@@ -380,6 +380,11 @@ public function isVoid(): TrinaryLogic
 		return $this->resolve()->isVoid();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return $this->resolve()->isScalar();
+	}
+
 	public function getSmallerType(): Type
 	{
 		return $this->resolve()->getSmallerType();

diff --git a/src/Type/Traits/ObjectTypeTrait.php b/src/Type/Traits/ObjectTypeTrait.php
@@ -171,6 +171,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function toNumber(): Type
 	{
 		return new ErrorType();

diff --git a/src/Type/Type.php b/src/Type/Type.php
@@ -171,6 +171,8 @@ public function isClassStringType(): TrinaryLogic;
 
 	public function isVoid(): TrinaryLogic;
 
+	public function isScalar(): TrinaryLogic;
+
 	public function getSmallerType(): Type;
 
 	public function getSmallerOrEqualType(): Type;

diff --git a/src/Type/UnionType.php b/src/Type/UnionType.php
@@ -526,6 +526,11 @@ public function isVoid(): TrinaryLogic
 		return $this->unionResults(static fn (Type $type): TrinaryLogic => $type->isVoid());
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return $this->unionResults(static fn (Type $type): TrinaryLogic => $type->isScalar());
+	}
+
 	public function isOffsetAccessible(): TrinaryLogic
 	{
 		return $this->unionResults(static fn (Type $type): TrinaryLogic => $type->isOffsetAccessible());

diff --git a/src/Type/VoidType.php b/src/Type/VoidType.php
@@ -169,6 +169,11 @@ public function isVoid(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isScalar(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function traverse(callable $cb): Type
 	{
 		return $this;