Skip to content

Commit 4482676

Browse files
staabmstaabm
committed
Implement ArrayAccess->offsetExists narrowing
1 parent 06d592d commit 4482676

5 files changed

+196
-4
lines changed

‎conf/config.neon

+10
Original file line numberDiff line numberDiff line change
@@ -1097,6 +1097,16 @@ services:
10971097
tags:
10981098
- phpstan.broker.dynamicFunctionReturnTypeExtension
10991099

1100+
-
1101+
class: PHPStan\Type\Php\ArrayAccessOffsetExistsMethodTypeSpecifyingExtension
1102+
tags:
1103+
- phpstan.typeSpecifier.methodTypeSpecifyingExtension
1104+
1105+
-
1106+
class: PHPStan\Type\Php\ArrayAccessOffsetGetMethodReturnTypeExtension
1107+
tags:
1108+
- phpstan.broker.dynamicMethodReturnTypeExtension
1109+
11001110
-
11011111
class: PHPStan\Type\Php\ArrayIntersectKeyFunctionReturnTypeExtension
11021112
tags:

‎src/Type/ObjectType.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -1149,14 +1149,14 @@ public function hasOffsetValueType(Type $offsetType): TrinaryLogic
11491149

11501150
public function getOffsetValueType(Type $offsetType): Type
11511151
{
1152-
if (!$this->isExtraOffsetAccessibleClass()->no()) {
1153-
return new MixedType();
1154-
}
1155-
11561152
if ($this->isInstanceOf(ArrayAccess::class)->yes()) {
11571153
return RecursionGuard::run($this, fn (): Type => $this->getMethod('offsetGet', new OutOfClassScope())->getOnlyVariant()->getReturnType());
11581154
}
11591155

1156+
if (!$this->isExtraOffsetAccessibleClass()->no()) {
1157+
return new MixedType();
1158+
}
1159+
11601160
return new ErrorType();
11611161
}
11621162

‎src/Type/Php/ArrayAccessOffsetExistsMethodTypeSpecifyingExtension.php

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Type\Php;
4+
5+
use ArrayAccess;
6+
use PhpParser\Node\Expr\MethodCall;
7+
use PHPStan\Analyser\Scope;
8+
use PHPStan\Analyser\SpecifiedTypes;
9+
use PHPStan\Analyser\TypeSpecifier;
10+
use PHPStan\Analyser\TypeSpecifierAwareExtension;
11+
use PHPStan\Analyser\TypeSpecifierContext;
12+
use PHPStan\Reflection\MethodReflection;
13+
use PHPStan\Reflection\ReflectionProvider;
14+
use PHPStan\Type\Accessory\HasOffsetValueType;
15+
use PHPStan\Type\Constant\ConstantIntegerType;
16+
use PHPStan\Type\Constant\ConstantStringType;
17+
use PHPStan\Type\Generic\GenericObjectType;
18+
use PHPStan\Type\MethodTypeSpecifyingExtension;
19+
use function count;
20+
21+
final class ArrayAccessOffsetExistsMethodTypeSpecifyingExtension implements MethodTypeSpecifyingExtension, TypeSpecifierAwareExtension
22+
{
23+
24+
private TypeSpecifier $typeSpecifier;
25+
26+
public function setTypeSpecifier(TypeSpecifier $typeSpecifier): void
27+
{
28+
$this->typeSpecifier = $typeSpecifier;
29+
}
30+
31+
public function getClass(): string
32+
{
33+
return ArrayAccess::class;
34+
}
35+
36+
public function isMethodSupported(
37+
MethodReflection $methodReflection,
38+
MethodCall $node,
39+
TypeSpecifierContext $context,
40+
): bool
41+
{
42+
return $methodReflection->getName() === 'offsetExists' && $context->true();
43+
}
44+
45+
public function specifyTypes(MethodReflection $methodReflection, MethodCall $node, Scope $scope, TypeSpecifierContext $context): SpecifiedTypes
46+
{
47+
if (count($node->getArgs()) < 1) {
48+
return new SpecifiedTypes();
49+
}
50+
$key = $node->getArgs()[0]->value;
51+
$keyType = $scope->getType($key);
52+
53+
if (
54+
!$keyType instanceof ConstantStringType
55+
&& !$keyType instanceof ConstantIntegerType
56+
) {
57+
return new SpecifiedTypes();
58+
}
59+
60+
foreach ($scope->getType($node->var)->getObjectClassReflections() as $classReflection) {
61+
$implementsTags = $classReflection->getImplementsTags();
62+
63+
if (
64+
!isset($implementsTags[ArrayAccess::class])
65+
|| !$implementsTags[ArrayAccess::class]->getType() instanceof GenericObjectType
66+
) {
67+
continue;
68+
}
69+
70+
$implementsType = $implementsTags[ArrayAccess::class]->getType();
71+
$arrayAccessGenericTypes = $implementsType->getTypes();
72+
if (!isset($arrayAccessGenericTypes[1])) {
73+
continue;
74+
}
75+
76+
return $this->typeSpecifier->create(
77+
$node->var,
78+
new HasOffsetValueType($keyType, $arrayAccessGenericTypes[1]),
79+
$context,
80+
$scope,
81+
);
82+
}
83+
84+
return new SpecifiedTypes();
85+
}
86+
87+
}

‎src/Type/Php/ArrayAccessOffsetGetMethodReturnTypeExtension.php

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Type\Php;
4+
5+
use ArrayAccess;
6+
use PhpParser\Node\Expr\MethodCall;
7+
use PHPStan\Analyser\Scope;
8+
use PHPStan\Reflection\MethodReflection;
9+
use PHPStan\Type\DynamicMethodReturnTypeExtension;
10+
use PHPStan\Type\Type;
11+
use function count;
12+
13+
final class ArrayAccessOffsetGetMethodReturnTypeExtension implements DynamicMethodReturnTypeExtension
14+
{
15+
16+
public function getClass(): string
17+
{
18+
return ArrayAccess::class;
19+
}
20+
21+
public function isMethodSupported(
22+
MethodReflection $methodReflection,
23+
): bool
24+
{
25+
return $methodReflection->getName() === 'offsetGet';
26+
}
27+
28+
public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): ?Type
29+
{
30+
if (count($methodCall->getArgs()) < 1) {
31+
return null;
32+
}
33+
$key = $methodCall->getArgs()[0]->value;
34+
$keyType = $scope->getType($key);
35+
$objectType = $scope->getType($methodCall->var);
36+
37+
if (!$objectType->hasOffsetValueType($keyType)->yes()) {
38+
return null;
39+
}
40+
41+
return $objectType->getOffsetValueType($keyType);
42+
}
43+
44+
}

‎tests/PHPStan/Analyser/nsrt/bug-3323.php

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<?php
2+
3+
namespace Bug3323;
4+
5+
use function PHPStan\Testing\assertType;
6+
use ArrayAccess;
7+
8+
/**
9+
* @implements ArrayAccess<string, self>
10+
*/
11+
class FormView implements \ArrayAccess
12+
{
13+
public array $vars = [];
14+
15+
public function offsetExists($offset) {
16+
return array_key_exists($offset, $this->vars);
17+
}
18+
public function offsetGet($offset) {
19+
return $this->vars[$offset] ?? null;
20+
}
21+
public function offsetSet($offset, $value) {
22+
$this->vars[$offset] = $value;
23+
}
24+
public function offsetUnset($offset) {
25+
unset($this->vars[$offset]);
26+
}
27+
}
28+
29+
function doFoo() {
30+
$formView = new FormView();
31+
assertType('Bug3323\FormView', $formView);
32+
if ($formView->offsetExists('_token')) {
33+
assertType("Bug3323\FormView&hasOffsetValue('_token', Bug3323\FormView)", $formView);
34+
35+
$a = $formView->offsetGet('_token');
36+
assertType("Bug3323\FormView", $a);
37+
38+
$a = $formView->offsetGet(123);
39+
assertType("Bug3323\FormView|null", $a);
40+
} else {
41+
assertType('Bug3323\FormView', $formView);
42+
}
43+
assertType('Bug3323\FormView', $formView);
44+
45+
$a = $formView->offsetGet('_token');
46+
assertType("Bug3323\FormView|null", $a);
47+
48+
$a = $formView->offsetGet(123);
49+
assertType("Bug3323\FormView|null", $a);
50+
}
51+

0 commit comments

Comments
 (0)