Skip to content

Commit 25dfd4f

Browse files
zonuexezonuexe
committed
Add stringable access check to ClassConstantRule
1 parent b225f74 commit 25dfd4f

File tree

7 files changed

+108
-2
lines changed

7 files changed

+108
-2
lines changed

‎conf/bleedingEdge.neon‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
parameters:
22
featureToggles:
33
bleedingEdge: true
4+
checkNonStringableDynamicAccess: true
45
checkParameterCastableToNumberFunctions: true
56
skipCheckGenericClasses!: []
67
stricterFunctionMap: true

‎conf/config.neon‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ parameters:
2222
tooWideThrowType: true
2323
featureToggles:
2424
bleedingEdge: false
25+
checkNonStringableDynamicAccess: false
2526
checkParameterCastableToNumberFunctions: false
2627
skipCheckGenericClasses: []
2728
stricterFunctionMap: false
@@ -882,6 +883,11 @@ services:
882883
-
883884
class: PHPStan\Rules\ClassForbiddenNameCheck
884885

886+
-
887+
class: PHPStan\Rules\Classes\ClassConstantRule
888+
arguments:
889+
checkNonStringableDynamicAccess: %featureToggles.checkNonStringableDynamicAccess%
890+
885891
-
886892
class: PHPStan\Rules\Classes\LocalTypeAliasesCheck
887893
arguments:

‎conf/parametersSchema.neon‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ parametersSchema:
2828
])
2929
featureToggles: structure([
3030
bleedingEdge: bool(),
31+
checkNonStringableDynamicAccess: bool(),
3132
checkParameterCastableToNumberFunctions: bool(),
3233
skipCheckGenericClasses: listOf(string()),
3334
stricterFunctionMap: bool()

‎src/Rules/Classes/ClassConstantRule.php‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ public function __construct(
3939
private RuleLevelHelper $ruleLevelHelper,
4040
private ClassNameCheck $classCheck,
4141
private PhpVersion $phpVersion,
42+
private bool $checkNonStringableDynamicAccess = true,
4243
)
4344
{
4445
}
@@ -60,6 +61,24 @@ public function processNode(Node $node, Scope $scope): array
6061
$name = $constantString->getValue();
6162
$constantNameScopes[$name] = $scope->filterByTruthyValue(new Identical($node->name, new String_($name)));
6263
}
64+
65+
if ($this->checkNonStringableDynamicAccess) {
66+
$accepts = $this->ruleLevelHelper->accepts(new StringType(), $nameType, true);
67+
$typeResult = $this->ruleLevelHelper->findTypeToCheck(
68+
$scope,
69+
$node->name,
70+
'',
71+
static fn (Type $type) => $type->toString()->isString()->yes()
72+
);
73+
74+
if (! $typeResult->getType()->isString()->yes() ||
75+
$typeResult->getType()->toString()->isNumericString()->yes()
76+
) {
77+
$errors[] = RuleErrorBuilder::message(sprintf('Cannot fetch class constant with a non-stringable type %s.', $nameType->describe(VerbosityLevel::typeOnly())))
78+
->identifier('classConstant.fetchInvalidExpression')
79+
->build();
80+
}
81+
}
6382
}
6483

6584
foreach ($constantNameScopes as $constantName => $constantScope) {

‎tests/PHPStan/Rules/Classes/ClassConstantRuleTest.php‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ class ClassConstantRuleTest extends RuleTestCase
1919

2020
private int $phpVersion;
2121

22+
private bool $checkNonStringableDynamicAccess;
23+
2224
protected function getRule(): Rule
2325
{
2426
$reflectionProvider = $this->createReflectionProvider();
@@ -30,12 +32,14 @@ protected function getRule(): Rule
3032
new ClassForbiddenNameCheck(self::getContainer()),
3133
),
3234
new PhpVersion($this->phpVersion),
35+
$this->checkNonStringableDynamicAccess,
3336
);
3437
}
3538

3639
public function testClassConstant(): void
3740
{
3841
$this->phpVersion = PHP_VERSION_ID;
42+
$this->checkNonStringableDynamicAccess = true;
3943
$this->analyse(
4044
[
4145
__DIR__ . '/data/class-constant.php',
@@ -99,6 +103,7 @@ public function testClassConstant(): void
99103
public function testClassConstantVisibility(): void
100104
{
101105
$this->phpVersion = PHP_VERSION_ID;
106+
$this->checkNonStringableDynamicAccess = true;
102107
$this->analyse([__DIR__ . '/data/class-constant-visibility.php'], [
103108
[
104109
'Access to private constant PRIVATE_BAR of class ClassConstantVisibility\Bar.',
@@ -168,6 +173,7 @@ public function testClassConstantVisibility(): void
168173
public function testClassExists(): void
169174
{
170175
$this->phpVersion = PHP_VERSION_ID;
176+
$this->checkNonStringableDynamicAccess = true;
171177
$this->analyse([__DIR__ . '/data/class-exists.php'], [
172178
[
173179
'Class UnknownClass\Bar not found.',
@@ -242,12 +248,14 @@ public function dataClassConstantOnExpression(): array
242248
public function testClassConstantOnExpression(int $phpVersion, array $errors): void
243249
{
244250
$this->phpVersion = $phpVersion;
251+
$this->checkNonStringableDynamicAccess = true;
245252
$this->analyse([__DIR__ . '/data/class-constant-on-expr.php'], $errors);
246253
}
247254

248255
public function testAttributes(): void
249256
{
250257
$this->phpVersion = PHP_VERSION_ID;
258+
$this->checkNonStringableDynamicAccess = true;
251259
$this->analyse([__DIR__ . '/data/class-constant-attribute.php'], [
252260
[
253261
'Access to undefined constant ClassConstantAttribute\Foo::BAR.',
@@ -287,18 +295,21 @@ public function testRuleWithNullsafeVariant(): void
287295
}
288296

289297
$this->phpVersion = PHP_VERSION_ID;
298+
$this->checkNonStringableDynamicAccess = true;
290299
$this->analyse([__DIR__ . '/data/class-constant-nullsafe.php'], []);
291300
}
292301

293302
public function testBug7675(): void
294303
{
295304
$this->phpVersion = PHP_VERSION_ID;
305+
$this->checkNonStringableDynamicAccess = true;
296306
$this->analyse([__DIR__ . '/data/bug-7675.php'], []);
297307
}
298308

299309
public function testBug8034(): void
300310
{
301311
$this->phpVersion = PHP_VERSION_ID;
312+
$this->checkNonStringableDynamicAccess = true;
302313
$this->analyse([__DIR__ . '/data/bug-8034.php'], [
303314
[
304315
'Access to undefined constant static(Bug8034\HelloWorld)::FIELDS.',
@@ -310,6 +321,7 @@ public function testBug8034(): void
310321
public function testClassConstFetchDefined(): void
311322
{
312323
$this->phpVersion = PHP_VERSION_ID;
324+
$this->checkNonStringableDynamicAccess = true;
313325
$this->analyse([__DIR__ . '/data/class-const-fetch-defined.php'], [
314326
[
315327
'Access to undefined constant ClassConstFetchDefined\Foo::TEST.',
@@ -411,6 +423,7 @@ public function testPhpstanInternalClass(): void
411423
$tip = 'This is most likely unintentional. Did you mean to type \AClass?';
412424

413425
$this->phpVersion = PHP_VERSION_ID;
426+
$this->checkNonStringableDynamicAccess = true;
414427
$this->analyse([__DIR__ . '/data/phpstan-internal-class.php'], [
415428
[
416429
'Referencing prefixed PHPStan class: _PHPStan_156ee64ba\AClass.',
@@ -427,6 +440,7 @@ public function testClassConstantAccessedOnTrait(): void
427440
}
428441

429442
$this->phpVersion = PHP_VERSION_ID;
443+
$this->checkNonStringableDynamicAccess = true;
430444
$this->analyse([__DIR__ . '/data/class-constant-accessed-on-trait.php'], [
431445
[
432446
'Cannot access constant TEST on trait ClassConstantAccessedOnTrait\Foo.',
@@ -442,8 +456,17 @@ public function testDynamicAccess(): void
442456
}
443457

444458
$this->phpVersion = PHP_VERSION_ID;
459+
$this->checkNonStringableDynamicAccess = true;
445460

446461
$this->analyse([__DIR__ . '/data/dynamic-constant-access.php'], [
462+
[
463+
'Access to undefined constant ClassConstantDynamicAccess\Foo::FOO.',
464+
17,
465+
],
466+
[
467+
'Cannot fetch class constant with a non-stringable type object.',
468+
19,
469+
],
447470
[
448471
'Access to undefined constant ClassConstantDynamicAccess\Foo::FOO.',
449472
20,
@@ -479,4 +502,40 @@ public function testDynamicAccess(): void
479502
]);
480503
}
481504

505+
public function testStringableDynamicAccess(): void
506+
{
507+
if (PHP_VERSION_ID < 80300) {
508+
$this->markTestSkipped('Test requires PHP 8.3.');
509+
}
510+
511+
$this->phpVersion = PHP_VERSION_ID;
512+
$this->checkNonStringableDynamicAccess = true;
513+
514+
$this->analyse([__DIR__ . '/data/dynamic-constant-stringable-access.php'], [
515+
[
516+
'Cannot fetch class constant with a non-stringable type mixed.',
517+
13,
518+
],
519+
[
520+
'Cannot fetch class constant with a non-stringable type string|null.',
521+
14,
522+
],
523+
[
524+
'Cannot fetch class constant with a non-stringable type Stringable|null.',
525+
15,
526+
],
527+
[
528+
'Cannot fetch class constant with a non-stringable type int.',
529+
16,
530+
],
531+
[
532+
'Cannot fetch class constant with a non-stringable type int|null.',
533+
17,
534+
],
535+
[
536+
'Cannot fetch class constant with a non-stringable type DateTime|string.',
537+
16,
538+
],
539+
]);
540+
}
482541
}

‎tests/PHPStan/Rules/Classes/data/dynamic-constant-access.php‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public function test(string $string, object $obj): void
1414
{
1515
$bar = 'FOO';
1616

17-
echo self::{$foo};
17+
echo self::{$bar};
1818
echo self::{$string};
1919
echo self::{$obj};
2020
echo self::{$this->name};
@@ -44,5 +44,4 @@ public function testScope(): void
4444
echo self::{$name};
4545
}
4646

47-
4847
}

‎tests/PHPStan/Rules/Classes/data/dynamic-constant-stringable-access.php‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<?php // lint >= 8.3
2+
3+
namespace ClassConstantDynamicStringableAccess;
4+
5+
use Stringable;
6+
use DateTime;
7+
8+
final class Foo
9+
{
10+
11+
public function test(mixed $mixed, ?string $nullableStr, ?Stringable $nullableStringable, int $int, ?int $nullableInt, DateTime|string $datetimeOrStr): void
12+
{
13+
echo self::{$mixed};
14+
echo self::{$nullableStr};
15+
echo self::{$nullableStringable};
16+
echo self::{$int};
17+
echo self::{$nullableInt};
18+
echo self::{$datetimeOrStr};
19+
}
20+
21+
}

0 commit comments

Comments
 (0)