Skip to content
/rector-srcPublic

Introduce FileNode to handle file-level changes#7728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TomasVotruba merged 11 commits into from
Dec 22, 2025
Merged

Introduce FileNode to handle file-level changes #7728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
90e7a01
introduce FileNode to handle file-level changes; deprecate IncreaseDe…
TomasVotruba Dec 6, 2025
e5f0f10
update use resolving
TomasVotruba Dec 6, 2025
b0e6e0f
make use of FileNode in imports
TomasVotruba Dec 6, 2025
0ac86aa
add fixture to keep protected method
TomasVotruba Dec 7, 2025
c87b73a
require rector repo updated PRs
TomasVotruba Dec 7, 2025
a9a7b2e
add FileNode upgrade to UPGRADING
TomasVotruba Dec 7, 2025
2dde27e
[ci] add job to check laravel rector with latest dev-main build
TomasVotruba Dec 7, 2025
da7fdb5
add node matching support for FileWithoutNamespace
TomasVotruba Dec 22, 2025
65c921e
warn about deprecated type
TomasVotruba Dec 22, 2025
fbd4e4c
print stmts with false
TomasVotruba Dec 22, 2025
ff771b0
[docs] add specific example how to iterate stmts of namespaced and no…
TomasVotruba Dec 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/code_analysis.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ jobs:

-
name: 'Finalize classes'
run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run
run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run --skip-file="src/PhpParser/Node/FileNode.php"

-
name: 'Check before/after test fixture on no-changes'
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/rector_laravel_rector_dev.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,3 +28,4 @@ jobs:
- run: git clone https://github.com/driftingly/rector-laravel.git
- run: composer require rector/rector:dev-main --working-dir rector-laravel
- run: cd rector-laravel && vendor/bin/phpunit

107 changes: 107 additions & 0 deletions UPGRADING.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,110 @@
# Upgrading from Rector 2.2.14 to 2.3

* `FileWithoutNamespace` is deprecated, and replaced by `FileNode` that represents both namespaced and non-namespaced files and allow changes inside
* `beforeTraverse()` is now marked as `@final`, use `getNodeTypes()` with `FileNode::class` instead

**Before**

```php
use Rector\PhpParser\Node\FileWithoutNamespace;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
public function getNodeTypes(): array
{
return [FileWithoutNamespace::class];
}

public function beforeTraverse(array $nodes): array
{
// some node hacking
}

/**
* @param FileWithoutNamespace $node
*/
public function refactor(Node $node): ?Node
{
// ...
}

}
```

**After**

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
public function getNodeTypes(): array
{
return [FileNode::class];
}

/**
* @param FileNode $node
*/
public function refactor(Node $node): ?Node
{
foreach ($node->stmts as $stmt) {
// check if has declare_strict already?
// ...

// create it
$declareStrictTypes = $this->createDeclareStrictTypesNode();

// add it
$node->stmts = array_merge([$declareStrictTypes], $node->stmts);
}

return $node;
}

}
```

<br>

The `FileNode` handles both namespaced and non-namespaced files. To handle the first stmts inside the file, you hook into 2 nodes:

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;
use PhpParser\Node\Stmt\Namespace_;

final class SomeRector extends AbstractRector
{
public function getNodeTypes(): array
{
return [FileNode::class, Namespace_::class];
}

/**
* @param FileNode|Namespace_ $node
*/
public function refactor(Node $node): ?Node
{
if ($node instanceof FileNode && $node->isNamespaced()) {
// handled in the Namespace_ node
return null;
}

foreach ($node->stmts as $stmt) {
// modify stmts in desired way here
}

return $node;
}

}
```

<br>

# Upgrading from Rector 1.x to 2.0

## PHP version requirements
Expand Down
2 changes: 0 additions & 2 deletions composer-dependency-analyser.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@
// ensure use version ^3.2.0
->ignoreErrorsOnPackage('composer/pcre', [ErrorType::UNUSED_DEPENDENCY])

->ignoreErrorsOnPath(__DIR__ . '/src/Reporting/DeprecatedRulesReporter.php', [ErrorType::UNKNOWN_CLASS])

->ignoreErrorsOnPaths([
__DIR__ . '/stubs',
__DIR__ . '/tests',
Expand Down
49 changes: 29 additions & 20 deletions phpstan.neon
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ parameters:

# see https://phpstan.org/writing-php-code/phpdoc-types#global-type-aliases
typeAliases:
StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\CustomNode\FileWithoutNamespace
StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\FileNode

# requires exact closure types
checkMissingCallableSignature: true
Expand DownExpand Up@@ -189,8 +189,10 @@ parameters:
message: '#Method Rector\\Util\\ArrayParametersMerger\:\:mergeLeftToRightWithCallable\(\) has parameter \$mergeCallback with no signature specified for callable#'
path: src/Util/ArrayParametersMerger.php

# fixture class
- '#Class "Rector\\Tests\\Issues\\ScopeNotAvailable\\Variable\\ArrayItemForeachValueRector" is missing @see annotation with test case class reference#'
# fixture Rector rules
-
identifier: symplify.seeAnnotationToTest
path: tests/Issues/

# classes are part of *.php.inc fixture
-
Expand DownExpand Up@@ -286,7 +288,6 @@ parameters:
- src/Configuration/RectorConfigBuilder.php
- src/Reporting/DeprecatedRulesReporter.php
identifier: classConstant.deprecatedInterface
- '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace implements deprecated interface Rector\\Contract\\PhpParser\\Node\\StmtsAwareInterface#'

# allowed internally only
-
Expand DownExpand Up@@ -398,12 +399,6 @@ parameters:
paths:
- rules/Php70/Rector/If_/IfToSpaceshipRector.php

# handles full file
-
paths:
- rules/TypeDeclaration/Rector/StmtsAwareInterface/IncreaseDeclareStrictTypesRector.php
identifier: rector.noOnlyNullReturnInRefactor

-
identifier: rector.noIntegerRefactorReturn
paths:
Expand All@@ -416,22 +411,22 @@ parameters:
# condition check, just to be sure
- '#Method Rector\\Rector\\AbstractRector\:\:enterNode\(\) never returns 3 so it can be removed from the return type#'

# special case, working on a file-level
-
identifier: rector.noOnlyNullReturnInRefactor
path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

# handle next with FileNode
-
identifier: method.parentMethodFinalByPhpDoc
path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

# deprecated
-
identifier: public.method.unused
paths:
- rules/Transform/ValueObject/ClassMethodReference.php
- rules/CodeQuality/ValueObject/KeyAndExpr.php
-
identifier: symplify.forbiddenExtendOfNonAbstractClass
path: src/PhpParser/Node/FileNode.php
-
identifier: method.deprecatedClass
path: src/PhpParser/Node/FileNode.php

-
identifier: class.extendsDeprecatedClass
path: src/PhpParser/Node/FileNode.php

-
identifier: public.classConstant.unused
Expand All@@ -450,8 +445,22 @@ parameters:
- '#Register "Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector" service to "php81\.php" config set#'
- '#Class "Rector\\CodingStyle\\Rector\\String_\\SymplifyQuoteEscapeRector" is missing @see annotation with test case class reference#'
- '#Access to constant on deprecated class Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector#'

# BC layer for FileWithoutNamespace node
- message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
- '#BC layer for FileNode and FileWithoutNamespace compat, use FileNode instead#'
-
path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
identifier: symplify.forbiddenExtendOfNonAbstractClass
-
message: '#Only abstract classes can be extended#'
path: rules/Php81/Rector/Array_/FirstClassCallableRector.php

- '#Method Rector\\Tests\\Issues\\FileWithoutNamespaceCompat\\Rector\\SubscribedToFileWithoutNamespaceRector\:\:refactor\(\) should return Rector\\PhpParser\\Node\\FileNode but returns Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace#'

# BC layer for FileWithoutNamespace node
- message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
- '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace extends final class Rector\\PhpParser\\Node\\FileNode#'
-
path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
identifier: symplify.forbiddenExtendOfNonAbstractClass
3 changes: 2 additions & 1 deletion ...assMethod/PrivatizeFinalClassMethodRector/Fixture/keep_magic_parent_called_method.php.inc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,12 @@
namespace Rector\Tests\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Fixture;

use PhpParser\PrettyPrinter\Standard;
use Rector\PhpParser\Node\FileNode;

final class KeepMagicParentCalledMethod extends Standard
{
// called from parent by $this->{'p'} method
protected function pFileNode($fileNode)
protected function pFileNode(FileNode $fileNode)
{
}
}
16 changes: 9 additions & 7 deletions rules/CodingStyle/Application/UseImportsAdder.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
use Rector\CodingStyle\ClassNameImport\UsedImportsResolver;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\StaticTypeMapper\ValueObject\Type\AliasedObjectType;
use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedObjectType;

Expand All@@ -33,7 +33,7 @@ public function __construct(
* @param array<FullyQualifiedObjectType|AliasedObjectType> $functionUseImportTypes
*/
public function addImportsToStmts(
FileWithoutNamespace $fileWithoutNamespace,
FileNode $fileNode,
array $stmts,
array $useImportTypes,
array $constantUseImportTypes,
Expand All@@ -45,10 +45,12 @@ public function addImportsToStmts(
$existingFunctionUseImports = $usedImports->getFunctionImports();

$useImportTypes = $this->diffFullyQualifiedObjectTypes($useImportTypes, $existingUseImportTypes);

$constantUseImportTypes = $this->diffFullyQualifiedObjectTypes(
$constantUseImportTypes,
$existingConstantUseImports
);

$functionUseImportTypes = $this->diffFullyQualifiedObjectTypes(
$functionUseImportTypes,
$existingFunctionUseImports
Expand DownExpand Up@@ -90,17 +92,17 @@ public function addImportsToStmts(

array_splice($stmts, $key + 1, 0, $nodesToAdd);

$fileWithoutNamespace->stmts = $stmts;
$fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
$fileNode->stmts = $stmts;
$fileNode->stmts = array_values($fileNode->stmts);

return true;
}

$this->mirrorUseComments($stmts, $newUses);

// make use stmts first
$fileWithoutNamespace->stmts = array_merge($newUses, $this->resolveInsertNop($fileWithoutNamespace), $stmts);
$fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
$fileNode->stmts = array_merge($newUses, $this->resolveInsertNop($fileNode), $stmts);
$fileNode->stmts = array_values($fileNode->stmts);

return true;
}
Expand DownExpand Up@@ -154,7 +156,7 @@ public function addImportsToNamespace(
/**
* @return Nop[]
*/
private function resolveInsertNop(FileWithoutNamespace|Namespace_ $namespace): array
private function resolveInsertNop(FileNode|Namespace_ $namespace): array
{
$currentStmt = $namespace->stmts[0] ?? null;
if (! $currentStmt instanceof Stmt || $currentStmt instanceof Use_ || $currentStmt instanceof GroupUse) {
Expand Down
4 changes: 2 additions & 2 deletions rules/CodingStyle/Application/UseImportsRemover.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@

use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\Renaming\Collector\RenamedNameCollector;

final readonly class UseImportsRemover
Expand All@@ -19,7 +19,7 @@ public function __construct(
/**
* @param string[] $removedUses
*/
public function removeImportsFromStmts(FileWithoutNamespace|Namespace_ $node, array $removedUses): bool
public function removeImportsFromStmts(FileNode|Namespace_ $node, array $removedUses): bool
{
$hasRemoved = false;
foreach ($node->stmts as $key => $stmt) {
Expand Down
8 changes: 4 additions & 4 deletions rules/CodingStyle/ClassNameImport/AliasUsesResolver.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use PhpParser\Node\UseItem;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;

final readonly class AliasUsesResolver
{
Expand All@@ -25,11 +25,11 @@ public function __construct(
*/
public function resolveFromNode(Node $node, array $stmts): array
{
if (! $node instanceof Namespace_ && ! $node instanceof FileWithoutNamespace) {
/** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
if (! $node instanceof Namespace_ && ! $node instanceof FileNode) {
/** @var Namespace_[]|FileNode[] $namespaces */
$namespaces = array_filter(
$stmts,
static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileNode
);
if (count($namespaces) !== 1) {
return [];
Expand Down
19 changes: 5 additions & 14 deletions rules/CodingStyle/ClassNameImport/ShortNameResolver.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,6 @@
use PhpParser\Node\Name;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Namespace_;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
Expand All@@ -20,7 +19,6 @@
use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
use Rector\PhpDocParser\PhpDocParser\PhpDocNodeTraverser;
use Rector\PhpParser\Node\BetterNodeFinder;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\ValueObject\Application\File;

/**
Expand DownExpand Up@@ -65,22 +63,15 @@ public function resolveFromFile(File $file): array
*/
public function resolveShortClassLikeNames(File $file): array
{
$newStmts = $file->getNewStmts();

/** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
$namespaces = array_filter(
$newStmts,
static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
);
if (count($namespaces) !== 1) {
// only handle single namespace nodes
$rootNode = $file->getUseImportsRootNode();

// nothing to resolve
if (! $rootNode instanceof Node) {
return [];
}

$namespace = current($namespaces);

/** @var ClassLike[] $classLikes */
$classLikes = $this->betterNodeFinder->findInstanceOf($namespace->stmts, ClassLike::class);
$classLikes = $this->betterNodeFinder->findInstanceOf($rootNode->stmts, ClassLike::class);

$shortClassLikeNames = [];
foreach ($classLikes as $classLike) {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Introduce FileNode to handle file-level changes by TomasVotruba · Pull Request #7728 · rectorphp/rector-src · GitHub
Skip to content
/rector-srcPublic
Introduce FileNode to handle file-level changes#7728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TomasVotruba
merged 11 commits into

from

Dec 22, 2025
 Merged


Introduce FileNode to handle file-level changes
#7728
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
90e7a01

introduce FileNode to handle file-level changes; deprecate IncreaseDe…


TomasVotruba Dec 6, 2025
e5f0f10

update use resolving


TomasVotruba Dec 6, 2025
b0e6e0f

make use of FileNode in imports


TomasVotruba Dec 6, 2025
0ac86aa

add fixture to keep protected method


TomasVotruba Dec 7, 2025
c87b73a

require rector repo updated PRs


TomasVotruba Dec 7, 2025
a9a7b2e

add FileNode upgrade to UPGRADING


TomasVotruba Dec 7, 2025
2dde27e

[ci] add job to check laravel rector with latest dev-main build


TomasVotruba Dec 7, 2025
da7fdb5

add node matching support for FileWithoutNamespace


TomasVotruba Dec 22, 2025
65c921e

warn about deprecated type


TomasVotruba Dec 22, 2025
fbd4e4c

print stmts with false


TomasVotruba Dec 22, 2025
ff771b0

[docs] add specific example how to iterate stmts of namespaced and no…


TomasVotruba Dec 22, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.github/workflows/code_analysis.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ jobs:

 -
 name: 'Finalize classes'
 run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run
 run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run --skip-file="src/PhpParser/Node/FileNode.php"

 -
 name: 'Check before/after test fixture on no-changes'
Expand Down

1 change: 1 addition & 0 deletions
.github/workflows/rector_laravel_rector_dev.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,3 +28,4 @@ jobs:
 - run: git clone https://github.com/driftingly/rector-laravel.git
 - run: composer require rector/rector:dev-main --working-dir rector-laravel
 - run: cd rector-laravel && vendor/bin/phpunit


107 changes: 107 additions & 0 deletions
UPGRADING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,110 @@
# Upgrading from Rector 2.2.14 to 2.3

* `FileWithoutNamespace` is deprecated, and replaced by `FileNode` that represents both namespaced and non-namespaced files and allow changes inside
* `beforeTraverse()` is now marked as `@final`, use `getNodeTypes()` with `FileNode::class` instead

**Before**

```php
use Rector\PhpParser\Node\FileWithoutNamespace;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileWithoutNamespace::class];
 }

 public function beforeTraverse(array $nodes): array
 {
 // some node hacking
 }

 /**
 * @param FileWithoutNamespace $node
 */
 public function refactor(Node $node): ?Node
 {
 // ...
 }

}
```

**After**

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileNode::class];
 }

 /**
 * @param FileNode $node
 */
 public function refactor(Node $node): ?Node
 {
 foreach ($node->stmts as $stmt) {
 // check if has declare_strict already?
 // ...

 // create it
 $declareStrictTypes = $this->createDeclareStrictTypesNode();

 // add it
 $node->stmts = array_merge([$declareStrictTypes], $node->stmts);
 }

 return $node;
 }

}
```

<br>

The `FileNode` handles both namespaced and non-namespaced files. To handle the first stmts inside the file, you hook into 2 nodes:

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;
use PhpParser\Node\Stmt\Namespace_;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileNode::class, Namespace_::class];
 }

 /**
 * @param FileNode|Namespace_ $node
 */
 public function refactor(Node $node): ?Node
 {
 if ($node instanceof FileNode && $node->isNamespaced()) {
 // handled in the Namespace_ node
 return null;
 }

 foreach ($node->stmts as $stmt) {
 // modify stmts in desired way here
 }

 return $node;
 }

}
```

<br>

# Upgrading from Rector 1.x to 2.0

## PHP version requirements
Expand Down

2 changes: 0 additions & 2 deletions
composer-dependency-analyser.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@
 // ensure use version ^3.2.0
 ->ignoreErrorsOnPackage('composer/pcre', [ErrorType::UNUSED_DEPENDENCY])

 ->ignoreErrorsOnPath(__DIR__ . '/src/Reporting/DeprecatedRulesReporter.php', [ErrorType::UNKNOWN_CLASS])

 ->ignoreErrorsOnPaths([
 __DIR__ . '/stubs',
 __DIR__ . '/tests',
Expand Down

49 changes: 29 additions & 20 deletions
phpstan.neon

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ parameters:

 # see https://phpstan.org/writing-php-code/phpdoc-types#global-type-aliases
 typeAliases:
 StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\CustomNode\FileWithoutNamespace
 StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\FileNode

 # requires exact closure types
 checkMissingCallableSignature: true
Expand DownExpand Up@@ -189,8 +189,10 @@ parameters:
 message: '#Method Rector\\Util\\ArrayParametersMerger\:\:mergeLeftToRightWithCallable\(\) has parameter \$mergeCallback with no signature specified for callable#'
 path: src/Util/ArrayParametersMerger.php

 # fixture class
 - '#Class "Rector\\Tests\\Issues\\ScopeNotAvailable\\Variable\\ArrayItemForeachValueRector" is missing @see annotation with test case class reference#'
 # fixture Rector rules
 -
 identifier: symplify.seeAnnotationToTest
 path: tests/Issues/

 # classes are part of *.php.inc fixture
 -
Expand DownExpand Up@@ -286,7 +288,6 @@ parameters:
 - src/Configuration/RectorConfigBuilder.php
 - src/Reporting/DeprecatedRulesReporter.php
 identifier: classConstant.deprecatedInterface
 - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace implements deprecated interface Rector\\Contract\\PhpParser\\Node\\StmtsAwareInterface#'

 # allowed internally only
 -
Expand DownExpand Up@@ -398,12 +399,6 @@ parameters:
 paths:
 - rules/Php70/Rector/If_/IfToSpaceshipRector.php

 # handles full file
 -
 paths:
 - rules/TypeDeclaration/Rector/StmtsAwareInterface/IncreaseDeclareStrictTypesRector.php
 identifier: rector.noOnlyNullReturnInRefactor

 -
 identifier: rector.noIntegerRefactorReturn
 paths:
Expand All@@ -416,22 +411,22 @@ parameters:
 # condition check, just to be sure
 - '#Method Rector\\Rector\\AbstractRector\:\:enterNode\(\) never returns 3 so it can be removed from the return type#'

 # special case, working on a file-level
 -
 identifier: rector.noOnlyNullReturnInRefactor
 path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

 # handle next with FileNode
 -
 identifier: method.parentMethodFinalByPhpDoc
 path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

 # deprecated
 -
 identifier: public.method.unused
 paths:
 - rules/Transform/ValueObject/ClassMethodReference.php
 - rules/CodeQuality/ValueObject/KeyAndExpr.php
 -
 identifier: symplify.forbiddenExtendOfNonAbstractClass
 path: src/PhpParser/Node/FileNode.php
 -
 identifier: method.deprecatedClass
 path: src/PhpParser/Node/FileNode.php

 -
 identifier: class.extendsDeprecatedClass
 path: src/PhpParser/Node/FileNode.php

 -
 identifier: public.classConstant.unused
Expand All@@ -450,8 +445,22 @@ parameters:
 - '#Register "Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector" service to "php81\.php" config set#'
 - '#Class "Rector\\CodingStyle\\Rector\\String_\\SymplifyQuoteEscapeRector" is missing @see annotation with test case class reference#'
 - '#Access to constant on deprecated class Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector#'

 # BC layer for FileWithoutNamespace node
 - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
 - '#BC layer for FileNode and FileWithoutNamespace compat, use FileNode instead#'
 -
 path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
 identifier: symplify.forbiddenExtendOfNonAbstractClass
 -
 message: '#Only abstract classes can be extended#'
 path: rules/Php81/Rector/Array_/FirstClassCallableRector.php

 - '#Method Rector\\Tests\\Issues\\FileWithoutNamespaceCompat\\Rector\\SubscribedToFileWithoutNamespaceRector\:\:refactor\(\) should return Rector\\PhpParser\\Node\\FileNode but returns Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace#'

 # BC layer for FileWithoutNamespace node
 - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
 - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace extends final class Rector\\PhpParser\\Node\\FileNode#'
 -
 path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
 identifier: symplify.forbiddenExtendOfNonAbstractClass

3 changes: 2 additions & 1 deletion
...assMethod/PrivatizeFinalClassMethodRector/Fixture/keep_magic_parent_called_method.php.inc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,12 @@
namespace Rector\Tests\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Fixture;

use PhpParser\PrettyPrinter\Standard;
use Rector\PhpParser\Node\FileNode;

final class KeepMagicParentCalledMethod extends Standard
{
 // called from parent by $this->{'p'} method
 protected function pFileNode($fileNode)
 protected function pFileNode(FileNode $fileNode)
 {
 }
}

16 changes: 9 additions & 7 deletions
rules/CodingStyle/Application/UseImportsAdder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
use Rector\CodingStyle\ClassNameImport\UsedImportsResolver;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\StaticTypeMapper\ValueObject\Type\AliasedObjectType;
use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedObjectType;

Expand All@@ -33,7 +33,7 @@ public function __construct(
 * @param array<FullyQualifiedObjectType|AliasedObjectType> $functionUseImportTypes
 */
 public function addImportsToStmts(
FileWithoutNamespace $fileWithoutNamespace,
FileNode $fileNode,
 array $stmts,
 array $useImportTypes,
 array $constantUseImportTypes,
Expand All@@ -45,10 +45,12 @@ public function addImportsToStmts(
 $existingFunctionUseImports = $usedImports->getFunctionImports();

 $useImportTypes = $this->diffFullyQualifiedObjectTypes($useImportTypes, $existingUseImportTypes);

 $constantUseImportTypes = $this->diffFullyQualifiedObjectTypes(
 $constantUseImportTypes,
 $existingConstantUseImports
 );

 $functionUseImportTypes = $this->diffFullyQualifiedObjectTypes(
 $functionUseImportTypes,
 $existingFunctionUseImports
Expand DownExpand Up@@ -90,17 +92,17 @@ public function addImportsToStmts(

 array_splice($stmts, $key + 1, 0, $nodesToAdd);

 $fileWithoutNamespace->stmts = $stmts;
 $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 $fileNode->stmts = $stmts;
 $fileNode->stmts = array_values($fileNode->stmts);

 return true;
 }

 $this->mirrorUseComments($stmts, $newUses);

 // make use stmts first
 $fileWithoutNamespace->stmts = array_merge($newUses, $this->resolveInsertNop($fileWithoutNamespace), $stmts);
 $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 $fileNode->stmts = array_merge($newUses, $this->resolveInsertNop($fileNode), $stmts);
 $fileNode->stmts = array_values($fileNode->stmts);

 return true;
 }
Expand DownExpand Up@@ -154,7 +156,7 @@ public function addImportsToNamespace(
 /**
 * @return Nop[]
 */
 private function resolveInsertNop(FileWithoutNamespace|Namespace_ $namespace): array
 private function resolveInsertNop(FileNode|Namespace_ $namespace): array
 {
 $currentStmt = $namespace->stmts[0] ?? null;
 if (! $currentStmt instanceof Stmt || $currentStmt instanceof Use_ || $currentStmt instanceof GroupUse) {
Expand Down

4 changes: 2 additions & 2 deletions
rules/CodingStyle/Application/UseImportsRemover.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@

use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\Renaming\Collector\RenamedNameCollector;

final readonly class UseImportsRemover
Expand All@@ -19,7 +19,7 @@ public function __construct(
 /**
 * @param string[] $removedUses
 */
 public function removeImportsFromStmts(FileWithoutNamespace|Namespace_ $node, array $removedUses): bool
 public function removeImportsFromStmts(FileNode|Namespace_ $node, array $removedUses): bool
 {
 $hasRemoved = false;
 foreach ($node->stmts as $key => $stmt) {
Expand Down

8 changes: 4 additions & 4 deletions
rules/CodingStyle/ClassNameImport/AliasUsesResolver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use PhpParser\Node\UseItem;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;

final readonly class AliasUsesResolver
{
Expand All@@ -25,11 +25,11 @@ public function __construct(
 */
 public function resolveFromNode(Node $node, array $stmts): array
 {
 if (! $node instanceof Namespace_ && ! $node instanceof FileWithoutNamespace) {
 /** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
 if (! $node instanceof Namespace_ && ! $node instanceof FileNode) {
 /** @var Namespace_[]|FileNode[] $namespaces */
 $namespaces = array_filter(
 $stmts,
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileNode
 );
 if (count($namespaces) !== 1) {
 return [];
Expand Down

19 changes: 5 additions & 14 deletions
rules/CodingStyle/ClassNameImport/ShortNameResolver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,6 @@
use PhpParser\Node\Name;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Namespace_;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
Expand All@@ -20,7 +19,6 @@
use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
use Rector\PhpDocParser\PhpDocParser\PhpDocNodeTraverser;
use Rector\PhpParser\Node\BetterNodeFinder;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\ValueObject\Application\File;

/**
Expand DownExpand Up@@ -65,22 +63,15 @@ public function resolveFromFile(File $file): array
 */
 public function resolveShortClassLikeNames(File $file): array
 {
 $newStmts = $file->getNewStmts();

 /** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
 $namespaces = array_filter(
 $newStmts,
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
 );
 if (count($namespaces) !== 1) {
 // only handle single namespace nodes
 $rootNode = $file->getUseImportsRootNode();

 // nothing to resolve
 if (! $rootNode instanceof Node) {
 return [];
 }

 $namespace = current($namespaces);

 /** @var ClassLike[] $classLikes */
 $classLikes = $this->betterNodeFinder->findInstanceOf($namespace->stmts, ClassLike::class);
 $classLikes = $this->betterNodeFinder->findInstanceOf($rootNode->stmts, ClassLike::class);

 $shortClassLikeNames = [];
 foreach ($classLikes as $classLike) {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Introduce FileNode to handle file-level changes by TomasVotruba · Pull Request #7728 · rectorphp/rector-src · GitHub
Skip to content
/rector-srcPublic
Introduce FileNode to handle file-level changes#7728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TomasVotruba
merged 11 commits into

from

Dec 22, 2025
 Merged


Introduce FileNode to handle file-level changes
#7728
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
90e7a01

introduce FileNode to handle file-level changes; deprecate IncreaseDe…


TomasVotruba Dec 6, 2025
e5f0f10

update use resolving


TomasVotruba Dec 6, 2025
b0e6e0f

make use of FileNode in imports


TomasVotruba Dec 6, 2025
0ac86aa

add fixture to keep protected method


TomasVotruba Dec 7, 2025
c87b73a

require rector repo updated PRs


TomasVotruba Dec 7, 2025
a9a7b2e

add FileNode upgrade to UPGRADING


TomasVotruba Dec 7, 2025
2dde27e

[ci] add job to check laravel rector with latest dev-main build


TomasVotruba Dec 7, 2025
da7fdb5

add node matching support for FileWithoutNamespace


TomasVotruba Dec 22, 2025
65c921e

warn about deprecated type


TomasVotruba Dec 22, 2025
fbd4e4c

print stmts with false


TomasVotruba Dec 22, 2025
ff771b0

[docs] add specific example how to iterate stmts of namespaced and no…


TomasVotruba Dec 22, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.github/workflows/code_analysis.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ jobs:

 -
 name: 'Finalize classes'
 run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run
 run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run --skip-file="src/PhpParser/Node/FileNode.php"

 -
 name: 'Check before/after test fixture on no-changes'
Expand Down

1 change: 1 addition & 0 deletions
.github/workflows/rector_laravel_rector_dev.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,3 +28,4 @@ jobs:
 - run: git clone https://github.com/driftingly/rector-laravel.git
 - run: composer require rector/rector:dev-main --working-dir rector-laravel
 - run: cd rector-laravel && vendor/bin/phpunit


107 changes: 107 additions & 0 deletions
UPGRADING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,110 @@
# Upgrading from Rector 2.2.14 to 2.3

* `FileWithoutNamespace` is deprecated, and replaced by `FileNode` that represents both namespaced and non-namespaced files and allow changes inside
* `beforeTraverse()` is now marked as `@final`, use `getNodeTypes()` with `FileNode::class` instead

**Before**

```php
use Rector\PhpParser\Node\FileWithoutNamespace;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileWithoutNamespace::class];
 }

 public function beforeTraverse(array $nodes): array
 {
 // some node hacking
 }

 /**
 * @param FileWithoutNamespace $node
 */
 public function refactor(Node $node): ?Node
 {
 // ...
 }

}
```

**After**

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileNode::class];
 }

 /**
 * @param FileNode $node
 */
 public function refactor(Node $node): ?Node
 {
 foreach ($node->stmts as $stmt) {
 // check if has declare_strict already?
 // ...

 // create it
 $declareStrictTypes = $this->createDeclareStrictTypesNode();

 // add it
 $node->stmts = array_merge([$declareStrictTypes], $node->stmts);
 }

 return $node;
 }

}
```

<br>

The `FileNode` handles both namespaced and non-namespaced files. To handle the first stmts inside the file, you hook into 2 nodes:

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;
use PhpParser\Node\Stmt\Namespace_;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileNode::class, Namespace_::class];
 }

 /**
 * @param FileNode|Namespace_ $node
 */
 public function refactor(Node $node): ?Node
 {
 if ($node instanceof FileNode && $node->isNamespaced()) {
 // handled in the Namespace_ node
 return null;
 }

 foreach ($node->stmts as $stmt) {
 // modify stmts in desired way here
 }

 return $node;
 }

}
```

<br>

# Upgrading from Rector 1.x to 2.0

## PHP version requirements
Expand Down

2 changes: 0 additions & 2 deletions
composer-dependency-analyser.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@
 // ensure use version ^3.2.0
 ->ignoreErrorsOnPackage('composer/pcre', [ErrorType::UNUSED_DEPENDENCY])

 ->ignoreErrorsOnPath(__DIR__ . '/src/Reporting/DeprecatedRulesReporter.php', [ErrorType::UNKNOWN_CLASS])

 ->ignoreErrorsOnPaths([
 __DIR__ . '/stubs',
 __DIR__ . '/tests',
Expand Down

49 changes: 29 additions & 20 deletions
phpstan.neon

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ parameters:

 # see https://phpstan.org/writing-php-code/phpdoc-types#global-type-aliases
 typeAliases:
 StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\CustomNode\FileWithoutNamespace
 StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\FileNode

 # requires exact closure types
 checkMissingCallableSignature: true
Expand DownExpand Up@@ -189,8 +189,10 @@ parameters:
 message: '#Method Rector\\Util\\ArrayParametersMerger\:\:mergeLeftToRightWithCallable\(\) has parameter \$mergeCallback with no signature specified for callable#'
 path: src/Util/ArrayParametersMerger.php

 # fixture class
 - '#Class "Rector\\Tests\\Issues\\ScopeNotAvailable\\Variable\\ArrayItemForeachValueRector" is missing @see annotation with test case class reference#'
 # fixture Rector rules
 -
 identifier: symplify.seeAnnotationToTest
 path: tests/Issues/

 # classes are part of *.php.inc fixture
 -
Expand DownExpand Up@@ -286,7 +288,6 @@ parameters:
 - src/Configuration/RectorConfigBuilder.php
 - src/Reporting/DeprecatedRulesReporter.php
 identifier: classConstant.deprecatedInterface
 - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace implements deprecated interface Rector\\Contract\\PhpParser\\Node\\StmtsAwareInterface#'

 # allowed internally only
 -
Expand DownExpand Up@@ -398,12 +399,6 @@ parameters:
 paths:
 - rules/Php70/Rector/If_/IfToSpaceshipRector.php

 # handles full file
 -
 paths:
 - rules/TypeDeclaration/Rector/StmtsAwareInterface/IncreaseDeclareStrictTypesRector.php
 identifier: rector.noOnlyNullReturnInRefactor

 -
 identifier: rector.noIntegerRefactorReturn
 paths:
Expand All@@ -416,22 +411,22 @@ parameters:
 # condition check, just to be sure
 - '#Method Rector\\Rector\\AbstractRector\:\:enterNode\(\) never returns 3 so it can be removed from the return type#'

 # special case, working on a file-level
 -
 identifier: rector.noOnlyNullReturnInRefactor
 path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

 # handle next with FileNode
 -
 identifier: method.parentMethodFinalByPhpDoc
 path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

 # deprecated
 -
 identifier: public.method.unused
 paths:
 - rules/Transform/ValueObject/ClassMethodReference.php
 - rules/CodeQuality/ValueObject/KeyAndExpr.php
 -
 identifier: symplify.forbiddenExtendOfNonAbstractClass
 path: src/PhpParser/Node/FileNode.php
 -
 identifier: method.deprecatedClass
 path: src/PhpParser/Node/FileNode.php

 -
 identifier: class.extendsDeprecatedClass
 path: src/PhpParser/Node/FileNode.php

 -
 identifier: public.classConstant.unused
Expand All@@ -450,8 +445,22 @@ parameters:
 - '#Register "Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector" service to "php81\.php" config set#'
 - '#Class "Rector\\CodingStyle\\Rector\\String_\\SymplifyQuoteEscapeRector" is missing @see annotation with test case class reference#'
 - '#Access to constant on deprecated class Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector#'

 # BC layer for FileWithoutNamespace node
 - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
 - '#BC layer for FileNode and FileWithoutNamespace compat, use FileNode instead#'
 -
 path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
 identifier: symplify.forbiddenExtendOfNonAbstractClass
 -
 message: '#Only abstract classes can be extended#'
 path: rules/Php81/Rector/Array_/FirstClassCallableRector.php

 - '#Method Rector\\Tests\\Issues\\FileWithoutNamespaceCompat\\Rector\\SubscribedToFileWithoutNamespaceRector\:\:refactor\(\) should return Rector\\PhpParser\\Node\\FileNode but returns Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace#'

 # BC layer for FileWithoutNamespace node
 - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
 - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace extends final class Rector\\PhpParser\\Node\\FileNode#'
 -
 path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
 identifier: symplify.forbiddenExtendOfNonAbstractClass

3 changes: 2 additions & 1 deletion
...assMethod/PrivatizeFinalClassMethodRector/Fixture/keep_magic_parent_called_method.php.inc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,12 @@
namespace Rector\Tests\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Fixture;

use PhpParser\PrettyPrinter\Standard;
use Rector\PhpParser\Node\FileNode;

final class KeepMagicParentCalledMethod extends Standard
{
 // called from parent by $this->{'p'} method
 protected function pFileNode($fileNode)
 protected function pFileNode(FileNode $fileNode)
 {
 }
}

16 changes: 9 additions & 7 deletions
rules/CodingStyle/Application/UseImportsAdder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
use Rector\CodingStyle\ClassNameImport\UsedImportsResolver;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\StaticTypeMapper\ValueObject\Type\AliasedObjectType;
use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedObjectType;

Expand All@@ -33,7 +33,7 @@ public function __construct(
 * @param array<FullyQualifiedObjectType|AliasedObjectType> $functionUseImportTypes
 */
 public function addImportsToStmts(
FileWithoutNamespace $fileWithoutNamespace,
FileNode $fileNode,
 array $stmts,
 array $useImportTypes,
 array $constantUseImportTypes,
Expand All@@ -45,10 +45,12 @@ public function addImportsToStmts(
 $existingFunctionUseImports = $usedImports->getFunctionImports();

 $useImportTypes = $this->diffFullyQualifiedObjectTypes($useImportTypes, $existingUseImportTypes);

 $constantUseImportTypes = $this->diffFullyQualifiedObjectTypes(
 $constantUseImportTypes,
 $existingConstantUseImports
 );

 $functionUseImportTypes = $this->diffFullyQualifiedObjectTypes(
 $functionUseImportTypes,
 $existingFunctionUseImports
Expand DownExpand Up@@ -90,17 +92,17 @@ public function addImportsToStmts(

 array_splice($stmts, $key + 1, 0, $nodesToAdd);

 $fileWithoutNamespace->stmts = $stmts;
 $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 $fileNode->stmts = $stmts;
 $fileNode->stmts = array_values($fileNode->stmts);

 return true;
 }

 $this->mirrorUseComments($stmts, $newUses);

 // make use stmts first
 $fileWithoutNamespace->stmts = array_merge($newUses, $this->resolveInsertNop($fileWithoutNamespace), $stmts);
 $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 $fileNode->stmts = array_merge($newUses, $this->resolveInsertNop($fileNode), $stmts);
 $fileNode->stmts = array_values($fileNode->stmts);

 return true;
 }
Expand DownExpand Up@@ -154,7 +156,7 @@ public function addImportsToNamespace(
 /**
 * @return Nop[]
 */
 private function resolveInsertNop(FileWithoutNamespace|Namespace_ $namespace): array
 private function resolveInsertNop(FileNode|Namespace_ $namespace): array
 {
 $currentStmt = $namespace->stmts[0] ?? null;
 if (! $currentStmt instanceof Stmt || $currentStmt instanceof Use_ || $currentStmt instanceof GroupUse) {
Expand Down

4 changes: 2 additions & 2 deletions
rules/CodingStyle/Application/UseImportsRemover.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@

use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\Renaming\Collector\RenamedNameCollector;

final readonly class UseImportsRemover
Expand All@@ -19,7 +19,7 @@ public function __construct(
 /**
 * @param string[] $removedUses
 */
 public function removeImportsFromStmts(FileWithoutNamespace|Namespace_ $node, array $removedUses): bool
 public function removeImportsFromStmts(FileNode|Namespace_ $node, array $removedUses): bool
 {
 $hasRemoved = false;
 foreach ($node->stmts as $key => $stmt) {
Expand Down

8 changes: 4 additions & 4 deletions
rules/CodingStyle/ClassNameImport/AliasUsesResolver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use PhpParser\Node\UseItem;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;

final readonly class AliasUsesResolver
{
Expand All@@ -25,11 +25,11 @@ public function __construct(
 */
 public function resolveFromNode(Node $node, array $stmts): array
 {
 if (! $node instanceof Namespace_ && ! $node instanceof FileWithoutNamespace) {
 /** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
 if (! $node instanceof Namespace_ && ! $node instanceof FileNode) {
 /** @var Namespace_[]|FileNode[] $namespaces */
 $namespaces = array_filter(
 $stmts,
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileNode
 );
 if (count($namespaces) !== 1) {
 return [];
Expand Down

19 changes: 5 additions & 14 deletions
rules/CodingStyle/ClassNameImport/ShortNameResolver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,6 @@
use PhpParser\Node\Name;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Namespace_;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
Expand All@@ -20,7 +19,6 @@
use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
use Rector\PhpDocParser\PhpDocParser\PhpDocNodeTraverser;
use Rector\PhpParser\Node\BetterNodeFinder;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\ValueObject\Application\File;

/**
Expand DownExpand Up@@ -65,22 +63,15 @@ public function resolveFromFile(File $file): array
 */
 public function resolveShortClassLikeNames(File $file): array
 {
 $newStmts = $file->getNewStmts();

 /** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
 $namespaces = array_filter(
 $newStmts,
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
 );
 if (count($namespaces) !== 1) {
 // only handle single namespace nodes
 $rootNode = $file->getUseImportsRootNode();

 // nothing to resolve
 if (! $rootNode instanceof Node) {
 return [];
 }

 $namespace = current($namespaces);

 /** @var ClassLike[] $classLikes */
 $classLikes = $this->betterNodeFinder->findInstanceOf($namespace->stmts, ClassLike::class);
 $classLikes = $this->betterNodeFinder->findInstanceOf($rootNode->stmts, ClassLike::class);

 $shortClassLikeNames = [];
 foreach ($classLikes as $classLike) {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Introduce FileNode to handle file-level changes by TomasVotruba · Pull Request #7728 · rectorphp/rector-src · GitHub
Skip to content
/rector-srcPublic
Introduce FileNode to handle file-level changes#7728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TomasVotruba
merged 11 commits into

from

Dec 22, 2025
 Merged


Introduce FileNode to handle file-level changes
#7728
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
90e7a01

introduce FileNode to handle file-level changes; deprecate IncreaseDe…


TomasVotruba Dec 6, 2025
e5f0f10

update use resolving


TomasVotruba Dec 6, 2025
b0e6e0f

make use of FileNode in imports


TomasVotruba Dec 6, 2025
0ac86aa

add fixture to keep protected method


TomasVotruba Dec 7, 2025
c87b73a

require rector repo updated PRs


TomasVotruba Dec 7, 2025
a9a7b2e

add FileNode upgrade to UPGRADING


TomasVotruba Dec 7, 2025
2dde27e

[ci] add job to check laravel rector with latest dev-main build


TomasVotruba Dec 7, 2025
da7fdb5

add node matching support for FileWithoutNamespace


TomasVotruba Dec 22, 2025
65c921e

warn about deprecated type


TomasVotruba Dec 22, 2025
fbd4e4c

print stmts with false


TomasVotruba Dec 22, 2025
ff771b0

[docs] add specific example how to iterate stmts of namespaced and no…


TomasVotruba Dec 22, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.github/workflows/code_analysis.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ jobs:

 -
 name: 'Finalize classes'
 run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run
 run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run --skip-file="src/PhpParser/Node/FileNode.php"

 -
 name: 'Check before/after test fixture on no-changes'
Expand Down

1 change: 1 addition & 0 deletions
.github/workflows/rector_laravel_rector_dev.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,3 +28,4 @@ jobs:
 - run: git clone https://github.com/driftingly/rector-laravel.git
 - run: composer require rector/rector:dev-main --working-dir rector-laravel
 - run: cd rector-laravel && vendor/bin/phpunit


107 changes: 107 additions & 0 deletions
UPGRADING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,110 @@
# Upgrading from Rector 2.2.14 to 2.3

* `FileWithoutNamespace` is deprecated, and replaced by `FileNode` that represents both namespaced and non-namespaced files and allow changes inside
* `beforeTraverse()` is now marked as `@final`, use `getNodeTypes()` with `FileNode::class` instead

**Before**

```php
use Rector\PhpParser\Node\FileWithoutNamespace;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileWithoutNamespace::class];
 }

 public function beforeTraverse(array $nodes): array
 {
 // some node hacking
 }

 /**
 * @param FileWithoutNamespace $node
 */
 public function refactor(Node $node): ?Node
 {
 // ...
 }

}
```

**After**

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileNode::class];
 }

 /**
 * @param FileNode $node
 */
 public function refactor(Node $node): ?Node
 {
 foreach ($node->stmts as $stmt) {
 // check if has declare_strict already?
 // ...

 // create it
 $declareStrictTypes = $this->createDeclareStrictTypesNode();

 // add it
 $node->stmts = array_merge([$declareStrictTypes], $node->stmts);
 }

 return $node;
 }

}
```

<br>

The `FileNode` handles both namespaced and non-namespaced files. To handle the first stmts inside the file, you hook into 2 nodes:

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;
use PhpParser\Node\Stmt\Namespace_;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileNode::class, Namespace_::class];
 }

 /**
 * @param FileNode|Namespace_ $node
 */
 public function refactor(Node $node): ?Node
 {
 if ($node instanceof FileNode && $node->isNamespaced()) {
 // handled in the Namespace_ node
 return null;
 }

 foreach ($node->stmts as $stmt) {
 // modify stmts in desired way here
 }

 return $node;
 }

}
```

<br>

# Upgrading from Rector 1.x to 2.0

## PHP version requirements
Expand Down

2 changes: 0 additions & 2 deletions
composer-dependency-analyser.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@
 // ensure use version ^3.2.0
 ->ignoreErrorsOnPackage('composer/pcre', [ErrorType::UNUSED_DEPENDENCY])

 ->ignoreErrorsOnPath(__DIR__ . '/src/Reporting/DeprecatedRulesReporter.php', [ErrorType::UNKNOWN_CLASS])

 ->ignoreErrorsOnPaths([
 __DIR__ . '/stubs',
 __DIR__ . '/tests',
Expand Down

49 changes: 29 additions & 20 deletions
phpstan.neon

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ parameters:

 # see https://phpstan.org/writing-php-code/phpdoc-types#global-type-aliases
 typeAliases:
 StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\CustomNode\FileWithoutNamespace
 StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\FileNode

 # requires exact closure types
 checkMissingCallableSignature: true
Expand DownExpand Up@@ -189,8 +189,10 @@ parameters:
 message: '#Method Rector\\Util\\ArrayParametersMerger\:\:mergeLeftToRightWithCallable\(\) has parameter \$mergeCallback with no signature specified for callable#'
 path: src/Util/ArrayParametersMerger.php

 # fixture class
 - '#Class "Rector\\Tests\\Issues\\ScopeNotAvailable\\Variable\\ArrayItemForeachValueRector" is missing @see annotation with test case class reference#'
 # fixture Rector rules
 -
 identifier: symplify.seeAnnotationToTest
 path: tests/Issues/

 # classes are part of *.php.inc fixture
 -
Expand DownExpand Up@@ -286,7 +288,6 @@ parameters:
 - src/Configuration/RectorConfigBuilder.php
 - src/Reporting/DeprecatedRulesReporter.php
 identifier: classConstant.deprecatedInterface
 - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace implements deprecated interface Rector\\Contract\\PhpParser\\Node\\StmtsAwareInterface#'

 # allowed internally only
 -
Expand DownExpand Up@@ -398,12 +399,6 @@ parameters:
 paths:
 - rules/Php70/Rector/If_/IfToSpaceshipRector.php

 # handles full file
 -
 paths:
 - rules/TypeDeclaration/Rector/StmtsAwareInterface/IncreaseDeclareStrictTypesRector.php
 identifier: rector.noOnlyNullReturnInRefactor

 -
 identifier: rector.noIntegerRefactorReturn
 paths:
Expand All@@ -416,22 +411,22 @@ parameters:
 # condition check, just to be sure
 - '#Method Rector\\Rector\\AbstractRector\:\:enterNode\(\) never returns 3 so it can be removed from the return type#'

 # special case, working on a file-level
 -
 identifier: rector.noOnlyNullReturnInRefactor
 path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

 # handle next with FileNode
 -
 identifier: method.parentMethodFinalByPhpDoc
 path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

 # deprecated
 -
 identifier: public.method.unused
 paths:
 - rules/Transform/ValueObject/ClassMethodReference.php
 - rules/CodeQuality/ValueObject/KeyAndExpr.php
 -
 identifier: symplify.forbiddenExtendOfNonAbstractClass
 path: src/PhpParser/Node/FileNode.php
 -
 identifier: method.deprecatedClass
 path: src/PhpParser/Node/FileNode.php

 -
 identifier: class.extendsDeprecatedClass
 path: src/PhpParser/Node/FileNode.php

 -
 identifier: public.classConstant.unused
Expand All@@ -450,8 +445,22 @@ parameters:
 - '#Register "Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector" service to "php81\.php" config set#'
 - '#Class "Rector\\CodingStyle\\Rector\\String_\\SymplifyQuoteEscapeRector" is missing @see annotation with test case class reference#'
 - '#Access to constant on deprecated class Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector#'

 # BC layer for FileWithoutNamespace node
 - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
 - '#BC layer for FileNode and FileWithoutNamespace compat, use FileNode instead#'
 -
 path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
 identifier: symplify.forbiddenExtendOfNonAbstractClass
 -
 message: '#Only abstract classes can be extended#'
 path: rules/Php81/Rector/Array_/FirstClassCallableRector.php

 - '#Method Rector\\Tests\\Issues\\FileWithoutNamespaceCompat\\Rector\\SubscribedToFileWithoutNamespaceRector\:\:refactor\(\) should return Rector\\PhpParser\\Node\\FileNode but returns Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace#'

 # BC layer for FileWithoutNamespace node
 - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
 - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace extends final class Rector\\PhpParser\\Node\\FileNode#'
 -
 path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
 identifier: symplify.forbiddenExtendOfNonAbstractClass

3 changes: 2 additions & 1 deletion
...assMethod/PrivatizeFinalClassMethodRector/Fixture/keep_magic_parent_called_method.php.inc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,12 @@
namespace Rector\Tests\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Fixture;

use PhpParser\PrettyPrinter\Standard;
use Rector\PhpParser\Node\FileNode;

final class KeepMagicParentCalledMethod extends Standard
{
 // called from parent by $this->{'p'} method
 protected function pFileNode($fileNode)
 protected function pFileNode(FileNode $fileNode)
 {
 }
}

16 changes: 9 additions & 7 deletions
rules/CodingStyle/Application/UseImportsAdder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
use Rector\CodingStyle\ClassNameImport\UsedImportsResolver;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\StaticTypeMapper\ValueObject\Type\AliasedObjectType;
use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedObjectType;

Expand All@@ -33,7 +33,7 @@ public function __construct(
 * @param array<FullyQualifiedObjectType|AliasedObjectType> $functionUseImportTypes
 */
 public function addImportsToStmts(
FileWithoutNamespace $fileWithoutNamespace,
FileNode $fileNode,
 array $stmts,
 array $useImportTypes,
 array $constantUseImportTypes,
Expand All@@ -45,10 +45,12 @@ public function addImportsToStmts(
 $existingFunctionUseImports = $usedImports->getFunctionImports();

 $useImportTypes = $this->diffFullyQualifiedObjectTypes($useImportTypes, $existingUseImportTypes);

 $constantUseImportTypes = $this->diffFullyQualifiedObjectTypes(
 $constantUseImportTypes,
 $existingConstantUseImports
 );

 $functionUseImportTypes = $this->diffFullyQualifiedObjectTypes(
 $functionUseImportTypes,
 $existingFunctionUseImports
Expand DownExpand Up@@ -90,17 +92,17 @@ public function addImportsToStmts(

 array_splice($stmts, $key + 1, 0, $nodesToAdd);

 $fileWithoutNamespace->stmts = $stmts;
 $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 $fileNode->stmts = $stmts;
 $fileNode->stmts = array_values($fileNode->stmts);

 return true;
 }

 $this->mirrorUseComments($stmts, $newUses);

 // make use stmts first
 $fileWithoutNamespace->stmts = array_merge($newUses, $this->resolveInsertNop($fileWithoutNamespace), $stmts);
 $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 $fileNode->stmts = array_merge($newUses, $this->resolveInsertNop($fileNode), $stmts);
 $fileNode->stmts = array_values($fileNode->stmts);

 return true;
 }
Expand DownExpand Up@@ -154,7 +156,7 @@ public function addImportsToNamespace(
 /**
 * @return Nop[]
 */
 private function resolveInsertNop(FileWithoutNamespace|Namespace_ $namespace): array
 private function resolveInsertNop(FileNode|Namespace_ $namespace): array
 {
 $currentStmt = $namespace->stmts[0] ?? null;
 if (! $currentStmt instanceof Stmt || $currentStmt instanceof Use_ || $currentStmt instanceof GroupUse) {
Expand Down

4 changes: 2 additions & 2 deletions
rules/CodingStyle/Application/UseImportsRemover.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@

use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\Renaming\Collector\RenamedNameCollector;

final readonly class UseImportsRemover
Expand All@@ -19,7 +19,7 @@ public function __construct(
 /**
 * @param string[] $removedUses
 */
 public function removeImportsFromStmts(FileWithoutNamespace|Namespace_ $node, array $removedUses): bool
 public function removeImportsFromStmts(FileNode|Namespace_ $node, array $removedUses): bool
 {
 $hasRemoved = false;
 foreach ($node->stmts as $key => $stmt) {
Expand Down

8 changes: 4 additions & 4 deletions
rules/CodingStyle/ClassNameImport/AliasUsesResolver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use PhpParser\Node\UseItem;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;

final readonly class AliasUsesResolver
{
Expand All@@ -25,11 +25,11 @@ public function __construct(
 */
 public function resolveFromNode(Node $node, array $stmts): array
 {
 if (! $node instanceof Namespace_ && ! $node instanceof FileWithoutNamespace) {
 /** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
 if (! $node instanceof Namespace_ && ! $node instanceof FileNode) {
 /** @var Namespace_[]|FileNode[] $namespaces */
 $namespaces = array_filter(
 $stmts,
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileNode
 );
 if (count($namespaces) !== 1) {
 return [];
Expand Down

19 changes: 5 additions & 14 deletions
rules/CodingStyle/ClassNameImport/ShortNameResolver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,6 @@
use PhpParser\Node\Name;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Namespace_;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
Expand All@@ -20,7 +19,6 @@
use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
use Rector\PhpDocParser\PhpDocParser\PhpDocNodeTraverser;
use Rector\PhpParser\Node\BetterNodeFinder;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\ValueObject\Application\File;

/**
Expand DownExpand Up@@ -65,22 +63,15 @@ public function resolveFromFile(File $file): array
 */
 public function resolveShortClassLikeNames(File $file): array
 {
 $newStmts = $file->getNewStmts();

 /** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
 $namespaces = array_filter(
 $newStmts,
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
 );
 if (count($namespaces) !== 1) {
 // only handle single namespace nodes
 $rootNode = $file->getUseImportsRootNode();

 // nothing to resolve
 if (! $rootNode instanceof Node) {
 return [];
 }

 $namespace = current($namespaces);

 /** @var ClassLike[] $classLikes */
 $classLikes = $this->betterNodeFinder->findInstanceOf($namespace->stmts, ClassLike::class);
 $classLikes = $this->betterNodeFinder->findInstanceOf($rootNode->stmts, ClassLike::class);

 $shortClassLikeNames = [];
 foreach ($classLikes as $classLike) {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Introduce FileNode to handle file-level changes by TomasVotruba · Pull Request #7728 · rectorphp/rector-src · GitHub
Skip to content
/rector-srcPublic
Introduce FileNode to handle file-level changes#7728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TomasVotruba
merged 11 commits into

from

Dec 22, 2025
 Merged


Introduce FileNode to handle file-level changes
#7728
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
90e7a01

introduce FileNode to handle file-level changes; deprecate IncreaseDe…


TomasVotruba Dec 6, 2025
e5f0f10

update use resolving


TomasVotruba Dec 6, 2025
b0e6e0f

make use of FileNode in imports


TomasVotruba Dec 6, 2025
0ac86aa

add fixture to keep protected method


TomasVotruba Dec 7, 2025
c87b73a

require rector repo updated PRs


TomasVotruba Dec 7, 2025
a9a7b2e

add FileNode upgrade to UPGRADING


TomasVotruba Dec 7, 2025
2dde27e

[ci] add job to check laravel rector with latest dev-main build


TomasVotruba Dec 7, 2025
da7fdb5

add node matching support for FileWithoutNamespace


TomasVotruba Dec 22, 2025
65c921e

warn about deprecated type


TomasVotruba Dec 22, 2025
fbd4e4c

print stmts with false


TomasVotruba Dec 22, 2025
ff771b0

[docs] add specific example how to iterate stmts of namespaced and no…


TomasVotruba Dec 22, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.github/workflows/code_analysis.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ jobs:

 -
 name: 'Finalize classes'
 run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run
 run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run --skip-file="src/PhpParser/Node/FileNode.php"

 -
 name: 'Check before/after test fixture on no-changes'
Expand Down

1 change: 1 addition & 0 deletions
.github/workflows/rector_laravel_rector_dev.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,3 +28,4 @@ jobs:
 - run: git clone https://github.com/driftingly/rector-laravel.git
 - run: composer require rector/rector:dev-main --working-dir rector-laravel
 - run: cd rector-laravel && vendor/bin/phpunit


107 changes: 107 additions & 0 deletions
UPGRADING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,110 @@
# Upgrading from Rector 2.2.14 to 2.3

* `FileWithoutNamespace` is deprecated, and replaced by `FileNode` that represents both namespaced and non-namespaced files and allow changes inside
* `beforeTraverse()` is now marked as `@final`, use `getNodeTypes()` with `FileNode::class` instead

**Before**

```php
use Rector\PhpParser\Node\FileWithoutNamespace;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileWithoutNamespace::class];
 }

 public function beforeTraverse(array $nodes): array
 {
 // some node hacking
 }

 /**
 * @param FileWithoutNamespace $node
 */
 public function refactor(Node $node): ?Node
 {
 // ...
 }

}
```

**After**

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileNode::class];
 }

 /**
 * @param FileNode $node
 */
 public function refactor(Node $node): ?Node
 {
 foreach ($node->stmts as $stmt) {
 // check if has declare_strict already?
 // ...

 // create it
 $declareStrictTypes = $this->createDeclareStrictTypesNode();

 // add it
 $node->stmts = array_merge([$declareStrictTypes], $node->stmts);
 }

 return $node;
 }

}
```

<br>

The `FileNode` handles both namespaced and non-namespaced files. To handle the first stmts inside the file, you hook into 2 nodes:

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;
use PhpParser\Node\Stmt\Namespace_;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileNode::class, Namespace_::class];
 }

 /**
 * @param FileNode|Namespace_ $node
 */
 public function refactor(Node $node): ?Node
 {
 if ($node instanceof FileNode && $node->isNamespaced()) {
 // handled in the Namespace_ node
 return null;
 }

 foreach ($node->stmts as $stmt) {
 // modify stmts in desired way here
 }

 return $node;
 }

}
```

<br>

# Upgrading from Rector 1.x to 2.0

## PHP version requirements
Expand Down

2 changes: 0 additions & 2 deletions
composer-dependency-analyser.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@
 // ensure use version ^3.2.0
 ->ignoreErrorsOnPackage('composer/pcre', [ErrorType::UNUSED_DEPENDENCY])

 ->ignoreErrorsOnPath(__DIR__ . '/src/Reporting/DeprecatedRulesReporter.php', [ErrorType::UNKNOWN_CLASS])

 ->ignoreErrorsOnPaths([
 __DIR__ . '/stubs',
 __DIR__ . '/tests',
Expand Down

49 changes: 29 additions & 20 deletions
phpstan.neon

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ parameters:

 # see https://phpstan.org/writing-php-code/phpdoc-types#global-type-aliases
 typeAliases:
 StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\CustomNode\FileWithoutNamespace
 StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\FileNode

 # requires exact closure types
 checkMissingCallableSignature: true
Expand DownExpand Up@@ -189,8 +189,10 @@ parameters:
 message: '#Method Rector\\Util\\ArrayParametersMerger\:\:mergeLeftToRightWithCallable\(\) has parameter \$mergeCallback with no signature specified for callable#'
 path: src/Util/ArrayParametersMerger.php

 # fixture class
 - '#Class "Rector\\Tests\\Issues\\ScopeNotAvailable\\Variable\\ArrayItemForeachValueRector" is missing @see annotation with test case class reference#'
 # fixture Rector rules
 -
 identifier: symplify.seeAnnotationToTest
 path: tests/Issues/

 # classes are part of *.php.inc fixture
 -
Expand DownExpand Up@@ -286,7 +288,6 @@ parameters:
 - src/Configuration/RectorConfigBuilder.php
 - src/Reporting/DeprecatedRulesReporter.php
 identifier: classConstant.deprecatedInterface
 - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace implements deprecated interface Rector\\Contract\\PhpParser\\Node\\StmtsAwareInterface#'

 # allowed internally only
 -
Expand DownExpand Up@@ -398,12 +399,6 @@ parameters:
 paths:
 - rules/Php70/Rector/If_/IfToSpaceshipRector.php

 # handles full file
 -
 paths:
 - rules/TypeDeclaration/Rector/StmtsAwareInterface/IncreaseDeclareStrictTypesRector.php
 identifier: rector.noOnlyNullReturnInRefactor

 -
 identifier: rector.noIntegerRefactorReturn
 paths:
Expand All@@ -416,22 +411,22 @@ parameters:
 # condition check, just to be sure
 - '#Method Rector\\Rector\\AbstractRector\:\:enterNode\(\) never returns 3 so it can be removed from the return type#'

 # special case, working on a file-level
 -
 identifier: rector.noOnlyNullReturnInRefactor
 path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

 # handle next with FileNode
 -
 identifier: method.parentMethodFinalByPhpDoc
 path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

 # deprecated
 -
 identifier: public.method.unused
 paths:
 - rules/Transform/ValueObject/ClassMethodReference.php
 - rules/CodeQuality/ValueObject/KeyAndExpr.php
 -
 identifier: symplify.forbiddenExtendOfNonAbstractClass
 path: src/PhpParser/Node/FileNode.php
 -
 identifier: method.deprecatedClass
 path: src/PhpParser/Node/FileNode.php

 -
 identifier: class.extendsDeprecatedClass
 path: src/PhpParser/Node/FileNode.php

 -
 identifier: public.classConstant.unused
Expand All@@ -450,8 +445,22 @@ parameters:
 - '#Register "Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector" service to "php81\.php" config set#'
 - '#Class "Rector\\CodingStyle\\Rector\\String_\\SymplifyQuoteEscapeRector" is missing @see annotation with test case class reference#'
 - '#Access to constant on deprecated class Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector#'

 # BC layer for FileWithoutNamespace node
 - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
 - '#BC layer for FileNode and FileWithoutNamespace compat, use FileNode instead#'
 -
 path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
 identifier: symplify.forbiddenExtendOfNonAbstractClass
 -
 message: '#Only abstract classes can be extended#'
 path: rules/Php81/Rector/Array_/FirstClassCallableRector.php

 - '#Method Rector\\Tests\\Issues\\FileWithoutNamespaceCompat\\Rector\\SubscribedToFileWithoutNamespaceRector\:\:refactor\(\) should return Rector\\PhpParser\\Node\\FileNode but returns Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace#'

 # BC layer for FileWithoutNamespace node
 - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
 - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace extends final class Rector\\PhpParser\\Node\\FileNode#'
 -
 path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
 identifier: symplify.forbiddenExtendOfNonAbstractClass

3 changes: 2 additions & 1 deletion
...assMethod/PrivatizeFinalClassMethodRector/Fixture/keep_magic_parent_called_method.php.inc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,12 @@
namespace Rector\Tests\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Fixture;

use PhpParser\PrettyPrinter\Standard;
use Rector\PhpParser\Node\FileNode;

final class KeepMagicParentCalledMethod extends Standard
{
 // called from parent by $this->{'p'} method
 protected function pFileNode($fileNode)
 protected function pFileNode(FileNode $fileNode)
 {
 }
}

16 changes: 9 additions & 7 deletions
rules/CodingStyle/Application/UseImportsAdder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
use Rector\CodingStyle\ClassNameImport\UsedImportsResolver;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\StaticTypeMapper\ValueObject\Type\AliasedObjectType;
use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedObjectType;

Expand All@@ -33,7 +33,7 @@ public function __construct(
 * @param array<FullyQualifiedObjectType|AliasedObjectType> $functionUseImportTypes
 */
 public function addImportsToStmts(
FileWithoutNamespace $fileWithoutNamespace,
FileNode $fileNode,
 array $stmts,
 array $useImportTypes,
 array $constantUseImportTypes,
Expand All@@ -45,10 +45,12 @@ public function addImportsToStmts(
 $existingFunctionUseImports = $usedImports->getFunctionImports();

 $useImportTypes = $this->diffFullyQualifiedObjectTypes($useImportTypes, $existingUseImportTypes);

 $constantUseImportTypes = $this->diffFullyQualifiedObjectTypes(
 $constantUseImportTypes,
 $existingConstantUseImports
 );

 $functionUseImportTypes = $this->diffFullyQualifiedObjectTypes(
 $functionUseImportTypes,
 $existingFunctionUseImports
Expand DownExpand Up@@ -90,17 +92,17 @@ public function addImportsToStmts(

 array_splice($stmts, $key + 1, 0, $nodesToAdd);

 $fileWithoutNamespace->stmts = $stmts;
 $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 $fileNode->stmts = $stmts;
 $fileNode->stmts = array_values($fileNode->stmts);

 return true;
 }

 $this->mirrorUseComments($stmts, $newUses);

 // make use stmts first
 $fileWithoutNamespace->stmts = array_merge($newUses, $this->resolveInsertNop($fileWithoutNamespace), $stmts);
 $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 $fileNode->stmts = array_merge($newUses, $this->resolveInsertNop($fileNode), $stmts);
 $fileNode->stmts = array_values($fileNode->stmts);

 return true;
 }
Expand DownExpand Up@@ -154,7 +156,7 @@ public function addImportsToNamespace(
 /**
 * @return Nop[]
 */
 private function resolveInsertNop(FileWithoutNamespace|Namespace_ $namespace): array
 private function resolveInsertNop(FileNode|Namespace_ $namespace): array
 {
 $currentStmt = $namespace->stmts[0] ?? null;
 if (! $currentStmt instanceof Stmt || $currentStmt instanceof Use_ || $currentStmt instanceof GroupUse) {
Expand Down

4 changes: 2 additions & 2 deletions
rules/CodingStyle/Application/UseImportsRemover.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@

use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\Renaming\Collector\RenamedNameCollector;

final readonly class UseImportsRemover
Expand All@@ -19,7 +19,7 @@ public function __construct(
 /**
 * @param string[] $removedUses
 */
 public function removeImportsFromStmts(FileWithoutNamespace|Namespace_ $node, array $removedUses): bool
 public function removeImportsFromStmts(FileNode|Namespace_ $node, array $removedUses): bool
 {
 $hasRemoved = false;
 foreach ($node->stmts as $key => $stmt) {
Expand Down

8 changes: 4 additions & 4 deletions
rules/CodingStyle/ClassNameImport/AliasUsesResolver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use PhpParser\Node\UseItem;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;

final readonly class AliasUsesResolver
{
Expand All@@ -25,11 +25,11 @@ public function __construct(
 */
 public function resolveFromNode(Node $node, array $stmts): array
 {
 if (! $node instanceof Namespace_ && ! $node instanceof FileWithoutNamespace) {
 /** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
 if (! $node instanceof Namespace_ && ! $node instanceof FileNode) {
 /** @var Namespace_[]|FileNode[] $namespaces */
 $namespaces = array_filter(
 $stmts,
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileNode
 );
 if (count($namespaces) !== 1) {
 return [];
Expand Down

19 changes: 5 additions & 14 deletions
rules/CodingStyle/ClassNameImport/ShortNameResolver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,6 @@
use PhpParser\Node\Name;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Namespace_;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
Expand All@@ -20,7 +19,6 @@
use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
use Rector\PhpDocParser\PhpDocParser\PhpDocNodeTraverser;
use Rector\PhpParser\Node\BetterNodeFinder;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\ValueObject\Application\File;

/**
Expand DownExpand Up@@ -65,22 +63,15 @@ public function resolveFromFile(File $file): array
 */
 public function resolveShortClassLikeNames(File $file): array
 {
 $newStmts = $file->getNewStmts();

 /** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
 $namespaces = array_filter(
 $newStmts,
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
 );
 if (count($namespaces) !== 1) {
 // only handle single namespace nodes
 $rootNode = $file->getUseImportsRootNode();

 // nothing to resolve
 if (! $rootNode instanceof Node) {
 return [];
 }

 $namespace = current($namespaces);

 /** @var ClassLike[] $classLikes */
 $classLikes = $this->betterNodeFinder->findInstanceOf($namespace->stmts, ClassLike::class);
 $classLikes = $this->betterNodeFinder->findInstanceOf($rootNode->stmts, ClassLike::class);

 $shortClassLikeNames = [];
 foreach ($classLikes as $classLike) {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Introduce FileNode to handle file-level changes by TomasVotruba · Pull Request #7728 · rectorphp/rector-src · GitHub
Skip to content
/rector-srcPublic
Introduce FileNode to handle file-level changes#7728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TomasVotruba
merged 11 commits into

from

Dec 22, 2025
 Merged


Introduce FileNode to handle file-level changes
#7728
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
90e7a01

introduce FileNode to handle file-level changes; deprecate IncreaseDe…


TomasVotruba Dec 6, 2025
e5f0f10

update use resolving


TomasVotruba Dec 6, 2025
b0e6e0f

make use of FileNode in imports


TomasVotruba Dec 6, 2025
0ac86aa

add fixture to keep protected method


TomasVotruba Dec 7, 2025
c87b73a

require rector repo updated PRs


TomasVotruba Dec 7, 2025
a9a7b2e

add FileNode upgrade to UPGRADING


TomasVotruba Dec 7, 2025
2dde27e

[ci] add job to check laravel rector with latest dev-main build


TomasVotruba Dec 7, 2025
da7fdb5

add node matching support for FileWithoutNamespace


TomasVotruba Dec 22, 2025
65c921e

warn about deprecated type


TomasVotruba Dec 22, 2025
fbd4e4c

print stmts with false


TomasVotruba Dec 22, 2025
ff771b0

[docs] add specific example how to iterate stmts of namespaced and no…


TomasVotruba Dec 22, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.github/workflows/code_analysis.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ jobs:

 -
 name: 'Finalize classes'
 run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run
 run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run --skip-file="src/PhpParser/Node/FileNode.php"

 -
 name: 'Check before/after test fixture on no-changes'
Expand Down

1 change: 1 addition & 0 deletions
.github/workflows/rector_laravel_rector_dev.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,3 +28,4 @@ jobs:
 - run: git clone https://github.com/driftingly/rector-laravel.git
 - run: composer require rector/rector:dev-main --working-dir rector-laravel
 - run: cd rector-laravel && vendor/bin/phpunit


107 changes: 107 additions & 0 deletions
UPGRADING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,110 @@
# Upgrading from Rector 2.2.14 to 2.3

* `FileWithoutNamespace` is deprecated, and replaced by `FileNode` that represents both namespaced and non-namespaced files and allow changes inside
* `beforeTraverse()` is now marked as `@final`, use `getNodeTypes()` with `FileNode::class` instead

**Before**

```php
use Rector\PhpParser\Node\FileWithoutNamespace;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileWithoutNamespace::class];
 }

 public function beforeTraverse(array $nodes): array
 {
 // some node hacking
 }

 /**
 * @param FileWithoutNamespace $node
 */
 public function refactor(Node $node): ?Node
 {
 // ...
 }

}
```

**After**

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileNode::class];
 }

 /**
 * @param FileNode $node
 */
 public function refactor(Node $node): ?Node
 {
 foreach ($node->stmts as $stmt) {
 // check if has declare_strict already?
 // ...

 // create it
 $declareStrictTypes = $this->createDeclareStrictTypesNode();

 // add it
 $node->stmts = array_merge([$declareStrictTypes], $node->stmts);
 }

 return $node;
 }

}
```

<br>

The `FileNode` handles both namespaced and non-namespaced files. To handle the first stmts inside the file, you hook into 2 nodes:

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;
use PhpParser\Node\Stmt\Namespace_;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileNode::class, Namespace_::class];
 }

 /**
 * @param FileNode|Namespace_ $node
 */
 public function refactor(Node $node): ?Node
 {
 if ($node instanceof FileNode && $node->isNamespaced()) {
 // handled in the Namespace_ node
 return null;
 }

 foreach ($node->stmts as $stmt) {
 // modify stmts in desired way here
 }

 return $node;
 }

}
```

<br>

# Upgrading from Rector 1.x to 2.0

## PHP version requirements
Expand Down

2 changes: 0 additions & 2 deletions
composer-dependency-analyser.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@
 // ensure use version ^3.2.0
 ->ignoreErrorsOnPackage('composer/pcre', [ErrorType::UNUSED_DEPENDENCY])

 ->ignoreErrorsOnPath(__DIR__ . '/src/Reporting/DeprecatedRulesReporter.php', [ErrorType::UNKNOWN_CLASS])

 ->ignoreErrorsOnPaths([
 __DIR__ . '/stubs',
 __DIR__ . '/tests',
Expand Down

49 changes: 29 additions & 20 deletions
phpstan.neon

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ parameters:

 # see https://phpstan.org/writing-php-code/phpdoc-types#global-type-aliases
 typeAliases:
 StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\CustomNode\FileWithoutNamespace
 StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\FileNode

 # requires exact closure types
 checkMissingCallableSignature: true
Expand DownExpand Up@@ -189,8 +189,10 @@ parameters:
 message: '#Method Rector\\Util\\ArrayParametersMerger\:\:mergeLeftToRightWithCallable\(\) has parameter \$mergeCallback with no signature specified for callable#'
 path: src/Util/ArrayParametersMerger.php

 # fixture class
 - '#Class "Rector\\Tests\\Issues\\ScopeNotAvailable\\Variable\\ArrayItemForeachValueRector" is missing @see annotation with test case class reference#'
 # fixture Rector rules
 -
 identifier: symplify.seeAnnotationToTest
 path: tests/Issues/

 # classes are part of *.php.inc fixture
 -
Expand DownExpand Up@@ -286,7 +288,6 @@ parameters:
 - src/Configuration/RectorConfigBuilder.php
 - src/Reporting/DeprecatedRulesReporter.php
 identifier: classConstant.deprecatedInterface
 - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace implements deprecated interface Rector\\Contract\\PhpParser\\Node\\StmtsAwareInterface#'

 # allowed internally only
 -
Expand DownExpand Up@@ -398,12 +399,6 @@ parameters:
 paths:
 - rules/Php70/Rector/If_/IfToSpaceshipRector.php

 # handles full file
 -
 paths:
 - rules/TypeDeclaration/Rector/StmtsAwareInterface/IncreaseDeclareStrictTypesRector.php
 identifier: rector.noOnlyNullReturnInRefactor

 -
 identifier: rector.noIntegerRefactorReturn
 paths:
Expand All@@ -416,22 +411,22 @@ parameters:
 # condition check, just to be sure
 - '#Method Rector\\Rector\\AbstractRector\:\:enterNode\(\) never returns 3 so it can be removed from the return type#'

 # special case, working on a file-level
 -
 identifier: rector.noOnlyNullReturnInRefactor
 path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

 # handle next with FileNode
 -
 identifier: method.parentMethodFinalByPhpDoc
 path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

 # deprecated
 -
 identifier: public.method.unused
 paths:
 - rules/Transform/ValueObject/ClassMethodReference.php
 - rules/CodeQuality/ValueObject/KeyAndExpr.php
 -
 identifier: symplify.forbiddenExtendOfNonAbstractClass
 path: src/PhpParser/Node/FileNode.php
 -
 identifier: method.deprecatedClass
 path: src/PhpParser/Node/FileNode.php

 -
 identifier: class.extendsDeprecatedClass
 path: src/PhpParser/Node/FileNode.php

 -
 identifier: public.classConstant.unused
Expand All@@ -450,8 +445,22 @@ parameters:
 - '#Register "Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector" service to "php81\.php" config set#'
 - '#Class "Rector\\CodingStyle\\Rector\\String_\\SymplifyQuoteEscapeRector" is missing @see annotation with test case class reference#'
 - '#Access to constant on deprecated class Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector#'

 # BC layer for FileWithoutNamespace node
 - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
 - '#BC layer for FileNode and FileWithoutNamespace compat, use FileNode instead#'
 -
 path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
 identifier: symplify.forbiddenExtendOfNonAbstractClass
 -
 message: '#Only abstract classes can be extended#'
 path: rules/Php81/Rector/Array_/FirstClassCallableRector.php

 - '#Method Rector\\Tests\\Issues\\FileWithoutNamespaceCompat\\Rector\\SubscribedToFileWithoutNamespaceRector\:\:refactor\(\) should return Rector\\PhpParser\\Node\\FileNode but returns Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace#'

 # BC layer for FileWithoutNamespace node
 - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
 - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace extends final class Rector\\PhpParser\\Node\\FileNode#'
 -
 path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
 identifier: symplify.forbiddenExtendOfNonAbstractClass

3 changes: 2 additions & 1 deletion
...assMethod/PrivatizeFinalClassMethodRector/Fixture/keep_magic_parent_called_method.php.inc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,12 @@
namespace Rector\Tests\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Fixture;

use PhpParser\PrettyPrinter\Standard;
use Rector\PhpParser\Node\FileNode;

final class KeepMagicParentCalledMethod extends Standard
{
 // called from parent by $this->{'p'} method
 protected function pFileNode($fileNode)
 protected function pFileNode(FileNode $fileNode)
 {
 }
}

16 changes: 9 additions & 7 deletions
rules/CodingStyle/Application/UseImportsAdder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
use Rector\CodingStyle\ClassNameImport\UsedImportsResolver;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\StaticTypeMapper\ValueObject\Type\AliasedObjectType;
use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedObjectType;

Expand All@@ -33,7 +33,7 @@ public function __construct(
 * @param array<FullyQualifiedObjectType|AliasedObjectType> $functionUseImportTypes
 */
 public function addImportsToStmts(
FileWithoutNamespace $fileWithoutNamespace,
FileNode $fileNode,
 array $stmts,
 array $useImportTypes,
 array $constantUseImportTypes,
Expand All@@ -45,10 +45,12 @@ public function addImportsToStmts(
 $existingFunctionUseImports = $usedImports->getFunctionImports();

 $useImportTypes = $this->diffFullyQualifiedObjectTypes($useImportTypes, $existingUseImportTypes);

 $constantUseImportTypes = $this->diffFullyQualifiedObjectTypes(
 $constantUseImportTypes,
 $existingConstantUseImports
 );

 $functionUseImportTypes = $this->diffFullyQualifiedObjectTypes(
 $functionUseImportTypes,
 $existingFunctionUseImports
Expand DownExpand Up@@ -90,17 +92,17 @@ public function addImportsToStmts(

 array_splice($stmts, $key + 1, 0, $nodesToAdd);

 $fileWithoutNamespace->stmts = $stmts;
 $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 $fileNode->stmts = $stmts;
 $fileNode->stmts = array_values($fileNode->stmts);

 return true;
 }

 $this->mirrorUseComments($stmts, $newUses);

 // make use stmts first
 $fileWithoutNamespace->stmts = array_merge($newUses, $this->resolveInsertNop($fileWithoutNamespace), $stmts);
 $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 $fileNode->stmts = array_merge($newUses, $this->resolveInsertNop($fileNode), $stmts);
 $fileNode->stmts = array_values($fileNode->stmts);

 return true;
 }
Expand DownExpand Up@@ -154,7 +156,7 @@ public function addImportsToNamespace(
 /**
 * @return Nop[]
 */
 private function resolveInsertNop(FileWithoutNamespace|Namespace_ $namespace): array
 private function resolveInsertNop(FileNode|Namespace_ $namespace): array
 {
 $currentStmt = $namespace->stmts[0] ?? null;
 if (! $currentStmt instanceof Stmt || $currentStmt instanceof Use_ || $currentStmt instanceof GroupUse) {
Expand Down

4 changes: 2 additions & 2 deletions
rules/CodingStyle/Application/UseImportsRemover.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@

use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\Renaming\Collector\RenamedNameCollector;

final readonly class UseImportsRemover
Expand All@@ -19,7 +19,7 @@ public function __construct(
 /**
 * @param string[] $removedUses
 */
 public function removeImportsFromStmts(FileWithoutNamespace|Namespace_ $node, array $removedUses): bool
 public function removeImportsFromStmts(FileNode|Namespace_ $node, array $removedUses): bool
 {
 $hasRemoved = false;
 foreach ($node->stmts as $key => $stmt) {
Expand Down

8 changes: 4 additions & 4 deletions
rules/CodingStyle/ClassNameImport/AliasUsesResolver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use PhpParser\Node\UseItem;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;

final readonly class AliasUsesResolver
{
Expand All@@ -25,11 +25,11 @@ public function __construct(
 */
 public function resolveFromNode(Node $node, array $stmts): array
 {
 if (! $node instanceof Namespace_ && ! $node instanceof FileWithoutNamespace) {
 /** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
 if (! $node instanceof Namespace_ && ! $node instanceof FileNode) {
 /** @var Namespace_[]|FileNode[] $namespaces */
 $namespaces = array_filter(
 $stmts,
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileNode
 );
 if (count($namespaces) !== 1) {
 return [];
Expand Down

19 changes: 5 additions & 14 deletions
rules/CodingStyle/ClassNameImport/ShortNameResolver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,6 @@
use PhpParser\Node\Name;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Namespace_;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
Expand All@@ -20,7 +19,6 @@
use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
use Rector\PhpDocParser\PhpDocParser\PhpDocNodeTraverser;
use Rector\PhpParser\Node\BetterNodeFinder;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\ValueObject\Application\File;

/**
Expand DownExpand Up@@ -65,22 +63,15 @@ public function resolveFromFile(File $file): array
 */
 public function resolveShortClassLikeNames(File $file): array
 {
 $newStmts = $file->getNewStmts();

 /** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
 $namespaces = array_filter(
 $newStmts,
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
 );
 if (count($namespaces) !== 1) {
 // only handle single namespace nodes
 $rootNode = $file->getUseImportsRootNode();

 // nothing to resolve
 if (! $rootNode instanceof Node) {
 return [];
 }

 $namespace = current($namespaces);

 /** @var ClassLike[] $classLikes */
 $classLikes = $this->betterNodeFinder->findInstanceOf($namespace->stmts, ClassLike::class);
 $classLikes = $this->betterNodeFinder->findInstanceOf($rootNode->stmts, ClassLike::class);

 $shortClassLikeNames = [];
 foreach ($classLikes as $classLike) {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Introduce FileNode to handle file-level changes by TomasVotruba · Pull Request #7728 · rectorphp/rector-src · GitHub
Skip to content
/rector-srcPublic
Introduce FileNode to handle file-level changes#7728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TomasVotruba
merged 11 commits into

from

Dec 22, 2025
 Merged


Introduce FileNode to handle file-level changes
#7728
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
90e7a01

introduce FileNode to handle file-level changes; deprecate IncreaseDe…


TomasVotruba Dec 6, 2025
e5f0f10

update use resolving


TomasVotruba Dec 6, 2025
b0e6e0f

make use of FileNode in imports


TomasVotruba Dec 6, 2025
0ac86aa

add fixture to keep protected method


TomasVotruba Dec 7, 2025
c87b73a

require rector repo updated PRs


TomasVotruba Dec 7, 2025
a9a7b2e

add FileNode upgrade to UPGRADING


TomasVotruba Dec 7, 2025
2dde27e

[ci] add job to check laravel rector with latest dev-main build


TomasVotruba Dec 7, 2025
da7fdb5

add node matching support for FileWithoutNamespace


TomasVotruba Dec 22, 2025
65c921e

warn about deprecated type


TomasVotruba Dec 22, 2025
fbd4e4c

print stmts with false


TomasVotruba Dec 22, 2025
ff771b0

[docs] add specific example how to iterate stmts of namespaced and no…


TomasVotruba Dec 22, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.github/workflows/code_analysis.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ jobs:

 -
 name: 'Finalize classes'
 run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run
 run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run --skip-file="src/PhpParser/Node/FileNode.php"

 -
 name: 'Check before/after test fixture on no-changes'
Expand Down

1 change: 1 addition & 0 deletions
.github/workflows/rector_laravel_rector_dev.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,3 +28,4 @@ jobs:
 - run: git clone https://github.com/driftingly/rector-laravel.git
 - run: composer require rector/rector:dev-main --working-dir rector-laravel
 - run: cd rector-laravel && vendor/bin/phpunit


107 changes: 107 additions & 0 deletions
UPGRADING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,110 @@
# Upgrading from Rector 2.2.14 to 2.3

* `FileWithoutNamespace` is deprecated, and replaced by `FileNode` that represents both namespaced and non-namespaced files and allow changes inside
* `beforeTraverse()` is now marked as `@final`, use `getNodeTypes()` with `FileNode::class` instead

**Before**

```php
use Rector\PhpParser\Node\FileWithoutNamespace;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileWithoutNamespace::class];
 }

 public function beforeTraverse(array $nodes): array
 {
 // some node hacking
 }

 /**
 * @param FileWithoutNamespace $node
 */
 public function refactor(Node $node): ?Node
 {
 // ...
 }

}
```

**After**

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileNode::class];
 }

 /**
 * @param FileNode $node
 */
 public function refactor(Node $node): ?Node
 {
 foreach ($node->stmts as $stmt) {
 // check if has declare_strict already?
 // ...

 // create it
 $declareStrictTypes = $this->createDeclareStrictTypesNode();

 // add it
 $node->stmts = array_merge([$declareStrictTypes], $node->stmts);
 }

 return $node;
 }

}
```

<br>

The `FileNode` handles both namespaced and non-namespaced files. To handle the first stmts inside the file, you hook into 2 nodes:

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;
use PhpParser\Node\Stmt\Namespace_;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileNode::class, Namespace_::class];
 }

 /**
 * @param FileNode|Namespace_ $node
 */
 public function refactor(Node $node): ?Node
 {
 if ($node instanceof FileNode && $node->isNamespaced()) {
 // handled in the Namespace_ node
 return null;
 }

 foreach ($node->stmts as $stmt) {
 // modify stmts in desired way here
 }

 return $node;
 }

}
```

<br>

# Upgrading from Rector 1.x to 2.0

## PHP version requirements
Expand Down

2 changes: 0 additions & 2 deletions
composer-dependency-analyser.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@
 // ensure use version ^3.2.0
 ->ignoreErrorsOnPackage('composer/pcre', [ErrorType::UNUSED_DEPENDENCY])

 ->ignoreErrorsOnPath(__DIR__ . '/src/Reporting/DeprecatedRulesReporter.php', [ErrorType::UNKNOWN_CLASS])

 ->ignoreErrorsOnPaths([
 __DIR__ . '/stubs',
 __DIR__ . '/tests',
Expand Down

49 changes: 29 additions & 20 deletions
phpstan.neon

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ parameters:

 # see https://phpstan.org/writing-php-code/phpdoc-types#global-type-aliases
 typeAliases:
 StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\CustomNode\FileWithoutNamespace
 StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\FileNode

 # requires exact closure types
 checkMissingCallableSignature: true
Expand DownExpand Up@@ -189,8 +189,10 @@ parameters:
 message: '#Method Rector\\Util\\ArrayParametersMerger\:\:mergeLeftToRightWithCallable\(\) has parameter \$mergeCallback with no signature specified for callable#'
 path: src/Util/ArrayParametersMerger.php

 # fixture class
 - '#Class "Rector\\Tests\\Issues\\ScopeNotAvailable\\Variable\\ArrayItemForeachValueRector" is missing @see annotation with test case class reference#'
 # fixture Rector rules
 -
 identifier: symplify.seeAnnotationToTest
 path: tests/Issues/

 # classes are part of *.php.inc fixture
 -
Expand DownExpand Up@@ -286,7 +288,6 @@ parameters:
 - src/Configuration/RectorConfigBuilder.php
 - src/Reporting/DeprecatedRulesReporter.php
 identifier: classConstant.deprecatedInterface
 - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace implements deprecated interface Rector\\Contract\\PhpParser\\Node\\StmtsAwareInterface#'

 # allowed internally only
 -
Expand DownExpand Up@@ -398,12 +399,6 @@ parameters:
 paths:
 - rules/Php70/Rector/If_/IfToSpaceshipRector.php

 # handles full file
 -
 paths:
 - rules/TypeDeclaration/Rector/StmtsAwareInterface/IncreaseDeclareStrictTypesRector.php
 identifier: rector.noOnlyNullReturnInRefactor

 -
 identifier: rector.noIntegerRefactorReturn
 paths:
Expand All@@ -416,22 +411,22 @@ parameters:
 # condition check, just to be sure
 - '#Method Rector\\Rector\\AbstractRector\:\:enterNode\(\) never returns 3 so it can be removed from the return type#'

 # special case, working on a file-level
 -
 identifier: rector.noOnlyNullReturnInRefactor
 path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

 # handle next with FileNode
 -
 identifier: method.parentMethodFinalByPhpDoc
 path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

 # deprecated
 -
 identifier: public.method.unused
 paths:
 - rules/Transform/ValueObject/ClassMethodReference.php
 - rules/CodeQuality/ValueObject/KeyAndExpr.php
 -
 identifier: symplify.forbiddenExtendOfNonAbstractClass
 path: src/PhpParser/Node/FileNode.php
 -
 identifier: method.deprecatedClass
 path: src/PhpParser/Node/FileNode.php

 -
 identifier: class.extendsDeprecatedClass
 path: src/PhpParser/Node/FileNode.php

 -
 identifier: public.classConstant.unused
Expand All@@ -450,8 +445,22 @@ parameters:
 - '#Register "Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector" service to "php81\.php" config set#'
 - '#Class "Rector\\CodingStyle\\Rector\\String_\\SymplifyQuoteEscapeRector" is missing @see annotation with test case class reference#'
 - '#Access to constant on deprecated class Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector#'

 # BC layer for FileWithoutNamespace node
 - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
 - '#BC layer for FileNode and FileWithoutNamespace compat, use FileNode instead#'
 -
 path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
 identifier: symplify.forbiddenExtendOfNonAbstractClass
 -
 message: '#Only abstract classes can be extended#'
 path: rules/Php81/Rector/Array_/FirstClassCallableRector.php

 - '#Method Rector\\Tests\\Issues\\FileWithoutNamespaceCompat\\Rector\\SubscribedToFileWithoutNamespaceRector\:\:refactor\(\) should return Rector\\PhpParser\\Node\\FileNode but returns Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace#'

 # BC layer for FileWithoutNamespace node
 - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
 - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace extends final class Rector\\PhpParser\\Node\\FileNode#'
 -
 path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
 identifier: symplify.forbiddenExtendOfNonAbstractClass

3 changes: 2 additions & 1 deletion
...assMethod/PrivatizeFinalClassMethodRector/Fixture/keep_magic_parent_called_method.php.inc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,12 @@
namespace Rector\Tests\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Fixture;

use PhpParser\PrettyPrinter\Standard;
use Rector\PhpParser\Node\FileNode;

final class KeepMagicParentCalledMethod extends Standard
{
 // called from parent by $this->{'p'} method
 protected function pFileNode($fileNode)
 protected function pFileNode(FileNode $fileNode)
 {
 }
}

16 changes: 9 additions & 7 deletions
rules/CodingStyle/Application/UseImportsAdder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
use Rector\CodingStyle\ClassNameImport\UsedImportsResolver;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\StaticTypeMapper\ValueObject\Type\AliasedObjectType;
use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedObjectType;

Expand All@@ -33,7 +33,7 @@ public function __construct(
 * @param array<FullyQualifiedObjectType|AliasedObjectType> $functionUseImportTypes
 */
 public function addImportsToStmts(
FileWithoutNamespace $fileWithoutNamespace,
FileNode $fileNode,
 array $stmts,
 array $useImportTypes,
 array $constantUseImportTypes,
Expand All@@ -45,10 +45,12 @@ public function addImportsToStmts(
 $existingFunctionUseImports = $usedImports->getFunctionImports();

 $useImportTypes = $this->diffFullyQualifiedObjectTypes($useImportTypes, $existingUseImportTypes);

 $constantUseImportTypes = $this->diffFullyQualifiedObjectTypes(
 $constantUseImportTypes,
 $existingConstantUseImports
 );

 $functionUseImportTypes = $this->diffFullyQualifiedObjectTypes(
 $functionUseImportTypes,
 $existingFunctionUseImports
Expand DownExpand Up@@ -90,17 +92,17 @@ public function addImportsToStmts(

 array_splice($stmts, $key + 1, 0, $nodesToAdd);

 $fileWithoutNamespace->stmts = $stmts;
 $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 $fileNode->stmts = $stmts;
 $fileNode->stmts = array_values($fileNode->stmts);

 return true;
 }

 $this->mirrorUseComments($stmts, $newUses);

 // make use stmts first
 $fileWithoutNamespace->stmts = array_merge($newUses, $this->resolveInsertNop($fileWithoutNamespace), $stmts);
 $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 $fileNode->stmts = array_merge($newUses, $this->resolveInsertNop($fileNode), $stmts);
 $fileNode->stmts = array_values($fileNode->stmts);

 return true;
 }
Expand DownExpand Up@@ -154,7 +156,7 @@ public function addImportsToNamespace(
 /**
 * @return Nop[]
 */
 private function resolveInsertNop(FileWithoutNamespace|Namespace_ $namespace): array
 private function resolveInsertNop(FileNode|Namespace_ $namespace): array
 {
 $currentStmt = $namespace->stmts[0] ?? null;
 if (! $currentStmt instanceof Stmt || $currentStmt instanceof Use_ || $currentStmt instanceof GroupUse) {
Expand Down

4 changes: 2 additions & 2 deletions
rules/CodingStyle/Application/UseImportsRemover.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@

use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\Renaming\Collector\RenamedNameCollector;

final readonly class UseImportsRemover
Expand All@@ -19,7 +19,7 @@ public function __construct(
 /**
 * @param string[] $removedUses
 */
 public function removeImportsFromStmts(FileWithoutNamespace|Namespace_ $node, array $removedUses): bool
 public function removeImportsFromStmts(FileNode|Namespace_ $node, array $removedUses): bool
 {
 $hasRemoved = false;
 foreach ($node->stmts as $key => $stmt) {
Expand Down

8 changes: 4 additions & 4 deletions
rules/CodingStyle/ClassNameImport/AliasUsesResolver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use PhpParser\Node\UseItem;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;

final readonly class AliasUsesResolver
{
Expand All@@ -25,11 +25,11 @@ public function __construct(
 */
 public function resolveFromNode(Node $node, array $stmts): array
 {
 if (! $node instanceof Namespace_ && ! $node instanceof FileWithoutNamespace) {
 /** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
 if (! $node instanceof Namespace_ && ! $node instanceof FileNode) {
 /** @var Namespace_[]|FileNode[] $namespaces */
 $namespaces = array_filter(
 $stmts,
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileNode
 );
 if (count($namespaces) !== 1) {
 return [];
Expand Down

19 changes: 5 additions & 14 deletions
rules/CodingStyle/ClassNameImport/ShortNameResolver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,6 @@
use PhpParser\Node\Name;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Namespace_;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
Expand All@@ -20,7 +19,6 @@
use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
use Rector\PhpDocParser\PhpDocParser\PhpDocNodeTraverser;
use Rector\PhpParser\Node\BetterNodeFinder;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\ValueObject\Application\File;

/**
Expand DownExpand Up@@ -65,22 +63,15 @@ public function resolveFromFile(File $file): array
 */
 public function resolveShortClassLikeNames(File $file): array
 {
 $newStmts = $file->getNewStmts();

 /** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
 $namespaces = array_filter(
 $newStmts,
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
 );
 if (count($namespaces) !== 1) {
 // only handle single namespace nodes
 $rootNode = $file->getUseImportsRootNode();

 // nothing to resolve
 if (! $rootNode instanceof Node) {
 return [];
 }

 $namespace = current($namespaces);

 /** @var ClassLike[] $classLikes */
 $classLikes = $this->betterNodeFinder->findInstanceOf($namespace->stmts, ClassLike::class);
 $classLikes = $this->betterNodeFinder->findInstanceOf($rootNode->stmts, ClassLike::class);

 $shortClassLikeNames = [];
 foreach ($classLikes as $classLike) {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Introduce FileNode to handle file-level changes by TomasVotruba · Pull Request #7728 · rectorphp/rector-src · GitHub
Skip to content
/rector-srcPublic
Introduce FileNode to handle file-level changes#7728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

TomasVotruba
merged 11 commits into

from

Dec 22, 2025
 Merged


Introduce FileNode to handle file-level changes
#7728
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
90e7a01

introduce FileNode to handle file-level changes; deprecate IncreaseDe…


TomasVotruba Dec 6, 2025
e5f0f10

update use resolving


TomasVotruba Dec 6, 2025
b0e6e0f

make use of FileNode in imports


TomasVotruba Dec 6, 2025
0ac86aa

add fixture to keep protected method


TomasVotruba Dec 7, 2025
c87b73a

require rector repo updated PRs


TomasVotruba Dec 7, 2025
a9a7b2e

add FileNode upgrade to UPGRADING


TomasVotruba Dec 7, 2025
2dde27e

[ci] add job to check laravel rector with latest dev-main build


TomasVotruba Dec 7, 2025
da7fdb5

add node matching support for FileWithoutNamespace


TomasVotruba Dec 22, 2025
65c921e

warn about deprecated type


TomasVotruba Dec 22, 2025
fbd4e4c

print stmts with false


TomasVotruba Dec 22, 2025
ff771b0

[docs] add specific example how to iterate stmts of namespaced and no…


TomasVotruba Dec 22, 2025

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
.github/workflows/code_analysis.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ jobs:

 -
 name: 'Finalize classes'
 run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run
 run: vendor/bin/swiss-knife finalize-classes src tests rules --dry-run --skip-file="src/PhpParser/Node/FileNode.php"

 -
 name: 'Check before/after test fixture on no-changes'
Expand Down

1 change: 1 addition & 0 deletions
.github/workflows/rector_laravel_rector_dev.yaml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,3 +28,4 @@ jobs:
 - run: git clone https://github.com/driftingly/rector-laravel.git
 - run: composer require rector/rector:dev-main --working-dir rector-laravel
 - run: cd rector-laravel && vendor/bin/phpunit


107 changes: 107 additions & 0 deletions
UPGRADING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,110 @@
# Upgrading from Rector 2.2.14 to 2.3

* `FileWithoutNamespace` is deprecated, and replaced by `FileNode` that represents both namespaced and non-namespaced files and allow changes inside
* `beforeTraverse()` is now marked as `@final`, use `getNodeTypes()` with `FileNode::class` instead

**Before**

```php
use Rector\PhpParser\Node\FileWithoutNamespace;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileWithoutNamespace::class];
 }

 public function beforeTraverse(array $nodes): array
 {
 // some node hacking
 }

 /**
 * @param FileWithoutNamespace $node
 */
 public function refactor(Node $node): ?Node
 {
 // ...
 }

}
```

**After**

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileNode::class];
 }

 /**
 * @param FileNode $node
 */
 public function refactor(Node $node): ?Node
 {
 foreach ($node->stmts as $stmt) {
 // check if has declare_strict already?
 // ...

 // create it
 $declareStrictTypes = $this->createDeclareStrictTypesNode();

 // add it
 $node->stmts = array_merge([$declareStrictTypes], $node->stmts);
 }

 return $node;
 }

}
```

<br>

The `FileNode` handles both namespaced and non-namespaced files. To handle the first stmts inside the file, you hook into 2 nodes:

```php
use Rector\PhpParser\Node\FileNode;
use Rector\Rector\AbstractRector;
use PhpParser\Node\Stmt\Namespace_;

final class SomeRector extends AbstractRector
{
 public function getNodeTypes(): array
 {
 return [FileNode::class, Namespace_::class];
 }

 /**
 * @param FileNode|Namespace_ $node
 */
 public function refactor(Node $node): ?Node
 {
 if ($node instanceof FileNode && $node->isNamespaced()) {
 // handled in the Namespace_ node
 return null;
 }

 foreach ($node->stmts as $stmt) {
 // modify stmts in desired way here
 }

 return $node;
 }

}
```

<br>

# Upgrading from Rector 1.x to 2.0

## PHP version requirements
Expand Down

2 changes: 0 additions & 2 deletions
composer-dependency-analyser.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@
 // ensure use version ^3.2.0
 ->ignoreErrorsOnPackage('composer/pcre', [ErrorType::UNUSED_DEPENDENCY])

 ->ignoreErrorsOnPath(__DIR__ . '/src/Reporting/DeprecatedRulesReporter.php', [ErrorType::UNKNOWN_CLASS])

 ->ignoreErrorsOnPaths([
 __DIR__ . '/stubs',
 __DIR__ . '/tests',
Expand Down

49 changes: 29 additions & 20 deletions
phpstan.neon

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ parameters:

 # see https://phpstan.org/writing-php-code/phpdoc-types#global-type-aliases
 typeAliases:
 StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\CustomNode\FileWithoutNamespace
 StmtsAware: \PhpParser\Node\Stmt\Block | \PhpParser\Node\Expr\Closure | \PhpParser\Node\Stmt\Case_ | \PhpParser\Node\Stmt\Catch_ | \PhpParser\Node\Stmt\ClassMethod | \PhpParser\Node\Stmt\Do_ | \PhpParser\Node\Stmt\Else_ | \PhpParser\Node\Stmt\ElseIf_ | \PhpParser\Node\Stmt\Finally_ | \PhpParser\Node\Stmt\For_ | \PhpParser\Node\Stmt\Foreach_ | \PhpParser\Node\Stmt\Function_ | \PhpParser\Node\Stmt\If_ | \PhpParser\Node\Stmt\Namespace_ | \PhpParser\Node\Stmt\TryCatch | \PhpParser\Node\Stmt\While_ | \Rector\PhpParser\Node\FileNode

 # requires exact closure types
 checkMissingCallableSignature: true
Expand DownExpand Up@@ -189,8 +189,10 @@ parameters:
 message: '#Method Rector\\Util\\ArrayParametersMerger\:\:mergeLeftToRightWithCallable\(\) has parameter \$mergeCallback with no signature specified for callable#'
 path: src/Util/ArrayParametersMerger.php

 # fixture class
 - '#Class "Rector\\Tests\\Issues\\ScopeNotAvailable\\Variable\\ArrayItemForeachValueRector" is missing @see annotation with test case class reference#'
 # fixture Rector rules
 -
 identifier: symplify.seeAnnotationToTest
 path: tests/Issues/

 # classes are part of *.php.inc fixture
 -
Expand DownExpand Up@@ -286,7 +288,6 @@ parameters:
 - src/Configuration/RectorConfigBuilder.php
 - src/Reporting/DeprecatedRulesReporter.php
 identifier: classConstant.deprecatedInterface
 - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace implements deprecated interface Rector\\Contract\\PhpParser\\Node\\StmtsAwareInterface#'

 # allowed internally only
 -
Expand DownExpand Up@@ -398,12 +399,6 @@ parameters:
 paths:
 - rules/Php70/Rector/If_/IfToSpaceshipRector.php

 # handles full file
 -
 paths:
 - rules/TypeDeclaration/Rector/StmtsAwareInterface/IncreaseDeclareStrictTypesRector.php
 identifier: rector.noOnlyNullReturnInRefactor

 -
 identifier: rector.noIntegerRefactorReturn
 paths:
Expand All@@ -416,22 +411,22 @@ parameters:
 # condition check, just to be sure
 - '#Method Rector\\Rector\\AbstractRector\:\:enterNode\(\) never returns 3 so it can be removed from the return type#'

 # special case, working on a file-level
 -
 identifier: rector.noOnlyNullReturnInRefactor
 path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

 # handle next with FileNode
 -
 identifier: method.parentMethodFinalByPhpDoc
 path: rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php

 # deprecated
 -
 identifier: public.method.unused
 paths:
 - rules/Transform/ValueObject/ClassMethodReference.php
 - rules/CodeQuality/ValueObject/KeyAndExpr.php
 -
 identifier: symplify.forbiddenExtendOfNonAbstractClass
 path: src/PhpParser/Node/FileNode.php
 -
 identifier: method.deprecatedClass
 path: src/PhpParser/Node/FileNode.php

 -
 identifier: class.extendsDeprecatedClass
 path: src/PhpParser/Node/FileNode.php

 -
 identifier: public.classConstant.unused
Expand All@@ -450,8 +445,22 @@ parameters:
 - '#Register "Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector" service to "php81\.php" config set#'
 - '#Class "Rector\\CodingStyle\\Rector\\String_\\SymplifyQuoteEscapeRector" is missing @see annotation with test case class reference#'
 - '#Access to constant on deprecated class Rector\\Php81\\Rector\\Array_\\FirstClassCallableRector#'

 # BC layer for FileWithoutNamespace node
 - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
 - '#BC layer for FileNode and FileWithoutNamespace compat, use FileNode instead#'
 -
 path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
 identifier: symplify.forbiddenExtendOfNonAbstractClass
 -
 message: '#Only abstract classes can be extended#'
 path: rules/Php81/Rector/Array_/FirstClassCallableRector.php

 - '#Method Rector\\Tests\\Issues\\FileWithoutNamespaceCompat\\Rector\\SubscribedToFileWithoutNamespaceRector\:\:refactor\(\) should return Rector\\PhpParser\\Node\\FileNode but returns Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace#'

 # BC layer for FileWithoutNamespace node
 - message: '#Use @see \\Rector\\PhpParser\\Node\\FileNode instead#'
 - '#Class Rector\\PhpParser\\Node\\CustomNode\\FileWithoutNamespace extends final class Rector\\PhpParser\\Node\\FileNode#'
 -
 path: src/PhpParser/Node/CustomNode/FileWithoutNamespace.php
 identifier: symplify.forbiddenExtendOfNonAbstractClass

3 changes: 2 additions & 1 deletion
...assMethod/PrivatizeFinalClassMethodRector/Fixture/keep_magic_parent_called_method.php.inc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,11 +3,12 @@
namespace Rector\Tests\Privatization\Rector\ClassMethod\PrivatizeFinalClassMethodRector\Fixture;

use PhpParser\PrettyPrinter\Standard;
use Rector\PhpParser\Node\FileNode;

final class KeepMagicParentCalledMethod extends Standard
{
 // called from parent by $this->{'p'} method
 protected function pFileNode($fileNode)
 protected function pFileNode(FileNode $fileNode)
 {
 }
}

16 changes: 9 additions & 7 deletions
rules/CodingStyle/Application/UseImportsAdder.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,7 +14,7 @@
use Rector\CodingStyle\ClassNameImport\UsedImportsResolver;
use Rector\NodeTypeResolver\Node\AttributeKey;
use Rector\NodeTypeResolver\PHPStan\Type\TypeFactory;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\StaticTypeMapper\ValueObject\Type\AliasedObjectType;
use Rector\StaticTypeMapper\ValueObject\Type\FullyQualifiedObjectType;

Expand All@@ -33,7 +33,7 @@ public function __construct(
 * @param array<FullyQualifiedObjectType|AliasedObjectType> $functionUseImportTypes
 */
 public function addImportsToStmts(
FileWithoutNamespace $fileWithoutNamespace,
FileNode $fileNode,
 array $stmts,
 array $useImportTypes,
 array $constantUseImportTypes,
Expand All@@ -45,10 +45,12 @@ public function addImportsToStmts(
 $existingFunctionUseImports = $usedImports->getFunctionImports();

 $useImportTypes = $this->diffFullyQualifiedObjectTypes($useImportTypes, $existingUseImportTypes);

 $constantUseImportTypes = $this->diffFullyQualifiedObjectTypes(
 $constantUseImportTypes,
 $existingConstantUseImports
 );

 $functionUseImportTypes = $this->diffFullyQualifiedObjectTypes(
 $functionUseImportTypes,
 $existingFunctionUseImports
Expand DownExpand Up@@ -90,17 +92,17 @@ public function addImportsToStmts(

 array_splice($stmts, $key + 1, 0, $nodesToAdd);

 $fileWithoutNamespace->stmts = $stmts;
 $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 $fileNode->stmts = $stmts;
 $fileNode->stmts = array_values($fileNode->stmts);

 return true;
 }

 $this->mirrorUseComments($stmts, $newUses);

 // make use stmts first
 $fileWithoutNamespace->stmts = array_merge($newUses, $this->resolveInsertNop($fileWithoutNamespace), $stmts);
 $fileWithoutNamespace->stmts = array_values($fileWithoutNamespace->stmts);
 $fileNode->stmts = array_merge($newUses, $this->resolveInsertNop($fileNode), $stmts);
 $fileNode->stmts = array_values($fileNode->stmts);

 return true;
 }
Expand DownExpand Up@@ -154,7 +156,7 @@ public function addImportsToNamespace(
 /**
 * @return Nop[]
 */
 private function resolveInsertNop(FileWithoutNamespace|Namespace_ $namespace): array
 private function resolveInsertNop(FileNode|Namespace_ $namespace): array
 {
 $currentStmt = $namespace->stmts[0] ?? null;
 if (! $currentStmt instanceof Stmt || $currentStmt instanceof Use_ || $currentStmt instanceof GroupUse) {
Expand Down

4 changes: 2 additions & 2 deletions
rules/CodingStyle/Application/UseImportsRemover.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@

use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;
use Rector\Renaming\Collector\RenamedNameCollector;

final readonly class UseImportsRemover
Expand All@@ -19,7 +19,7 @@ public function __construct(
 /**
 * @param string[] $removedUses
 */
 public function removeImportsFromStmts(FileWithoutNamespace|Namespace_ $node, array $removedUses): bool
 public function removeImportsFromStmts(FileNode|Namespace_ $node, array $removedUses): bool
 {
 $hasRemoved = false;
 foreach ($node->stmts as $key => $stmt) {
Expand Down

8 changes: 4 additions & 4 deletions
rules/CodingStyle/ClassNameImport/AliasUsesResolver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
use PhpParser\Node\Stmt\Namespace_;
use PhpParser\Node\Stmt\Use_;
use PhpParser\Node\UseItem;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\PhpParser\Node\FileNode;

final readonly class AliasUsesResolver
{
Expand All@@ -25,11 +25,11 @@ public function __construct(
 */
 public function resolveFromNode(Node $node, array $stmts): array
 {
 if (! $node instanceof Namespace_ && ! $node instanceof FileWithoutNamespace) {
 /** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
 if (! $node instanceof Namespace_ && ! $node instanceof FileNode) {
 /** @var Namespace_[]|FileNode[] $namespaces */
 $namespaces = array_filter(
 $stmts,
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileNode
 );
 if (count($namespaces) !== 1) {
 return [];
Expand Down

19 changes: 5 additions & 14 deletions
rules/CodingStyle/ClassNameImport/ShortNameResolver.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,6 @@
use PhpParser\Node\Name;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\ClassLike;
use PhpParser\Node\Stmt\Namespace_;
use PHPStan\PhpDocParser\Ast\PhpDoc\PhpDocTagNode;
use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode;
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfo;
Expand All@@ -20,7 +19,6 @@
use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
use Rector\PhpDocParser\PhpDocParser\PhpDocNodeTraverser;
use Rector\PhpParser\Node\BetterNodeFinder;
use Rector\PhpParser\Node\CustomNode\FileWithoutNamespace;
use Rector\ValueObject\Application\File;

/**
Expand DownExpand Up@@ -65,22 +63,15 @@ public function resolveFromFile(File $file): array
 */
 public function resolveShortClassLikeNames(File $file): array
 {
 $newStmts = $file->getNewStmts();

 /** @var Namespace_[]|FileWithoutNamespace[] $namespaces */
 $namespaces = array_filter(
 $newStmts,
 static fn (Stmt $stmt): bool => $stmt instanceof Namespace_ || $stmt instanceof FileWithoutNamespace
 );
 if (count($namespaces) !== 1) {
 // only handle single namespace nodes
 $rootNode = $file->getUseImportsRootNode();

 // nothing to resolve
 if (! $rootNode instanceof Node) {
 return [];
 }

 $namespace = current($namespaces);

 /** @var ClassLike[] $classLikes */
 $classLikes = $this->betterNodeFinder->findInstanceOf($namespace->stmts, ClassLike::class);
 $classLikes = $this->betterNodeFinder->findInstanceOf($rootNode->stmts, ClassLike::class);

 $shortClassLikeNames = [];
 foreach ($classLikes as $classLike) {
Expand Down
Loading
Loading