|
| 1 | +<?php |
| 2 | + |
| 3 | +declare (strict_types=1); |
| 4 | +namespace Rector\DowngradePhp82\Rector\Class_; |
| 5 | + |
| 6 | +use PhpParser\Node; |
| 7 | +use PhpParser\Node\Expr\ArrowFunction; |
| 8 | +use PhpParser\Node\Expr\Closure; |
| 9 | +use PhpParser\Node\IntersectionType; |
| 10 | +use PhpParser\Node\Stmt\ClassLike; |
| 11 | +use PhpParser\Node\Stmt\ClassMethod; |
| 12 | +use PhpParser\Node\Stmt\Function_; |
| 13 | +use PhpParser\Node\UnionType; |
| 14 | +use Rector\NodeManipulator\PropertyDecorator; |
| 15 | +use Rector\PhpDocDecorator\PhpDocFromTypeDeclarationDecorator; |
| 16 | +use Rector\Rector\AbstractRector; |
| 17 | +use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample; |
| 18 | +use Symplify\RuleDocGenerator\ValueObject\RuleDefinition; |
| 19 | +use RectorPrefix202602\Webmozart\Assert\Assert; |
| 20 | +/** |
| 21 | + * @changelog https://php.watch/versions/8.2/dnf-types |
| 22 | + * |
| 23 | + * @see \Rector\Tests\DowngradePhp82\Rector\Class_\DowngradeUnionIntersectionRector\DowngradeUnionIntersectionRectorTest |
| 24 | + */ |
| 25 | +final class DowngradeUnionIntersectionRector extends AbstractRector |
| 26 | +{ |
| 27 | + /** |
| 28 | + * @readonly |
| 29 | + */ |
| 30 | + private PropertyDecorator $propertyDecorator; |
| 31 | + /** |
| 32 | + * @readonly |
| 33 | + */ |
| 34 | + private PhpDocFromTypeDeclarationDecorator $phpDocFromTypeDeclarationDecorator; |
| 35 | + public function __construct(PropertyDecorator $propertyDecorator, PhpDocFromTypeDeclarationDecorator $phpDocFromTypeDeclarationDecorator) |
| 36 | + { |
| 37 | + $this->propertyDecorator = $propertyDecorator; |
| 38 | + $this->phpDocFromTypeDeclarationDecorator = $phpDocFromTypeDeclarationDecorator; |
| 39 | + } |
| 40 | + public function getRuleDefinition(): RuleDefinition |
| 41 | + { |
| 42 | + return new RuleDefinition('Remove the union type with intersection, use docblock based', [new CodeSample(<<<'CODE_SAMPLE' |
| 43 | +final class SomeClass |
| 44 | +{ |
| 45 | + public (A&B)|C $foo; |
| 46 | +} |
| 47 | +CODE_SAMPLE |
| 48 | +, <<<'CODE_SAMPLE' |
| 49 | +final class SomeClass |
| 50 | +{ |
| 51 | + /** |
| 52 | + * @var (A&B)|C |
| 53 | + */ |
| 54 | + public $foo; |
| 55 | +} |
| 56 | +CODE_SAMPLE |
| 57 | +)]); |
| 58 | + } |
| 59 | + /** |
| 60 | + * @return array<class-string<Node>> |
| 61 | + */ |
| 62 | + public function getNodeTypes(): array |
| 63 | + { |
| 64 | + return [ClassLike::class, ClassMethod::class, Function_::class, Closure::class, ArrowFunction::class]; |
| 65 | + } |
| 66 | + /** |
| 67 | + * @param ClassLike|ClassMethod|Function_|Closure|ArrowFunction $node |
| 68 | + */ |
| 69 | + public function refactor(Node $node): ?Node |
| 70 | + { |
| 71 | + if (!$node instanceof ClassLike) { |
| 72 | + return $this->processFunctionLike($node); |
| 73 | + } |
| 74 | + return $this->processClassLike($node); |
| 75 | + } |
| 76 | + /** |
| 77 | + * @param \PhpParser\Node\Stmt\ClassMethod|\PhpParser\Node\Stmt\Function_|\PhpParser\Node\Expr\Closure|\PhpParser\Node\Expr\ArrowFunction $functionLike |
| 78 | + * @return null|\PhpParser\Node\Stmt\ClassMethod|\PhpParser\Node\Stmt\Function_|\PhpParser\Node\Expr\Closure|\PhpParser\Node\Expr\ArrowFunction |
| 79 | + */ |
| 80 | + private function processFunctionLike($functionLike) |
| 81 | + { |
| 82 | + $paramDecorated = \false; |
| 83 | + foreach ($functionLike->getParams() as $param) { |
| 84 | + if (!$this->isUnionIntersection($param->type)) { |
| 85 | + continue; |
| 86 | + } |
| 87 | + Assert::isInstanceOf($param->type, UnionType::class); |
| 88 | + $this->phpDocFromTypeDeclarationDecorator->decorateParam($param, $functionLike, [\PHPStan\Type\UnionType::class]); |
| 89 | + $paramDecorated = \true; |
| 90 | + } |
| 91 | + if (!$this->isUnionIntersection($functionLike->returnType)) { |
| 92 | + if ($paramDecorated) { |
| 93 | + return $functionLike; |
| 94 | + } |
| 95 | + return null; |
| 96 | + } |
| 97 | + Assert::isInstanceOf($functionLike->returnType, UnionType::class); |
| 98 | + $this->phpDocFromTypeDeclarationDecorator->decorateReturn($functionLike); |
| 99 | + return $functionLike; |
| 100 | + } |
| 101 | + private function processClassLike(ClassLike $classLike): ?ClassLike |
| 102 | + { |
| 103 | + $hasChanged = \false; |
| 104 | + foreach ($classLike->getProperties() as $property) { |
| 105 | + if (!$this->isUnionIntersection($property->type)) { |
| 106 | + continue; |
| 107 | + } |
| 108 | + Assert::isInstanceOf($property->type, UnionType::class); |
| 109 | + $this->propertyDecorator->decorateWithDocBlock($property, $property->type); |
| 110 | + $property->type = null; |
| 111 | + $hasChanged = \true; |
| 112 | + } |
| 113 | + return $hasChanged ? $classLike : null; |
| 114 | + } |
| 115 | + private function isUnionIntersection(?Node $node): bool |
| 116 | + { |
| 117 | + if (!$node instanceof UnionType) { |
| 118 | + return \false; |
| 119 | + } |
| 120 | + foreach ($node->types as $type) { |
| 121 | + if ($type instanceof IntersectionType) { |
| 122 | + return \true; |
| 123 | + } |
| 124 | + } |
| 125 | + return \false; |
| 126 | + } |
| 127 | +} |
0 commit comments