[deprecation] deprecate file, use getFile() instead

TomasVotruba · TomasVotruba · commit 10e6e0e91c58 · 2026-04-07T21:06:42.000+02:00
diff --git a/phpstan.neon b/phpstan.neon
@@ -478,4 +478,9 @@ parameters:
             message: '#Unable to resolve the template type T in call to static method Webmozart\\Assert\\Assert\:\:isInstanceOfAny\(\)#'
             path: rules/DeadCode/Rector/FunctionLike/NarrowWideUnionReturnTypeRector.php
 
-        - '#Provide more specific return type "Iterator|PhpParser\\Node" over abstract one#'
+        - '#Provide more specific return type "Iterator|PhpParser\\Node" over abstract one#'
+
+        # BC layer
+        -
+            message: '#Access to deprecated property \$file of class Rector\\Rector\\AbstractRector#'
+            path: src/Rector/AbstractRector.php
diff --git a/rules/CodeQuality/Rector/Coalesce/CoalesceToTernaryRector.php b/rules/CodeQuality/Rector/Coalesce/CoalesceToTernaryRector.php
@@ -4,18 +4,18 @@
 
 namespace Rector\CodeQuality\Rector\Coalesce;
 
-use PHPStan\Type\UnionType;
-use PHPStan\Type\NullType;
 use PhpParser\Node;
 use PhpParser\Node\Expr\ArrayDimFetch;
 use PhpParser\Node\Expr\BinaryOp\Coalesce;
 use PhpParser\Node\Expr\Ternary;
 use PHPStan\Type\ErrorType;
 use PHPStan\Type\MixedType;
+use PHPStan\Type\NullType;
+use PHPStan\Type\UnionType;
+use Rector\PHPStan\ScopeFetcher;
 use Rector\Rector\AbstractRector;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
-use Rector\PHPStan\ScopeFetcher;
 
 /**
  * @see \Rector\Tests\CodeQuality\Rector\Coalesce\CoalesceToTernaryRector\CoalesceToTernaryRectorTest
diff --git a/rules/CodeQuality/Rector/Empty_/SimplifyEmptyCheckOnEmptyArrayRector.php b/rules/CodeQuality/Rector/Empty_/SimplifyEmptyCheckOnEmptyArrayRector.php
@@ -152,7 +152,7 @@ private function isAllowedExpr(Expr $expr, Scope $scope): bool
             return false;
         }
 
-        $type = $this->allAssignNodePropertyTypeInferer->inferProperty($property, $classReflection, $this->file);
+        $type = $this->allAssignNodePropertyTypeInferer->inferProperty($property, $classReflection, $this->getFile());
         if (! $type instanceof Type) {
             return false;
         }
diff --git a/rules/CodeQuality/Rector/If_/CompleteMissingIfElseBracketRector.php b/rules/CodeQuality/Rector/If_/CompleteMissingIfElseBracketRector.php
@@ -69,7 +69,8 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        $oldTokens = $this->file->getOldTokens();
+        $oldTokens = $this->getFile()
+            ->getOldTokens();
         if ($this->isIfConditionFollowedByOpeningCurlyBracket($node, $oldTokens)) {
             return null;
         }
diff --git a/rules/CodeQuality/Rector/NotEqual/CommonNotEqualRector.php b/rules/CodeQuality/Rector/NotEqual/CommonNotEqualRector.php
@@ -62,7 +62,8 @@ public function refactor(Node $node): ?NotEqual
         $tokenEndPos = $node->getEndTokenPos();
 
         for ($i = $tokenStartPos; $i < $tokenEndPos; ++$i) {
-            $token = $this->file->getOldTokens()[$i];
+            $token = $this->getFile()
+                ->getOldTokens()[$i];
 
             if ((string) $token === '<>') {
                 $token->text = '!=';
diff --git a/rules/CodingStyle/Rector/Encapsed/WrapEncapsedVariableInCurlyBracesRector.php b/rules/CodingStyle/Rector/Encapsed/WrapEncapsedVariableInCurlyBracesRector.php
@@ -52,7 +52,8 @@ public function getNodeTypes(): array
     public function refactor(Node $node): ?Node
     {
         $hasVariableBeenWrapped = false;
-        $oldTokens = $this->file->getOldTokens();
+        $oldTokens = $this->getFile()
+            ->getOldTokens();
 
         foreach ($node->parts as $index => $nodePart) {
             if ($nodePart instanceof Variable && $nodePart->getStartTokenPos() >= 0) {
diff --git a/rules/DeadCode/Rector/Concat/RemoveConcatAutocastRector.php b/rules/DeadCode/Rector/Concat/RemoveConcatAutocastRector.php
@@ -79,7 +79,8 @@ private function removeStringCast(Expr $expr): Expr
         }
 
         $targetExpr = $expr->expr;
-        $tokens = $this->file->getOldTokens();
+        $tokens = $this->getFile()
+            ->getOldTokens();
 
         if ($expr->expr instanceof BinaryOp) {
             $castStartTokenPos = $expr->getStartTokenPos();
diff --git a/rules/DeadCode/Rector/Plus/RemoveDeadZeroAndOneOperationRector.php b/rules/DeadCode/Rector/Plus/RemoveDeadZeroAndOneOperationRector.php
@@ -214,7 +214,7 @@ private function processBinaryMulAndDiv(Mul | Div $binaryOp): ?Expr
         if ($binaryOp instanceof Mul && $this->isLiteralOne($binaryOp->left) && $this->nodeTypeResolver->isNumberType(
             $binaryOp->right
         )) {
-            if ($this->isMulParenthesized($this->file, $binaryOp)) {
+            if ($this->isMulParenthesized($this->getFile(), $binaryOp)) {
                 $binaryOp->right->setAttribute(AttributeKey::WRAPPED_IN_PARENTHESES, true);
             }
 
diff --git a/rules/Php53/Rector/Ternary/TernaryToElvisRector.php b/rules/Php53/Rector/Ternary/TernaryToElvisRector.php
@@ -77,7 +77,8 @@ public function provideMinPhpVersion(): int
 
     private function isParenthesized(Expr $ifExpr, Expr $elseExpr): bool
     {
-        $tokens = $this->file->getOldTokens();
+        $tokens = $this->getFile()
+            ->getOldTokens();
 
         $ifExprTokenEnd = $ifExpr->getEndTokenPos();
         $elseExprTokenStart = $elseExpr->getStartTokenPos();
diff --git a/rules/Php54/Rector/Array_/LongArrayToShortArrayRector.php b/rules/Php54/Rector/Array_/LongArrayToShortArrayRector.php
@@ -78,7 +78,8 @@ public function refactor(Node $node): ?Node
 
         $node->setAttribute(AttributeKey::KIND, Array_::KIND_SHORT);
 
-        $tokens = $this->file->getOldTokens();
+        $tokens = $this->getFile()
+            ->getOldTokens();
 
         $startTokenPos = $node->getStartTokenPos();
         $endTokenPos = $node->getEndTokenPos();
diff --git a/rules/Php70/Rector/Ternary/TernaryToNullCoalescingRector.php b/rules/Php70/Rector/Ternary/TernaryToNullCoalescingRector.php
@@ -115,7 +115,7 @@ private function processTernaryWithIsset(Ternary $ternary, Isset_ $isset): ?Coal
         }
 
         if (($ternary->else instanceof Ternary || $ternary->else instanceof BinaryOp) && $this->isTernaryParenthesized(
-            $this->file,
+            $this->getFile(),
             $ternary->cond,
             $ternary
         )) {
diff --git a/rules/Php74/Rector/ArrayDimFetch/CurlyToSquareBracketArrayStringRector.php b/rules/Php74/Rector/ArrayDimFetch/CurlyToSquareBracketArrayStringRector.php
@@ -63,7 +63,7 @@ public function getNodeTypes(): array
      */
     public function refactor(Node $node): ?Node
     {
-        if (! $this->isFollowedByCurlyBracket($this->file, $node)) {
+        if (! $this->isFollowedByCurlyBracket($this->getFile(), $node)) {
             return null;
         }
 
diff --git a/rules/Php74/Rector/Ternary/ParenthesizeNestedTernaryRector.php b/rules/Php74/Rector/Ternary/ParenthesizeNestedTernaryRector.php
@@ -68,7 +68,7 @@ public function refactor(Node $node): ?Node
                 return null;
             }
 
-            if ($this->parenthesizedNestedTernaryAnalyzer->isParenthesized($this->file, $node)) {
+            if ($this->parenthesizedNestedTernaryAnalyzer->isParenthesized($this->getFile(), $node)) {
                 return null;
             }
 
diff --git a/rules/Php82/Rector/Encapsed/VariableInStringInterpolationFixerRector.php b/rules/Php82/Rector/Encapsed/VariableInStringInterpolationFixerRector.php
@@ -51,7 +51,8 @@ public function getNodeTypes(): array
      */
     public function refactor(Node $node): ?Node
     {
-        $oldTokens = $this->file->getOldTokens();
+        $oldTokens = $this->getFile()
+            ->getOldTokens();
         $hasChanged = false;
 
         foreach ($node->parts as $part) {
diff --git a/rules/Php84/Rector/MethodCall/NewMethodCallWithoutParenthesesRector.php b/rules/Php84/Rector/MethodCall/NewMethodCallWithoutParenthesesRector.php
@@ -53,7 +53,8 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        $oldTokens = $this->file->getOldTokens();
+        $oldTokens = $this->getFile()
+            ->getOldTokens();
 
         $loop = 1;
         while (isset($oldTokens[$node->var->getStartTokenPos() + $loop])) {
diff --git a/rules/Php85/Rector/Switch_/ColonAfterSwitchCaseRector.php b/rules/Php85/Rector/Switch_/ColonAfterSwitchCaseRector.php
@@ -50,7 +50,8 @@ public function getNodeTypes(): array
     public function refactor(Node $node): ?Node
     {
         $hasChanged = false;
-        $oldTokens = $this->file->getOldTokens();
+        $oldTokens = $this->getFile()
+            ->getOldTokens();
 
         foreach ($node->cases as $key => $case) {
             $cond = $case->cond;
diff --git a/rules/TypeDeclaration/Rector/Property/TypedPropertyFromAssignsRector.php b/rules/TypeDeclaration/Rector/Property/TypedPropertyFromAssignsRector.php
@@ -157,7 +157,7 @@ public function refactor(Node $node): ?Node
             $inferredType = $this->allAssignNodePropertyTypeInferer->inferProperty(
                 $property,
                 $classReflection,
-                $this->file
+                $this->getFile()
             );
             if (! $inferredType instanceof Type) {
                 continue;
diff --git a/rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php b/rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php
@@ -63,7 +63,7 @@ function someFunction(int $number)
     public function refactor(Node $node): ?FileNode
     {
         // shebang files cannot have declare strict types
-        if ($this->file->hasShebang()) {
+        if ($this->getFile()->hasShebang()) {
             return null;
         }
 
diff --git a/src/Console/Command/WorkerCommand.php b/src/Console/Command/WorkerCommand.php
@@ -131,7 +131,12 @@ private function runWorker(
         $encoder->on(ReactEvent::ERROR, $handleErrorCallback);
 
         // 2. collect diffs + errors from file processor
-        $decoder->on(ReactEvent::DATA, function (array $json) use ($preFileCallback, $encoder, $configuration, $input): void {
+        $decoder->on(ReactEvent::DATA, function (array $json) use (
+            $preFileCallback,
+            $encoder,
+            $configuration,
+            $input
+        ): void {
             $action = $json[ReactCommand::ACTION];
             if ($action !== Action::MAIN) {
                 return;
@@ -154,7 +159,9 @@ private function runWorker(
             $encoder->write([
                 ReactCommand::ACTION => Action::RESULT,
                 self::RESULT => [
-                    Bridge::FILE_DIFFS => $processResult->getFileDiffs($input->getOption(Option::OUTPUT_FORMAT) !== 'json'),
+                    Bridge::FILE_DIFFS => $processResult->getFileDiffs(
+                        $input->getOption(Option::OUTPUT_FORMAT) !== 'json'
+                    ),
                     Bridge::FILES_COUNT => count($filePaths),
                     Bridge::SYSTEM_ERRORS => $processResult->getSystemErrors(),
                     Bridge::SYSTEM_ERRORS_COUNT => count($processResult->getSystemErrors()),
diff --git a/src/Rector/AbstractRector.php b/src/Rector/AbstractRector.php
@@ -57,6 +57,9 @@ abstract class AbstractRector extends NodeVisitorAbstract implements RectorInter
 
     protected NodeComparator $nodeComparator;
 
+    /**
+     * @deprecated Use getFile() instead.
+     */
     protected File $file;
 
     protected Skipper $skipper;
@@ -122,11 +125,12 @@ public function beforeTraverse(array $nodes): ?array
      */
     final public function enterNode(Node $node): int|Node|null|array
     {
-        if (is_a($this, HTMLAverseRectorInterface::class, true) && $this->file->containsHTML()) {
+        if (is_a($this, HTMLAverseRectorInterface::class, true) && $this->getFile()->containsHTML()) {
             return null;
         }
 
-        $filePath = $this->file->getFilePath();
+        $filePath = $this->getFile()
+            ->getFilePath();
         if ($this->skipper->shouldSkipCurrentNode($this, $filePath, static::class, $node)) {
             return null;
         }
@@ -159,7 +163,8 @@ final public function enterNode(Node $node): int|Node|null|array
 
             // notify this rule changed code
             $rectorWithLineChange = new RectorWithLineChange(static::class, $originalNode->getStartLine());
-            $this->file->addRectorClassWithLine($rectorWithLineChange);
+            $this->getFile()
+                ->addRectorClassWithLine($rectorWithLineChange);
 
             return $refactoredNodeOrState;
         }
@@ -175,6 +180,18 @@ final public function leaveNode(Node $node): array|int|Node|null
         return null;
     }
 
+    protected function getFile(): File
+    {
+        $file = $this->currentFileProvider->getFile();
+        if (! $file instanceof File) {
+            throw new ShouldNotHappenException(
+                'File object is missing. Make sure you call $this->currentFileProvider->setFile(...) before traversing.'
+            );
+        }
+
+        return $file;
+    }
+
     protected function isName(Node $node, string $name): bool
     {
         return $this->nodeNameResolver->isName($node, $name);
@@ -257,7 +274,8 @@ private function postRefactorProcess(
         $this->createdByRuleDecorator->decorate($refactoredNode, $originalNode, static::class);
 
         $rectorWithLineChange = new RectorWithLineChange(static::class, $originalNode->getStartLine());
-        $this->file->addRectorClassWithLine($rectorWithLineChange);
+        $this->getFile()
+            ->addRectorClassWithLine($rectorWithLineChange);
 
         /** @var MutatingScope|null $currentScope */
         $currentScope = $node->getAttribute(AttributeKey::SCOPE);

Original file line number	Diff line number	Diff line change
`@@ -152,7 +152,7 @@ private function isAllowedExpr(Expr $expr, Scope $scope): bool`
`152`	`152`	`return false;`
`153`	`153`	`}`
`154`	`154`
`155`		`- $type = $this->allAssignNodePropertyTypeInferer->inferProperty($property, $classReflection, $this->file);`
	`155`	`+ $type = $this->allAssignNodePropertyTypeInferer->inferProperty($property, $classReflection, $this->getFile());`
`156`	`156`	`if (! $type instanceof Type) {`
`157`	`157`	`return false;`
`158`	`158`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,8 @@ public function refactor(Node $node): ?Node`
`69`	`69`	`return null;`
`70`	`70`	`}`
`71`	`71`
`72`		`- $oldTokens = $this->file->getOldTokens();`
	`72`	`+ $oldTokens = $this->getFile()`
	`73`	`+ ->getOldTokens();`
`73`	`74`	`if ($this->isIfConditionFollowedByOpeningCurlyBracket($node, $oldTokens)) {`
`74`	`75`	`return null;`
`75`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,8 @@ public function getNodeTypes(): array`
`52`	`52`	`public function refactor(Node $node): ?Node`
`53`	`53`	`{`
`54`	`54`	`$hasVariableBeenWrapped = false;`
`55`		`- $oldTokens = $this->file->getOldTokens();`
	`55`	`+ $oldTokens = $this->getFile()`
	`56`	`+ ->getOldTokens();`
`56`	`57`
`57`	`58`	`foreach ($node->parts as $index => $nodePart) {`
`58`	`59`	`if ($nodePart instanceof Variable && $nodePart->getStartTokenPos() >= 0) {`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,8 @@ private function removeStringCast(Expr $expr): Expr`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`$targetExpr = $expr->expr;`
`82`		`- $tokens = $this->file->getOldTokens();`
	`82`	`+ $tokens = $this->getFile()`
	`83`	`+ ->getOldTokens();`
`83`	`84`
`84`	`85`	`if ($expr->expr instanceof BinaryOp) {`
`85`	`86`	`$castStartTokenPos = $expr->getStartTokenPos();`
Original file line number	Diff line number	Diff line change
`@@ -214,7 +214,7 @@ private function processBinaryMulAndDiv(Mul \| Div $binaryOp): ?Expr`
`214`	`214`	`if ($binaryOp instanceof Mul && $this->isLiteralOne($binaryOp->left) && $this->nodeTypeResolver->isNumberType(`
`215`	`215`	`$binaryOp->right`
`216`	`216`	`)) {`
`217`		`- if ($this->isMulParenthesized($this->file, $binaryOp)) {`
	`217`	`+ if ($this->isMulParenthesized($this->getFile(), $binaryOp)) {`
`218`	`218`	`$binaryOp->right->setAttribute(AttributeKey::WRAPPED_IN_PARENTHESES, true);`
`219`	`219`	`}`
`220`	`220`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,8 @@ public function provideMinPhpVersion(): int`
`77`	`77`
`78`	`78`	`private function isParenthesized(Expr $ifExpr, Expr $elseExpr): bool`
`79`	`79`	`{`
`80`		`- $tokens = $this->file->getOldTokens();`
	`80`	`+ $tokens = $this->getFile()`
	`81`	`+ ->getOldTokens();`
`81`	`82`
`82`	`83`	`$ifExprTokenEnd = $ifExpr->getEndTokenPos();`
`83`	`84`	`$elseExprTokenStart = $elseExpr->getStartTokenPos();`