Find the best Rule | Rector - Automated Way to Instantly Upgrade and Refactor any PHP code

Configurable

RenameMethodRector

Turns method names to new ones.

 $someObject = new SomeExampleClass;
-$someObject->oldMethod();
+$someObject->newMethod();

SETS: Gmagick to Imagick phpunit/phpunit 4.0 phpunit/phpunit 6.0 phpunit/phpunit 9.0 phpunit/phpunit 10.0 symfony/* 2.7 symfony/* 3.0 symfony/* 3.3 symfony/* 4.1 symfony/* 4.2 symfony/* 4.3 symfony/* 4.4 symfony/* 5.0 symfony/* 5.1 symfony/* 5.2 symfony/* 5.3 symfony/* 5.4 symfony/* 6.0 symfony/* 6.2 symfony/* 7.0 symfony/* 7.1 doctrine/dbal 3.0 doctrine/dbal 4.0 doctrine/dbal 2.11 doctrine/orm 2.13 twig/twig 1.27

Configurable

RenameFunctionRector

Turns defined function call new one.

-view("...", []);
+Laravel\Templating\render("...", []);

SETS: PHP 5.4 PHP 5.6 PHP 7.2 PHP 7.3 PHP 7.4 PHP 8.0 Code Quality symfony/* 4.4 symfony/* 5.1

Configurable

RenameClassConstFetchRector

Replaces defined class constants in their calls.

-$value = SomeClass::OLD_CONSTANT;
-$value = SomeClass::OTHER_OLD_CONSTANT;
+$value = SomeClass::NEW_CONSTANT;
+$value = DifferentClass::NEW_CONSTANT;

SETS: symfony/* 3.0 symfony/* 5.1 symfony/* 5.2 symfony/* 5.3 symfony/* 5.4 symfony/* 6.2 SwiftMailer to Symfony Mailer doctrine/dbal 4.0 doctrine/dbal 2.11

Configurable

RenameStringRector

Change string value

 class SomeClass
 {
     public function run()
     {
-        return 'ROLE_PREVIOUS_ADMIN';
+        return 'IS_IMPERSONATOR';
     }
 }

SETS: symfony/* 5.1

Configurable

RenameClassRector

Replaces defined classes by new ones.

 namespace App;

-use SomeOldClass;
+use SomeNewClass;

-function someFunction(SomeOldClass $someOldClass): SomeOldClass
+function someFunction(SomeNewClass $someOldClass): SomeNewClass
 {
-    if ($someOldClass instanceof SomeOldClass) {
-        return new SomeOldClass;
+    if ($someOldClass instanceof SomeNewClass) {
+        return new SomeNewClass;
     }
 }

SETS: Gmagick to Imagick phpunit/phpunit 6.0 phpunit/phpunit 8.0 symfony/* 2.7 symfony/* 3.0 symfony/* 3.3 symfony/* 4.0 symfony/* 4.1 symfony/* 4.2 symfony/* 4.3 symfony/* 4.4 symfony/* 5.0 symfony/* 5.1 symfony/* 5.3 symfony/* 5.4 symfony/* 6.0 symfony/* 6.1 symfony/* 6.2 symfony/* 6.3 symfony/* 6.4 symfony/* 7.0 SwiftMailer to Symfony Mailer doctrine/common 2.0 doctrine/dbal 3.0 doctrine/dbal 4.0 doctrine/dbal 2.11 doctrine/orm 2.13 twig/twig 1.12 twig/twig 1.40 twig/twig 2.0 twig/twig 2.4

Configurable

AddParamTypeDeclarationRector

Add param types where needed

 class SomeClass
 {
-    public function process($name)
+    public function process(string $name)
     {
     }
 }

SETS: phpunit/phpunit 8.0 symfony/* 5.0 symfony/* 5.1 symfony/* 5.2 symfony/* 5.3 symfony/* 6.0 doctrine/orm 2.5

LogoutHandlerToLogoutEventSubscriberRector

Change logout handler to an event listener that listens to LogoutEvent

-use Symfony\Component\Security\Http\Logout\LogoutHandlerInterface;
-use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Security\Http\Event\LogoutEvent;

-final class SomeLogoutHandler implements LogoutHandlerInterface
+final class SomeLogoutHandler implements EventSubscriberInterface
 {
-    public function logout(Request $request, Response $response, TokenInterface $token)
+    public function onLogout(LogoutEvent $logoutEvent): void
     {
+        $request = $logoutEvent->getRequest();
+        $response = $logoutEvent->getResponse();
+        $token = $logoutEvent->getToken();
+    }
+
+    /**
+     * @return array<string, string[]>
+     */
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            LogoutEvent::class => ['onLogout'],
+        ];
     }
 }

SETS: symfony/* 5.1

LogoutSuccessHandlerToLogoutEventSubscriberRector

Change logout success handler to an event listener that listens to LogoutEvent

-use Symfony\Component\Security\Http\Logout\LogoutSuccessHandlerInterface;
-use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Security\Http\Event\LogoutEvent;

-final class SomeLogoutHandler implements LogoutSuccessHandlerInterface
+final class SomeLogoutHandler implements EventSubscriberInterface
 {
     /**
       * @var HttpUtils
       */
     private $httpUtils;

-    public function __construct(HttpUtils $httpUtils)
+    public function onLogout(LogoutEvent $logoutEvent): void
     {
-        $this->httpUtils = $httpUtils;
+        if ($logoutEvent->getResponse() !== null) {
+            return;
+        }
+
+        $response = $this->httpUtils->createRedirectResponse($logoutEvent->getRequest(), 'some_url');
+        $logoutEvent->setResponse($response);
     }

-    public function onLogoutSuccess(Request $request)
+    /**
+     * @return array<string, mixed>
+     */
+    public static function getSubscribedEvents(): array
     {
-        $response = $this->httpUtils->createRedirectResponse($request, 'some_url');
-        return $response;
+        return [
+            LogoutEvent::class => [['onLogout', 64]],
+        ];
     }
 }

SETS: symfony/* 5.1

RouteCollectionBuilderToRoutingConfiguratorRector

Change RouteCollectionBuilder to RoutingConfiguratorRector

 use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
 use Symfony\Component\HttpKernel\Kernel;
-use Symfony\Component\Routing\RouteCollectionBuilder;
+use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;

 final class ConcreteMicroKernel extends Kernel
 {
     use MicroKernelTrait;

-    protected function configureRoutes(RouteCollectionBuilder $routes)
+    protected function configureRouting(RoutingConfigurator $routes): void
     {
-        $routes->add('/admin', 'App\Controller\AdminController::dashboard', 'admin_dashboard');
-    }
-}
+        $routes->add('admin_dashboard', '/admin')
+            ->controller('App\Controller\AdminController::dashboard')
+    }}

SETS: symfony/* 5.1

CommandConstantReturnCodeRector

Changes int return from execute to use Symfony Command constants.

 class SomeCommand extends Command
 {
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        return 0;
+        return \Symfony\Component\Console\Command\Command::SUCCESS;
     }

 }

SETS: symfony/* 5.1