Skip to content

Commit 5eacc66

Browse files
ondrejmirtesondrejmirtes
committed
[BCB] From *WithPhpDocs to Extended* 
1 parent cb6ab55 commit 5eacc66

File tree

55 files changed

+231
-230
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+231
-230
lines changed

Diff for: ‎UPGRADING.md

+1
Original file line numberDiff line numberDiff line change
@@ -298,3 +298,4 @@ Instead of `PHPStanTestCase::createBroker()`, call `PHPStanTestCase::createRefle
298298
* Interface `ConstantReflection` renamed to `ClassConstantReflection`
299299
* Added more methods around PHPDoc types and native types to the (new) `ClassConstantReflection`
300300
* Interface `GlobalConstantReflection` renamed to `ConstantReflection`
301+
* Renamed interfaces and classes from `*WithPhpDocs` to `Extended*`

Diff for: ‎build/PHPStan/Build/FinalClassRule.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
use PHPStan\File\FileHelper;
88
use PHPStan\Node\InClassNode;
99
use PHPStan\Reflection\FunctionVariant;
10-
use PHPStan\Reflection\FunctionVariantWithPhpDocs;
10+
use PHPStan\Reflection\ExtendedFunctionVariant;
1111
use PHPStan\Reflection\Php\DummyParameter;
1212
use PHPStan\Reflection\Php\PhpFunctionFromParserNodeReflection;
1313
use PHPStan\Rules\Rule;
@@ -51,7 +51,7 @@ public function processNode(Node $node, Scope $scope): array
5151
// exceptions
5252
if (in_array($classReflection->getName(), [
5353
FunctionVariant::class,
54-
FunctionVariantWithPhpDocs::class,
54+
ExtendedFunctionVariant::class,
5555
DummyParameter::class,
5656
PhpFunctionFromParserNodeReflection::class,
5757
], true)) {

Diff for: ‎src/Analyser/MutatingScope.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@
5757
use PHPStan\Reflection\ClassReflection;
5858
use PHPStan\Reflection\Dummy\DummyConstructorReflection;
5959
use PHPStan\Reflection\ExtendedMethodReflection;
60+
use PHPStan\Reflection\ExtendedParametersAcceptor;
6061
use PHPStan\Reflection\ExtendedPropertyReflection;
6162
use PHPStan\Reflection\FunctionReflection;
6263
use PHPStan\Reflection\InitializerExprContext;
@@ -66,7 +67,6 @@
6667
use PHPStan\Reflection\ParameterReflection;
6768
use PHPStan\Reflection\ParametersAcceptor;
6869
use PHPStan\Reflection\ParametersAcceptorSelector;
69-
use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
7070
use PHPStan\Reflection\PassedByReference;
7171
use PHPStan\Reflection\Php\DummyParameter;
7272
use PHPStan\Reflection\Php\PhpFunctionFromParserNodeReflection;
@@ -2503,7 +2503,7 @@ private function createFirstClassCallable(
25032503

25042504
foreach ($variants as $variant) {
25052505
$returnType = $variant->getReturnType();
2506-
if ($variant instanceof ParametersAcceptorWithPhpDocs) {
2506+
if ($variant instanceof ExtendedParametersAcceptor) {
25072507
$returnType = $this->nativeTypesPromoted ? $variant->getNativeReturnType() : $returnType;
25082508
}
25092509

@@ -2560,7 +2560,7 @@ private function createFirstClassCallable(
25602560
$variant->isVariadic(),
25612561
$variant->getTemplateTypeMap(),
25622562
$variant->getResolvedTemplateTypeMap(),
2563-
$variant instanceof ParametersAcceptorWithPhpDocs ? $variant->getCallSiteVarianceMap() : TemplateTypeVarianceMap::createEmpty(),
2563+
$variant instanceof ExtendedParametersAcceptor ? $variant->getCallSiteVarianceMap() : TemplateTypeVarianceMap::createEmpty(),
25642564
$templateTags,
25652565
$throwPoints,
25662566
$impurePoints,

Diff for: ‎src/Analyser/NodeScopeResolver.php

+9-9
Original file line numberDiff line numberDiff line change
@@ -130,16 +130,16 @@
130130
use PHPStan\Reflection\Callables\SimpleThrowPoint;
131131
use PHPStan\Reflection\ClassReflection;
132132
use PHPStan\Reflection\ExtendedMethodReflection;
133+
use PHPStan\Reflection\ExtendedParameterReflection;
134+
use PHPStan\Reflection\ExtendedParametersAcceptor;
133135
use PHPStan\Reflection\FunctionReflection;
134136
use PHPStan\Reflection\InitializerExprTypeResolver;
135137
use PHPStan\Reflection\MethodReflection;
136138
use PHPStan\Reflection\Native\NativeMethodReflection;
137139
use PHPStan\Reflection\Native\NativeParameterReflection;
138140
use PHPStan\Reflection\ParameterReflection;
139-
use PHPStan\Reflection\ParameterReflectionWithPhpDocs;
140141
use PHPStan\Reflection\ParametersAcceptor;
141142
use PHPStan\Reflection\ParametersAcceptorSelector;
142-
use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
143143
use PHPStan\Reflection\Php\PhpFunctionFromParserNodeReflection;
144144
use PHPStan\Reflection\Php\PhpMethodFromParserNodeReflection;
145145
use PHPStan\Reflection\Php\PhpMethodReflection;
@@ -2649,7 +2649,7 @@ static function (): void {
26492649
TemplateTypeHelper::resolveTemplateTypes(
26502650
$selfOutType,
26512651
$parametersAcceptor->getResolvedTemplateTypeMap(),
2652-
$parametersAcceptor instanceof ParametersAcceptorWithPhpDocs ? $parametersAcceptor->getCallSiteVarianceMap() : TemplateTypeVarianceMap::createEmpty(),
2652+
$parametersAcceptor instanceof ExtendedParametersAcceptor ? $parametersAcceptor->getCallSiteVarianceMap() : TemplateTypeVarianceMap::createEmpty(),
26532653
TemplateTypeVariance::createCovariant(),
26542654
),
26552655
$scope->getNativeType($expr->var),
@@ -4545,7 +4545,7 @@ private function processArgs(
45454545
$assignByReference = $parameters[$i]->passedByReference()->createsNewVariable();
45464546
$parameterType = $parameters[$i]->getType();
45474547

4548-
if ($parameters[$i] instanceof ParameterReflectionWithPhpDocs) {
4548+
if ($parameters[$i] instanceof ExtendedParameterReflection) {
45494549
$parameterNativeType = $parameters[$i]->getNativeType();
45504550
}
45514551
$parameter = $parameters[$i];
@@ -4554,7 +4554,7 @@ private function processArgs(
45544554
$assignByReference = $lastParameter->passedByReference()->createsNewVariable();
45554555
$parameterType = $lastParameter->getType();
45564556

4557-
if ($lastParameter instanceof ParameterReflectionWithPhpDocs) {
4557+
if ($lastParameter instanceof ExtendedParameterReflection) {
45584558
$parameterNativeType = $lastParameter->getNativeType();
45594559
}
45604560
$parameter = $lastParameter;
@@ -4591,7 +4591,7 @@ private function processArgs(
45914591
$scopeToPass = $closureBindScope;
45924592
}
45934593

4594-
if ($parameter instanceof ParameterReflectionWithPhpDocs) {
4594+
if ($parameter instanceof ExtendedParameterReflection) {
45954595
$parameterCallImmediately = $parameter->isImmediatelyInvokedCallable();
45964596
if ($parameterCallImmediately->maybe()) {
45974597
$callCallbackImmediately = $calleeReflection instanceof FunctionReflection;
@@ -4605,7 +4605,7 @@ private function processArgs(
46054605
$restoreThisScope = null;
46064606
if (
46074607
$closureBindScope === null
4608-
&& $parameter instanceof ParameterReflectionWithPhpDocs
4608+
&& $parameter instanceof ExtendedParameterReflection
46094609
&& $parameter->getClosureThisType() !== null
46104610
&& !$arg->value->static
46114611
) {
@@ -4658,7 +4658,7 @@ private function processArgs(
46584658
} elseif ($arg->value instanceof Expr\ArrowFunction) {
46594659
if (
46604660
$closureBindScope === null
4661-
&& $parameter instanceof ParameterReflectionWithPhpDocs
4661+
&& $parameter instanceof ExtendedParameterReflection
46624662
&& $parameter->getClosureThisType() !== null
46634663
&& !$arg->value->static
46644664
) {
@@ -4734,7 +4734,7 @@ private function processArgs(
47344734
if ($currentParameter !== null) {
47354735
$assignByReference = $currentParameter->passedByReference()->createsNewVariable();
47364736
if ($assignByReference) {
4737-
if ($currentParameter instanceof ParameterReflectionWithPhpDocs && $currentParameter->getOutType() !== null) {
4737+
if ($currentParameter instanceof ExtendedParameterReflection && $currentParameter->getOutType() !== null) {
47384738
$byRefType = $currentParameter->getOutType();
47394739
} elseif (
47404740
$calleeReflection instanceof MethodReflection

Diff for: ‎src/Analyser/TypeSpecifier.php

+5-5
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@
2424
use PHPStan\Node\Printer\ExprPrinter;
2525
use PHPStan\Php\PhpVersion;
2626
use PHPStan\Reflection\Assertions;
27+
use PHPStan\Reflection\ExtendedParametersAcceptor;
2728
use PHPStan\Reflection\ParametersAcceptor;
2829
use PHPStan\Reflection\ParametersAcceptorSelector;
29-
use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
3030
use PHPStan\Reflection\ReflectionProvider;
3131
use PHPStan\Reflection\ResolvedFunctionVariant;
3232
use PHPStan\Rules\Arrays\AllowedArrayKeysTypes;
@@ -485,7 +485,7 @@ public function specifyTypesInCondition(
485485
$asserts = $assertions->mapTypes(static fn (Type $type) => TemplateTypeHelper::resolveTemplateTypes(
486486
$type,
487487
$parametersAcceptor->getResolvedTemplateTypeMap(),
488-
$parametersAcceptor instanceof ParametersAcceptorWithPhpDocs ? $parametersAcceptor->getCallSiteVarianceMap() : TemplateTypeVarianceMap::createEmpty(),
488+
$parametersAcceptor instanceof ExtendedParametersAcceptor ? $parametersAcceptor->getCallSiteVarianceMap() : TemplateTypeVarianceMap::createEmpty(),
489489
TemplateTypeVariance::createInvariant(),
490490
));
491491
$specifiedTypes = $this->specifyTypesFromAsserts($context, $expr, $asserts, $parametersAcceptor, $scope);
@@ -533,7 +533,7 @@ public function specifyTypesInCondition(
533533
$asserts = $assertions->mapTypes(static fn (Type $type) => TemplateTypeHelper::resolveTemplateTypes(
534534
$type,
535535
$parametersAcceptor->getResolvedTemplateTypeMap(),
536-
$parametersAcceptor instanceof ParametersAcceptorWithPhpDocs ? $parametersAcceptor->getCallSiteVarianceMap() : TemplateTypeVarianceMap::createEmpty(),
536+
$parametersAcceptor instanceof ExtendedParametersAcceptor ? $parametersAcceptor->getCallSiteVarianceMap() : TemplateTypeVarianceMap::createEmpty(),
537537
TemplateTypeVariance::createInvariant(),
538538
));
539539
$specifiedTypes = $this->specifyTypesFromAsserts($context, $expr, $asserts, $parametersAcceptor, $scope);
@@ -586,7 +586,7 @@ public function specifyTypesInCondition(
586586
$asserts = $assertions->mapTypes(static fn (Type $type) => TemplateTypeHelper::resolveTemplateTypes(
587587
$type,
588588
$parametersAcceptor->getResolvedTemplateTypeMap(),
589-
$parametersAcceptor instanceof ParametersAcceptorWithPhpDocs ? $parametersAcceptor->getCallSiteVarianceMap() : TemplateTypeVarianceMap::createEmpty(),
589+
$parametersAcceptor instanceof ExtendedParametersAcceptor ? $parametersAcceptor->getCallSiteVarianceMap() : TemplateTypeVarianceMap::createEmpty(),
590590
TemplateTypeVariance::createInvariant(),
591591
));
592592
$specifiedTypes = $this->specifyTypesFromAsserts($context, $expr, $asserts, $parametersAcceptor, $scope);
@@ -935,7 +935,7 @@ public function specifyTypesInCondition(
935935
$asserts = $asserts->mapTypes(static fn (Type $type) => TemplateTypeHelper::resolveTemplateTypes(
936936
$type,
937937
$parametersAcceptor->getResolvedTemplateTypeMap(),
938-
$parametersAcceptor instanceof ParametersAcceptorWithPhpDocs ? $parametersAcceptor->getCallSiteVarianceMap() : TemplateTypeVarianceMap::createEmpty(),
938+
$parametersAcceptor instanceof ExtendedParametersAcceptor ? $parametersAcceptor->getCallSiteVarianceMap() : TemplateTypeVarianceMap::createEmpty(),
939939
TemplateTypeVariance::createInvariant(),
940940
));
941941

Diff for: ‎src/Dependency/DependencyResolver.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
use PHPStan\Node\InClassMethodNode;
1717
use PHPStan\Node\InFunctionNode;
1818
use PHPStan\Reflection\ClassReflection;
19+
use PHPStan\Reflection\ExtendedParameterReflection;
20+
use PHPStan\Reflection\ExtendedParametersAcceptor;
1921
use PHPStan\Reflection\FunctionReflection;
20-
use PHPStan\Reflection\ParameterReflectionWithPhpDocs;
21-
use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
2222
use PHPStan\Reflection\ReflectionProvider;
2323
use PHPStan\Type\ClosureType;
2424
use PHPStan\Type\FileTypeMapper;
@@ -171,7 +171,7 @@ public function resolveDependencies(Node $node, Scope $scope): NodeDependencies
171171
}
172172

173173
foreach ($variant->getParameters() as $parameter) {
174-
if (!$parameter instanceof ParameterReflectionWithPhpDocs) {
174+
if (!$parameter instanceof ExtendedParameterReflection) {
175175
continue;
176176
}
177177
if ($parameter->getOutType() !== null) {
@@ -615,7 +615,7 @@ private function getFunctionReflection(Node\Name $nameNode, ?Scope $scope): Func
615615
* @param array<ClassReflection|FunctionReflection> $dependenciesReflections
616616
*/
617617
private function extractFromParametersAcceptor(
618-
ParametersAcceptorWithPhpDocs $parametersAcceptor,
618+
ExtendedParametersAcceptor $parametersAcceptor,
619619
array &$dependenciesReflections,
620620
): void
621621
{

Diff for: ‎src/Reflection/Annotations/AnnotationMethodReflection.php

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
use PHPStan\Reflection\Assertions;
66
use PHPStan\Reflection\ClassMemberReflection;
77
use PHPStan\Reflection\ClassReflection;
8+
use PHPStan\Reflection\ExtendedFunctionVariant;
89
use PHPStan\Reflection\ExtendedMethodReflection;
9-
use PHPStan\Reflection\FunctionVariantWithPhpDocs;
10-
use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
10+
use PHPStan\Reflection\ExtendedParametersAcceptor;
1111
use PHPStan\TrinaryLogic;
1212
use PHPStan\Type\Generic\TemplateTypeMap;
1313
use PHPStan\Type\MixedType;
@@ -17,7 +17,7 @@
1717
final class AnnotationMethodReflection implements ExtendedMethodReflection
1818
{
1919

20-
/** @var FunctionVariantWithPhpDocs[]|null */
20+
/** @var ExtendedFunctionVariant[]|null */
2121
private ?array $variants = null;
2222

2323
/**
@@ -70,7 +70,7 @@ public function getVariants(): array
7070
{
7171
if ($this->variants === null) {
7272
$this->variants = [
73-
new FunctionVariantWithPhpDocs(
73+
new ExtendedFunctionVariant(
7474
$this->templateTypeMap,
7575
null,
7676
$this->parameters,
@@ -84,7 +84,7 @@ public function getVariants(): array
8484
return $this->variants;
8585
}
8686

87-
public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
87+
public function getOnlyVariant(): ExtendedParametersAcceptor
8888
{
8989
return $this->getVariants()[0];
9090
}

Diff for: ‎src/Reflection/Annotations/AnnotationsMethodParameterReflection.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
namespace PHPStan\Reflection\Annotations;
44

5-
use PHPStan\Reflection\ParameterReflectionWithPhpDocs;
5+
use PHPStan\Reflection\ExtendedParameterReflection;
66
use PHPStan\Reflection\PassedByReference;
77
use PHPStan\TrinaryLogic;
88
use PHPStan\Type\MixedType;
99
use PHPStan\Type\Type;
1010

11-
final class AnnotationsMethodParameterReflection implements ParameterReflectionWithPhpDocs
11+
final class AnnotationsMethodParameterReflection implements ExtendedParameterReflection
1212
{
1313

1414
public function __construct(private string $name, private Type $type, private PassedByReference $passedByReference, private bool $isOptional, private bool $isVariadic, private ?Type $defaultValue)

Diff for: ‎src/Reflection/Callables/FunctionCallableVariant.php

+7-7
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
namespace PHPStan\Reflection\Callables;
44

55
use PHPStan\Reflection\ExtendedMethodReflection;
6+
use PHPStan\Reflection\ExtendedParameterReflection;
7+
use PHPStan\Reflection\ExtendedParametersAcceptor;
68
use PHPStan\Reflection\FunctionReflection;
7-
use PHPStan\Reflection\ParameterReflectionWithPhpDocs;
8-
use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
99
use PHPStan\TrinaryLogic;
1010
use PHPStan\Type\Generic\TemplateTypeMap;
1111
use PHPStan\Type\Generic\TemplateTypeVarianceMap;
@@ -16,7 +16,7 @@
1616
use function array_map;
1717
use function count;
1818

19-
final class FunctionCallableVariant implements CallableParametersAcceptor, ParametersAcceptorWithPhpDocs
19+
final class FunctionCallableVariant implements CallableParametersAcceptor, ExtendedParametersAcceptor
2020
{
2121

2222
/** @var SimpleThrowPoint[]|null */
@@ -27,18 +27,18 @@ final class FunctionCallableVariant implements CallableParametersAcceptor, Param
2727

2828
public function __construct(
2929
private FunctionReflection|ExtendedMethodReflection $function,
30-
private ParametersAcceptorWithPhpDocs $variant,
30+
private ExtendedParametersAcceptor $variant,
3131
)
3232
{
3333
}
3434

3535
/**
36-
* @param ParametersAcceptorWithPhpDocs[] $variants
36+
* @param ExtendedParametersAcceptor[] $variants
3737
* @return self[]
3838
*/
3939
public static function createFromVariants(FunctionReflection|ExtendedMethodReflection $function, array $variants): array
4040
{
41-
return array_map(static fn (ParametersAcceptorWithPhpDocs $variant) => new self($function, $variant), $variants);
41+
return array_map(static fn (ExtendedParametersAcceptor $variant) => new self($function, $variant), $variants);
4242
}
4343

4444
public function getTemplateTypeMap(): TemplateTypeMap
@@ -52,7 +52,7 @@ public function getResolvedTemplateTypeMap(): TemplateTypeMap
5252
}
5353

5454
/**
55-
* @return array<int, ParameterReflectionWithPhpDocs>
55+
* @return array<int, ExtendedParameterReflection>
5656
*/
5757
public function getParameters(): array
5858
{

Diff for: ‎src/Reflection/Dummy/ChangedTypeMethodReflection.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
use PHPStan\Reflection\ClassMemberReflection;
77
use PHPStan\Reflection\ClassReflection;
88
use PHPStan\Reflection\ExtendedMethodReflection;
9-
use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
9+
use PHPStan\Reflection\ExtendedParametersAcceptor;
1010
use PHPStan\ShouldNotHappenException;
1111
use PHPStan\TrinaryLogic;
1212
use PHPStan\Type\Type;
@@ -17,8 +17,8 @@ final class ChangedTypeMethodReflection implements ExtendedMethodReflection
1717
{
1818

1919
/**
20-
* @param ParametersAcceptorWithPhpDocs[] $variants
21-
* @param ParametersAcceptorWithPhpDocs[]|null $namedArgumentsVariants
20+
* @param ExtendedParametersAcceptor[] $variants
21+
* @param ExtendedParametersAcceptor[]|null $namedArgumentsVariants
2222
*/
2323
public function __construct(private ClassReflection $declaringClass, private ExtendedMethodReflection $reflection, private array $variants, private ?array $namedArgumentsVariants)
2424
{
@@ -64,7 +64,7 @@ public function getVariants(): array
6464
return $this->variants;
6565
}
6666

67-
public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
67+
public function getOnlyVariant(): ExtendedParametersAcceptor
6868
{
6969
$variants = $this->getVariants();
7070
if (count($variants) !== 1) {

Diff for: ‎src/Reflection/Dummy/DummyConstructorReflection.php

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
use PHPStan\Reflection\Assertions;
66
use PHPStan\Reflection\ClassMemberReflection;
77
use PHPStan\Reflection\ClassReflection;
8+
use PHPStan\Reflection\ExtendedFunctionVariant;
89
use PHPStan\Reflection\ExtendedMethodReflection;
9-
use PHPStan\Reflection\FunctionVariantWithPhpDocs;
10-
use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
10+
use PHPStan\Reflection\ExtendedParametersAcceptor;
1111
use PHPStan\TrinaryLogic;
1212
use PHPStan\Type\Generic\TemplateTypeMap;
1313
use PHPStan\Type\MixedType;
@@ -54,7 +54,7 @@ public function getPrototype(): ClassMemberReflection
5454
public function getVariants(): array
5555
{
5656
return [
57-
new FunctionVariantWithPhpDocs(
57+
new ExtendedFunctionVariant(
5858
TemplateTypeMap::createEmpty(),
5959
null,
6060
[],
@@ -67,7 +67,7 @@ public function getVariants(): array
6767
];
6868
}
6969

70-
public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
70+
public function getOnlyVariant(): ExtendedParametersAcceptor
7171
{
7272
return $this->getVariants()[0];
7373
}

Diff for: ‎src/Reflection/Dummy/DummyMethodReflection.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
use PHPStan\Reflection\ClassMemberReflection;
77
use PHPStan\Reflection\ClassReflection;
88
use PHPStan\Reflection\ExtendedMethodReflection;
9-
use PHPStan\Reflection\ParametersAcceptorWithPhpDocs;
9+
use PHPStan\Reflection\ExtendedParametersAcceptor;
1010
use PHPStan\Reflection\ReflectionProviderStaticAccessor;
1111
use PHPStan\Reflection\TrivialParametersAcceptor;
1212
use PHPStan\TrinaryLogic;
@@ -59,7 +59,7 @@ public function getVariants(): array
5959
];
6060
}
6161

62-
public function getOnlyVariant(): ParametersAcceptorWithPhpDocs
62+
public function getOnlyVariant(): ExtendedParametersAcceptor
6363
{
6464
return $this->getVariants()[0];
6565
}

0 commit comments

Comments
 (0)