rector / rector-symfony
Rector upgrades rules for Symfony Framework
Installs: 1 531 460
Dependents: 1
Suggesters: 0
Security: 0
Stars: 187
Watchers: 10
Forks: 90
Open Issues: 5
Type:rector-extension
Requires
- php: >=8.2
- ext-xml: *
Requires (Dev)
- phpstan/extension-installer: ^1.4
- phpstan/phpstan: ^1.11
- phpstan/phpstan-webmozart-assert: ^1.2
- phpunit/phpunit: ^10.5
- rector/rector-src: dev-main
- rector/type-perfect: ^0.1.6
- symfony/config: ^6.4
- symfony/dependency-injection: ^6.4
- symfony/http-kernel: ~6.3
- symfony/routing: ^6.4
- symfony/security-core: ^6.4
- symfony/security-http: ^6.4
- symfony/validator: ^6.4
- symplify/easy-coding-standard: ^12.3
- symplify/phpstan-extensions: ^11.1
- symplify/phpstan-rules: ^13.0
- symplify/rule-doc-generator: ^12.2.2
- symplify/vendor-patches: ^11.2
- tomasvotruba/class-leak: ^0.2
- tracy/tracy: ^2.10
- dev-main
- 1.1.0
- 1.0.0
- 0.19.0
- 0.16.2
- 0.16.1
- 0.16.0
- 0.15.0
- 0.14.3
- 0.14.2
- 0.14.1
- 0.14.0
- 0.13.1
- 0.13.0
- 0.12.1
- 0.12.0
- 0.11.50
- 0.11.49
- 0.11.48
- 0.11.47
- 0.11.46
- 0.11.45
- 0.11.44
- 0.11.43
- 0.11.42
- 0.11.41
- 0.11.40
- 0.11.39
- 0.11.38
- 0.11.37
- 0.11.36
- 0.11.35
- 0.11.34
- 0.11.33
- 0.11.31
- 0.11.30
- 0.11.29
- 0.11.28
- 0.11.27
- 0.11.26
- 0.11.24
- 0.11.23
- 0.11.22
- 0.11.21
- 0.11.20
- 0.11.19
- 0.11.18
- 0.11.17
- 0.11.16
- 0.11.15
- 0.11.14
- 0.11.13
- 0.11.12
- 0.11.10
- 0.11.9
- 0.11.8
- 0.11.7
- 0.11.6
- 0.11.5
- 0.11.4
- 0.11.3
- 0.11.2
- 0.11.1
- 0.11.0
- 0.10.6
- 0.10.5
- 0.10.4
- 0.10.3
- 0.10.2
- 0.10.1
- 0.10.0
- dev-tv-listner-method
- dev-tv-command-attribute
- dev-tv-depre-command-lazy
- dev-tv-symfony-7
- dev-tv-laravel-di
This package is auto-updated.
Last update: 2024-12-08 17:51:43 UTC
README
See available Symfony rules
Install
This package is already part of rector/rector package, so it works out of the box.
All you need to do is install the main package, and you're good to go:
composer require rector/rector --dev
Use Sets
To add a set to your config, use Rector\Symfony\Set\SymfonySetList
class and pick one of constants:
use Rector\Config\RectorConfig; use Rector\Symfony\Set\SymfonySetList; return RectorConfig::configure() ->withSymfonyContainerXml(__DIR__ . '/var/cache/dev/App_KernelDevDebugContainer.xml') ->withSets([ SymfonySetList::SYMFONY_62, SymfonySetList::SYMFONY_CODE_QUALITY, SymfonySetList::SYMFONY_CONSTRUCTOR_INJECTION, ]);
Configuration
Provide Symfony XML Service List
Some rules like StringFormTypeToClassRector
need access to your Symfony container dumped XML. It contains list of form types with their string names, so it can convert them to class references.
How to add it? Check your var/cache/
directory and find the XML file for your test env. Then add it in rector.php
:
use Rector\Config\RectorConfig; return RectorConfig::configure() ->withSymfonyContainerXml(__DIR__ . '/var/cache/dev/App_KernelDevDebugContainer.xml');
That's it! Now you can run the StringFormTypeToClassRector
and get your form classes converted safely.
Provide Symfony PHP Container
Some rules like AddRouteAnnotationRector
require additional access to your Symfony container. The rule takes container service "router" to load metadata about your routes.
use Rector\Config\RectorConfig; use Rector\Symfony\Bridge\Symfony\Routing\SymfonyRoutesProvider; use Rector\Symfony\Configs\Rector\ClassMethod\AddRouteAnnotationRector; use Rector\Symfony\Contract\Bridge\Symfony\Routing\SymfonyRoutesProviderInterface; return RectorConfig::configure() ->withSymfonyContainerPhp(__DIR__ . '/tests/symfony-container.php') ->registerService(SymfonyRoutesProvider::class, SymfonyRoutesProviderInterface::class);
The tests/symfony-container.php
should provide your dependency injection container. The way you create the container is up to you. It can be as simple as:
// tests/symfony-container.php use App\Kernel; require __DIR__ . '/bootstrap.php'; $appKernel = new Kernel('test', false); $appKernel->boot(); return $appKernel->getContainer();
The version of your Symfony can be quite old. Public methods are stable from Symfony 2 to through 6 and the router have not changed much. The AddRouteAnnotationRector
rule was tested and developed on Symfony 2.8 project.
Note
In this case, container cache PHP file located in /var/cache/<env>/appProjectContainer.php
is not enough. Why? Few services require Kernel to be set, e.g. routes that are resolved in lazy way. This container file is only dumped without Kernel and would crash with missing "kernel" error. That's why the rule needs full blown container.
Learn Rector Faster
Rector is a tool that we develop and share for free, so anyone can save hundreds of hours on refactoring. But not everyone has time to understand Rector and AST complexity. You have 2 ways to speed this process up:
- read a book - The Power of Automated Refactoring
- hire our experienced team to improve your code base
Both ways support us to and improve Rector in sustainable way by learning from practical projects.