Implement Type::isOffsetAccessLegal() to detect offset access that …

…crashes even in `isset()`
phpstan · May 7, 2024 · e55a83f · e55a83f
1 parent 78d3d99
commit e55a83f
Show file tree

Hide file tree

Showing 41 changed files with 404 additions and 1 deletion.
diff --git a/src/Rules/Arrays/NonexistentOffsetInArrayDimFetchRule.php b/src/Rules/Arrays/NonexistentOffsetInArrayDimFetchRule.php
@@ -64,7 +64,7 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		if ($scope->isUndefinedExpressionAllowed($node) && !$isOffsetAccessible->no()) {
+		if ($scope->isUndefinedExpressionAllowed($node) && $isOffsetAccessibleType->isOffsetAccessLegal()->yes()) {
 			return [];
 		}
 

diff --git a/src/Type/Accessory/AccessoryArrayListType.php b/src/Type/Accessory/AccessoryArrayListType.php
@@ -142,6 +142,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		return $this->getIterableKeyType()->isSuperTypeOf($offsetType)->and(TrinaryLogic::createMaybe());

diff --git a/src/Type/Accessory/AccessoryLiteralStringType.php b/src/Type/Accessory/AccessoryLiteralStringType.php
@@ -132,6 +132,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		return $offsetType->isInteger()->and(TrinaryLogic::createMaybe());

diff --git a/src/Type/Accessory/AccessoryNonEmptyStringType.php b/src/Type/Accessory/AccessoryNonEmptyStringType.php
@@ -134,6 +134,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		return $offsetType->isInteger()->and(TrinaryLogic::createMaybe());

diff --git a/src/Type/Accessory/AccessoryNonFalsyStringType.php b/src/Type/Accessory/AccessoryNonFalsyStringType.php
@@ -134,6 +134,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		return $offsetType->isInteger()->and(TrinaryLogic::createMaybe());

diff --git a/src/Type/Accessory/AccessoryNumericStringType.php b/src/Type/Accessory/AccessoryNumericStringType.php
@@ -137,6 +137,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		return $offsetType->isInteger()->and(TrinaryLogic::createMaybe());

diff --git a/src/Type/Accessory/HasMethodType.php b/src/Type/Accessory/HasMethodType.php
@@ -120,6 +120,11 @@ public function describe(VerbosityLevel $level): string
 		return sprintf('hasMethod(%s)', $this->methodName);
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createMaybe();
+	}
+
 	public function hasMethod(string $methodName): TrinaryLogic
 	{
 		if ($this->getCanonicalMethodName() === strtolower($methodName)) {

diff --git a/src/Type/Accessory/HasOffsetType.php b/src/Type/Accessory/HasOffsetType.php
@@ -138,6 +138,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		if ($offsetType->isConstantScalarValue()->yes() && $offsetType->equals($this->offsetType)) {

diff --git a/src/Type/Accessory/HasOffsetValueType.php b/src/Type/Accessory/HasOffsetValueType.php
@@ -146,6 +146,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		if ($offsetType->isConstantScalarValue()->yes() && $offsetType->equals($this->offsetType)) {

diff --git a/src/Type/Accessory/HasPropertyType.php b/src/Type/Accessory/HasPropertyType.php
@@ -118,6 +118,11 @@ public function describe(VerbosityLevel $level): string
 		return sprintf('hasProperty(%s)', $this->propertyName);
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createMaybe();
+	}
+
 	public function hasProperty(string $propertyName): TrinaryLogic
 	{
 		if ($this->propertyName === $propertyName) {

diff --git a/src/Type/Accessory/NonEmptyArrayType.php b/src/Type/Accessory/NonEmptyArrayType.php
@@ -139,6 +139,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		return TrinaryLogic::createMaybe();

diff --git a/src/Type/Accessory/OversizedArrayType.php b/src/Type/Accessory/OversizedArrayType.php
@@ -135,6 +135,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		return TrinaryLogic::createMaybe();

diff --git a/src/Type/ArrayType.php b/src/Type/ArrayType.php
@@ -393,6 +393,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		$offsetType = $offsetType->toArrayKey();

diff --git a/src/Type/BooleanType.php b/src/Type/BooleanType.php
@@ -96,6 +96,11 @@ public function toArrayKey(): Type
 		return new UnionType([new ConstantIntegerType(0), new ConstantIntegerType(1)]);
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function isNull(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();

diff --git a/src/Type/CallableType.php b/src/Type/CallableType.php
@@ -324,6 +324,11 @@ public function toArrayKey(): Type
 		return new ErrorType();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createMaybe();
+	}
+
 	public function getTemplateTypeMap(): TemplateTypeMap
 	{
 		return $this->templateTypeMap;

diff --git a/src/Type/ClosureType.php b/src/Type/ClosureType.php
@@ -261,6 +261,11 @@ function (): string {
 		);
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isObject(): TrinaryLogic
 	{
 		return $this->objectType->isObject();

diff --git a/src/Type/FloatType.php b/src/Type/FloatType.php
@@ -144,6 +144,11 @@ public function toArrayKey(): Type
 		return new IntegerType();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function isNull(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();

diff --git a/src/Type/IntegerType.php b/src/Type/IntegerType.php
@@ -96,6 +96,11 @@ public function toArrayKey(): Type
 		return $this;
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function isNull(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();

diff --git a/src/Type/IntersectionType.php b/src/Type/IntersectionType.php
@@ -672,6 +672,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return $this->intersectResults(static fn (Type $type): TrinaryLogic => $type->isOffsetAccessible());
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return $this->intersectResults(static fn (Type $type): TrinaryLogic => $type->isOffsetAccessLegal());
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		if ($this->isList()->yes() && $this->isIterableAtLeastOnce()->yes()) {

diff --git a/src/Type/IterableType.php b/src/Type/IterableType.php
@@ -242,6 +242,11 @@ public function toArrayKey(): Type
 		return new ErrorType();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createMaybe();
+	}
+
 	public function isIterable(): TrinaryLogic
 	{
 		return TrinaryLogic::createYes();

diff --git a/src/Type/MixedType.php b/src/Type/MixedType.php
@@ -566,6 +566,16 @@ public function isOffsetAccessible(): TrinaryLogic
 		return TrinaryLogic::createMaybe();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		if ($this->subtractedType !== null) {
+			if ($this->subtractedType->isSuperTypeOf(new ObjectWithoutClassType())->yes()) {
+				return TrinaryLogic::createYes();
+			}
+		}
+		return TrinaryLogic::createMaybe();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		if ($this->isOffsetAccessible()->no()) {

diff --git a/src/Type/NeverType.php b/src/Type/NeverType.php
@@ -257,6 +257,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		return TrinaryLogic::createYes();

diff --git a/src/Type/NonexistentParentClassType.php b/src/Type/NonexistentParentClassType.php
@@ -152,6 +152,11 @@ public function toArrayKey(): Type
 		return new ErrorType();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function isScalar(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();

diff --git a/src/Type/NullType.php b/src/Type/NullType.php
@@ -174,6 +174,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();

diff --git a/src/Type/ObjectShapeType.php b/src/Type/ObjectShapeType.php
@@ -428,6 +428,11 @@ public function describe(VerbosityLevel $level): string
 		);
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createMaybe();
+	}
+
 	public function getEnumCases(): array
 	{
 		return [];

diff --git a/src/Type/ObjectType.php b/src/Type/ObjectType.php
@@ -1099,6 +1099,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		);
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return $this->isOffsetAccessible();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		if ($this->isInstanceOf(ArrayAccess::class)->yes()) {

diff --git a/src/Type/ObjectWithoutClassType.php b/src/Type/ObjectWithoutClassType.php
@@ -140,6 +140,11 @@ function () use ($level): string {
 		);
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createMaybe();
+	}
+
 	public function getEnumCases(): array
 	{
 		return [];

diff --git a/src/Type/ResourceType.php b/src/Type/ResourceType.php
@@ -86,6 +86,11 @@ public function toArrayKey(): Type
 		return new ErrorType();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function isScalar(): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();

diff --git a/src/Type/StaticType.php b/src/Type/StaticType.php
@@ -375,6 +375,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return $this->getStaticObjectType()->isOffsetAccessible();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return $this->getStaticObjectType()->isOffsetAccessLegal();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		return $this->getStaticObjectType()->hasOffsetValueType($offsetType);

diff --git a/src/Type/StrictMixedType.php b/src/Type/StrictMixedType.php
@@ -310,6 +310,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return TrinaryLogic::createNo();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createNo();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		return TrinaryLogic::createNo();

diff --git a/src/Type/StringType.php b/src/Type/StringType.php
@@ -56,6 +56,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return TrinaryLogic::createYes();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return TrinaryLogic::createYes();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		return $offsetType->isInteger()->and(TrinaryLogic::createMaybe());

diff --git a/src/Type/Traits/LateResolvableTypeTrait.php b/src/Type/Traits/LateResolvableTypeTrait.php
@@ -222,6 +222,11 @@ public function isOffsetAccessible(): TrinaryLogic
 		return $this->resolve()->isOffsetAccessible();
 	}
 
+	public function isOffsetAccessLegal(): TrinaryLogic
+	{
+		return $this->resolve()->isOffsetAccessLegal();
+	}
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic
 	{
 		return $this->resolve()->hasOffsetValueType($offsetType);

diff --git a/src/Type/Type.php b/src/Type/Type.php
@@ -131,6 +131,8 @@ public function isList(): TrinaryLogic;
 
 	public function isOffsetAccessible(): TrinaryLogic;
 
+	public function isOffsetAccessLegal(): TrinaryLogic;
+
 	public function hasOffsetValueType(Type $offsetType): TrinaryLogic;
 
 	public function getOffsetValueType(Type $offsetType): Type;