rector/docs/AllRectorsOverview.md
2018-04-29 11:16:51 +02:00

23 KiB

All Rectors Overview

Rector\Rector\Architecture\RepositoryAsService\ReplaceParentRepositoryCallsByRepositoryPropertyRector

Handles method calls in child of Doctrine EntityRepository and moves them to "$this->repository" property.

{
     public function someMethod()
     {
-        return $this->findAll();
+        return $this->repository->findAll();
     }
 }

Rector\Rector\Architecture\RepositoryAsService\MoveRepositoryFromParentToConstructorRector

Turns parent EntityRepository class to constructor dependency

namespace App\Repository;
 
+use App\Entity\Post;
 use Doctrine\ORM\EntityRepository;
 
-final class PostRepository extends EntityRepository
+final class PostRepository
 {
+    /**
+     * @var \Doctrine\ORM\EntityRepository
+     */
+    private $repository;
+    public function __construct(\Doctrine\ORM\EntityManager $entityManager)
+    {
+        $this->repository = $entityManager->getRepository(\App\Entity\Post::class);
+    }
 }

Rector\Rector\Architecture\RepositoryAsService\ServiceLocatorToDIRector

Turns "$this->getRepository()" in Symfony Controller to constructor injection and private property access.

class ProductController extends Controller
 {
+    /**
+     * @var ProductRepository
+     */
+    private $productRepository;
+
+    public function __construct(ProductRepository $productRepository)
+    {
+        $this->productRepository = $productRepository;
+    }
+
     public function someAction()
     {
         $entityManager = $this->getDoctrine()->getManager();
-        $entityManager->getRepository('SomethingBundle:Product')->findSomething(...);
+        $this->productRepository->findSomething(...);
     }
 }

Rector\Rector\Architecture\PHPUnit\ArrayToYieldDataProviderRector

Turns method data providers in PHPUnit from arrays to yield

/**
-                 * @return mixed[]
                  */
-                public function provide(): array
+                public function provide(): Iterator
                 {
-                    return [
-                        ['item']
-                    ]
+                    yield ['item'];
                 }

Rector\Rector\Dynamic\MethodNameReplacerRector

[Dynamic] Turns method names to new ones.

$someObject = new SomeClass;
-$someObject->oldMethod();
+$someObject->newMethod();
 
-SomeClass::oldStaticMethod();
+SomeClass::newStaticMethod();

Rector\Rector\Dynamic\PropertyToMethodRector

[Dynamic] Replaces properties assign calls be defined methods.

-$result = $object->property;
-$object->property = $value;
+$result = $object->getProperty();
+$object->setProperty($value);

Rector\Rector\Dynamic\ClassReplacerRector

[Dynamic] Replaces defined classes by new ones.

-$value = new SomeOldClass;
+$value = new SomeNewClass;

Rector\Rector\Contrib\CodeQuality\InArrayAndArrayKeysToArrayKeyExistsRector

Simplify in_array and array_keys functions combination into array_key_exists when array_keys has one argument only

-in_array("key", array_keys($array), true);
+array_key_exists("key", $array);

Rector\Rector\Dynamic\ParentTypehintedArgumentRector

[Dynamic] Changes defined parent class typehints.

class SomeClass implements SomeInterface
 {
-    public read($content);
+    public read(string $content);
 }

Rector\Rector\Dynamic\ArgumentRector

[Dynamic] Adds, removes or replaces defined arguments in defined methods and their calls.

$containerBuilder = new Symfony\Component\DependencyInjection\ContainerBuilder;
-$containerBuilder->compile();
+$containerBuilder->compile(true);

Rector\Rector\Dynamic\FunctionToMethodCallRector

[Dynamic] Turns defined function calls to local method calls.

-view("...", []);
+$this->render("...", []);

Rector\Rector\Contrib\Nette\Application\InjectPropertyRector

Turns properties with @inject to private properties and constructor injection

/**
                  * @var SomeService
-                 * @inject 
                  */
-                public $someService;
+                private $someService;
+                
+                public function __construct(SomeService $someService)
+                {
+                    $this->someService = $someService;
+                }

Rector\Rector\Contrib\Nette\Bootstrap\RemoveConfiguratorConstantsRector

Turns properties with @inject to private properties and constructor injection

-$value === Nette\Configurator::DEVELOPMENT
+$value === "development"

Rector\Rector\Contrib\Nette\DI\SetInjectToAddTagRector

Turns setInject() to tag in Nette\DI\CompilerExtension

-$serviceDefinition->setInject();
+$serviceDefinition->addTag("inject");

Rector\Rector\Contrib\Nette\Utils\NetteObjectToSmartTraitRector

Checks all Nette\Object instances and turns parent class to trait

-class SomeClass extends \Nette\Object { } 
+class SomeClass { use Nette\SmartObject; }

Rector\Rector\Contrib\Nette\Utils\MagicMethodRector

Catches @method annotations of Nette\Object instances and converts them to real methods.

-/** @method getId() */
+public function getId() { $this->id; }

Rector\Rector\Contrib\Nette\Application\TemplateMagicInvokeFilterCallRector

Turns properties with @inject to private properties and constructor injection

-$this->template->someFilter(...)
+$this->template->getLatte()->invokeFilter("someFilter", ...)

Rector\Rector\Contrib\Nette\Application\TemplateRegisterHelperRector

Turns properties with @inject to private properties and constructor injection

-$this->template->registerHelper("someFilter", ...);
+$this->template->getLatte()->addFilter("someFilter", ...)

Rector\Rector\Contrib\Nette\DI\SetEntityToStatementRector

Turns setDefinition() to Nette\DI\Helpers::expand() value in Nette\DI\CompilerExtension

-$definition->setEntity("someEntity");
+$definition = new Statement("someEntity", $definition->arguments);

Rector\Rector\Contrib\Nette\DI\ExpandFunctionToParametersArrayRector

Turns expand() to parameters value in Nette\DI\CompilerExtension

-$builder->expand("argument");
+$builder->parameters["argument"];
 
-$builder->expand("%argument%");
+$builder->parameters["argument"];

Rector\Rector\Contrib\Nette\DI\ExpandFunctionToStaticExpandFunctionRector

Turns expand() to Nette\DI\Helpers::expand() value in Nette\DI\CompilerExtension

-$builder->expand(object|array)
+\Nette\DI\Helpers::expand(object|array, $builder->parameters);

Rector\Rector\Contrib\Nette\Forms\ChoiceDefaultValueRector

Turns checkAllowedValues to method in Nette\Forms Control element

-$control->checkAllowedValues = false;
+$control->checkDefaultValue(false);

Rector\Rector\Contrib\Nette\Forms\FormNegativeRulesRector

Turns negative Nette Form rules to their specific new names.

-$form->addRule(~Form::FILLED);
+$form->addRule(Form::NOT_FILLED);

Rector\Rector\Contrib\Nette\Forms\FormCallbackRector

Turns magic callback assign to callback assign on Nette Form events.

-$form->onSuccess[] = $this->someMethod;
+$form->onSuccess[] = [$this, someMethod;]

Rector\Rector\MagicDisclosure\GetAndSetToMethodCallRector

[Dynamic] Turns defined __get/__set to specific method calls.

-$someService = $container->someService;
+$container->getService("someService");
 
-$container->someService = $someService;
+$container->setService("someService", $someService);

Rector\Rector\MagicDisclosure\UnsetAndIssetToMethodCallRector

[Dynamic] Turns defined __isset/__unset calls to specific method calls.

-isset($container["someKey"]);
+$container->hasService("someKey");
 
-unset($container["someKey"])
+$container->removeService("someKey");

Rector\Rector\Contrib\PhpParser\IdentifierRector

Turns node string names to Identifier object in php-parser

-$constNode = new \PhpParser\Node\Const_; $name = $constNode->name;
+$constNode = new \PhpParser\Node\Const_; $name = $constNode->name->toString();

Rector\Rector\Contrib\PhpParser\ParamAndStaticVarNameRector

Turns old string var to var->name sub-variable in Node of PHP-Parser

-$paramNode->name;
+$paramNode->var->name;
 
-$staticVarNode->name;
+$staticVarNode->var->name;

Rector\Rector\Contrib\PhpParser\CatchAndClosureUseNameRector

Turns $catchNode->var to its new new ->name property in php-parser

-$catchNode->var;
+$catchNode->var->name

Rector\Rector\Contrib\PhpParser\SetLineRector

Turns standalone line method to attribute in Node of PHP-Parser

-$node->setLine(5);
+$node->setAttribute("line", 5);

Rector\Rector\Contrib\PhpParser\RemoveNodeRector

Turns integer return to remove node to constant in NodeVisitor of PHP-Parser

-public function leaveNode() { return false; }
+public function leaveNode() { return NodeTraverser::REMOVE_NODE; }

Rector\Rector\Contrib\PhpParser\UseWithAliasRector

Turns use property to method and $node->alias to last name in UseAlias Node of PHP-Parser

-$node->alias;
+$node->getAlias();
 
-$node->name->getLast();
+$node->alias

Rector\Rector\Dynamic\PropertyNameReplacerRector

[Dynamic] Replaces defined old properties by new ones.

-$someObject->someOldProperty;
+$someObject->someNewProperty;

Rector\Rector\Dynamic\ClassConstantReplacerRector

[Dynamic] Replaces defined class constants in their calls.

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

Rector\Rector\Contrib\PHPUnit\SpecificMethod\AssertNotOperatorRector

Turns not-operator comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertTrue(!$foo, "message");
+$this->assertFalse($foo, "message");
 
-$this->assertFalse(!$foo, "message");
+$this->assertTrue($foo, "message");

Rector\Rector\Contrib\PHPUnit\SpecificMethod\AssertComparisonToSpecificMethodRector

Turns comparison operations to their method name alternatives in PHPUnit TestCase

-$this->assertTrue($foo === $bar, "message");
+$this->assertSame($bar, $foo, "message");
 
-$this->assertFalse($foo >= $bar, "message");
+$this->assertLessThanOrEqual($bar, $foo, "message");

Rector\Rector\Contrib\PHPUnit\SpecificMethod\AssertTrueFalseToSpecificMethodRector

Turns true/false comparisons to their method name alternatives in PHPUnit TestCase when possible

-$this->assertTrue(is_readable($readmeFile), "message");
+$this->assertIsReadable($readmeFile, "message");

Rector\Rector\Contrib\PHPUnit\SpecificMethod\AssertSameBoolNullToSpecificMethodRector

Turns same bool and null comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertSame(null, $anything);
+$this->assertNull($anything);
 
-$this->assertNotSame(false, $anything);
+$this->assertNotFalse($anything);

Rector\Rector\Contrib\PHPUnit\SpecificMethod\AssertFalseStrposToContainsRector

Turns strpos()/stripos() comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertFalse(strpos($anything, "foo"), "message");
+$this->assertNotContains("foo", $anything, "message");
 
-$this->assertNotFalse(stripos($anything, "foo"), "message");
+$this->assertContains("foo", $anything, "message");

Rector\Rector\Contrib\PHPUnit\SpecificMethod\AssertTrueFalseInternalTypeToSpecificMethodRector

Turns true/false with internal type comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertTrue(is_{internal_type}($anything), "message");
+$this->assertInternalType({internal_type}, $anything, "message");
 
-$this->assertFalse(is_{internal_type}($anything), "message");
+$this->assertNotInternalType({internal_type}, $anything, "message");

Rector\Rector\Contrib\PHPUnit\SpecificMethod\AssertCompareToSpecificMethodRector

Turns vague php-only method in PHPUnit TestCase to more specific

-$this->assertSame(10, count($anything), "message");
+$this->assertCount(10, $anything, "message");
 
-$this->assertSame($value, {function}($anything), "message");
+$this->assert{function}($value, $anything, "message\");
 
-$this->assertEquals($value, {function}($anything), "message");
+$this->assert{function}($value, $anything, "message\");
 
-$this->assertNotSame($value, {function}($anything), "message");
+$this->assertNot{function}($value, $anything, "message")
 
-$this->assertNotEquals($value, {function}($anything), "message");
+$this->assertNot{function}($value, $anything, "message")

Rector\Rector\Contrib\PHPUnit\SpecificMethod\AssertIssetToSpecificMethodRector

Turns isset comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertTrue(isset($anything->foo));
+$this->assertFalse(isset($anything["foo"]), "message");
 
-$this->assertObjectHasAttribute("foo", $anything);
+$this->assertArrayNotHasKey("foo", $anything, "message");

Rector\Rector\Contrib\PHPUnit\SpecificMethod\AssertInstanceOfComparisonRector

Turns instanceof comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertTrue($foo instanceof Foo, "message");
+$this->assertFalse($foo instanceof Foo, "message");
 
-$this->assertInstanceOf("Foo", $foo, "message");
+$this->assertNotInstanceOf("Foo", $foo, "message");

Rector\Rector\Contrib\PHPUnit\SpecificMethod\AssertPropertyExistsRector

Turns property_exists() comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertTrue(property_exists(new Class, "property"), "message");
+$this->assertClassHasAttribute("property", "Class", "message");
 
-$this->assertFalse(property_exists(new Class, "property"), "message");
+$this->assertClassNotHasAttribute("property", "Class", "message");

Rector\Rector\Contrib\PHPUnit\SpecificMethod\AssertRegExpRector

Turns preg_match() comparisons to their method name alternatives in PHPUnit TestCase

-$this->assertSame(1, preg_match("/^Message for ".*"\.$/", $string), $message);
+$this->assertRegExp("/^Message for ".*"\.$/", $string, $message);
 
-$this->assertEquals(false, preg_match("/^Message for ".*"\.$/", $string), $message);
+$this->assertNotRegExp("/^Message for ".*"\.$/", $string, $message);

Rector\Rector\Contrib\PHPUnit\ExceptionAnnotationRector

Takes setExpectedException() 2nd and next arguments to own methods in PHPUnit.

-$this->setExpectedException(Exception::class, "Message", "CODE");
+                $this->setExpectedException(Exception::class); 
+                $this->expectExceptionMessage("Message");
+                $this->expectExceptionCode("CODE");

Rector\Rector\Contrib\PHPUnit\GetMockRector

Turns getMock*() methods to createMock()

-$this->getMock("Class")
+$this->createMock("Class")
 
-$this->getMockWithoutInvokingTheOriginalConstructor("Class")
+$this->createMock("Class"

Rector\Rector\Dynamic\PseudoNamespaceToNamespaceRector

[Dynamic] Replaces defined Pseudo_Namespaces by Namespace\Ones.

-$someServie = Some_Object;
+$someServie = Some\Object;

Rector\Rector\Contrib\PHPUnit\DelegateExceptionArgumentsRector

Takes setExpectedException() 2nd and next arguments to own methods in PHPUnit.

-$this->setExpectedException(Exception::class, "Message", "CODE");
+                $this->setExpectedException(Exception::class); 
+                $this->expectExceptionMessage("Message");
+                $this->expectExceptionCode("CODE");

Rector\Rector\Dynamic\AnnotationReplacerRector

[Dynamic] Turns defined annotations above properties and methods to their new values.

-/** @test */
+/** @scenario */
                  public function someMethod() {};

Rector\Rector\Dynamic\NamespaceReplacerRector

[Dynamic] Replaces old namespace by new one.

-$someObject = new SomeOldNamespace\SomeClass;
+$someObject = new SomeNewNamespace\SomeClass;

Rector\Rector\Contrib\Sensio\FrameworkExtraBundle\TemplateAnnotationRector

Turns @Template annotation to explicit method call in Controller of FrameworkExtraBundle in Symfony

-/** @Template() */ public function indexAction() { }
+public function indexAction() {
+ return $this->render("index.html.twig"); }

Rector\Rector\Contrib\Sylius\Review\ReplaceCreateMethodWithoutReviewerRector

Turns createForSubjectWithReviewer() with null review to standalone method in Sylius

-$this->createForSubjectWithReviewer($subject, null)
+$this->createForSubject($subject)

Rector\Rector\Dynamic\ReturnTypehintRector

[Dynamic] Changes defined return typehint of method and class.

class SomeClass
 {
-    public getData();
+    public getData(): array;
 }

Rector\Rector\Contrib\Symfony\FrameworkBundle\ContainerGetToConstructorInjectionRector

Turns fetching of dependencies via $container->get() in ContainerAware to constructor injection in Command and Controller in Symfony

-class MyCommand extends ContainerAwareCommand
+class MyCommand extends Command
 {
+    public function __construct(SomeService $someService)
+    {
+        $this->someService = $someService;
+    }
+
     public function someMethod()
     {
         // ...
-        $this->getContainer()->get('some_service');
-        $this->container->get('some_service');
+        $this->someService;
+        $this->someService;
     }
 }

Rector\Rector\Contrib\Symfony\FrameworkBundle\GetParameterToConstructorInjectionRector

Turns fetching of parameters via getParmaeter() in ContainerAware to constructor injection in Command and Controller in Symfony

-class MyCommand extends ContainerAwareCommand
+class MyCommand extends Command
 {
+    private $someParameter;
+
+    public function __construct($someParameter)
+    {
+        $this->someParameter = $someParameter;
+    }
+ 
     public function someMethod()
     {
-        $this->getParameter('someParameter');
+        $this->someParameter;
     }
 }

Rector\Rector\Contrib\Symfony\FrameworkBundle\GetToConstructorInjectionRector

Turns fetching of dependencies via $this->get() to constructor injection in Command and Controller in Symfony

-class MyCommand extends ContainerAwareCommand
+class MyCommand extends Command
 {
+    public function __construct(SomeService $someService)
+    {
+        $this->someService = $someService;
+    }
+
     public function someMethod()
     {
-        // ...
-        $this->get('some_service');
+        $this->someService;
     }
 }

Rector\Rector\Contrib\Symfony\Controller\RedirectToRouteRector

Turns redirect to route to short helper method in Controller in Symfony

-$this->redirect($this->generateUrl("homepage"));
+$this->redirectToRoute("homepage");

Rector\Rector\Contrib\Symfony\Controller\AddFlashRector

Turns long flash adding to short helper method in Controller in Symfony

-$request->getSession()->getFlashBag()->add("success", "something");
+$this->addflash("success", "something");

Rector\Rector\Contrib\Symfony\HttpKernel\GetRequestRector

Turns fetching of dependencies via $this->get() to constructor injection in Command and Controller in Symfony

-class MyCommand extends ContainerAwareCommand
+class MyCommand extends Command
 {
+    public function __construct(SomeService $someService)
+    {
+        $this->someService = $someService;
+    }
+
     public function someMethod()
     {
-        // ...
-        $this->get('some_service');
+        $this->someService;
     }
 }

Rector\Rector\Contrib\Symfony\Form\FormTypeGetParentRector

Turns string Form Type references to their CONSTANT alternatives in getParent() and getExtendedType() methods in Form in Symfony

-function getParent() { return "collection"; }
+function getParent() { return CollectionType::class; }
 
-function getExtendedType() { return "collection"; }
+function getExtendedType() { return CollectionType::class; }

Rector\Rector\Contrib\Symfony\Form\OptionNameRector

Turns old option names to new ones in FormTypes in Form in Symfony

-$builder->add("...", ["precision" => "...", "virtual" => "..."];
+$builder->add("...", ["scale" => "...", "inherit_data" => "..."];

Rector\Rector\Contrib\Symfony\Console\ConsoleExceptionToErrorEventConstantRector

Turns old event name with EXCEPTION to ERROR constant in Console in Symfony

-"console.exception"
+Symfony\Component\Console\ConsoleEvents::ERROR
 
-Symfony\Component\Console\ConsoleEvents::EXCEPTION
+Symfony\Component\Console\ConsoleEvents::ERROR

Rector\Rector\Contrib\Symfony\Validator\ConstraintUrlOptionRector

Turns true value to Url::CHECK_DNS_TYPE_ANY in Validator in Symfony.

-$constraint = new Url(["checkDNS" => true]);
+$constraint = new Url(["checkDNS" => Url::CHECK_DNS_TYPE_ANY]);

Rector\Rector\Contrib\Symfony\Form\FormIsValidRector

Adds $form->isSubmitted() validatoin to all $form->isValid() calls in Form in Symfony

-if ($form->isValid()) { ... };
+if ($form->isSubmitted() && $form->isValid()) { ... };

Rector\Rector\Contrib\Symfony\Form\StringFormTypeToClassRector

Turns string Form Type references to their CONSTANT alternatives in FormTypes in Form in Symfony

-$form->add("name", "form.type.text");
+$form->add("name", \Symfony\Component\Form\Extension\Core\Type\TextType::class);

Rector\Rector\Contrib\Symfony\VarDumper\VarDumperTestTraitMethodArgsRector

Adds new $format argument in VarDumperTestTrait->assertDumpEquals() in in Validator in Symfony.

-VarDumperTestTrait->assertDumpEquals($dump, $data, $mesage = "");
+VarDumperTestTrait->assertDumpEquals($dump, $data, $context = null, $mesage = "");
 
-VarDumperTestTrait->assertDumpMatchesFormat($dump, $format, $mesage = "");
+VarDumperTestTrait->assertDumpMatchesFormat($dump, $format, $context = null,  $mesage = "");

Rector\Rector\Contrib\Symfony\DependencyInjection\ContainerBuilderCompileEnvArgumentRector

Turns old default value to parameter in ContinerBuilder->build() method in DI in Symfony

-$containerBuilder = new Symfony\Component\DependencyInjection\ContainerBuilder(); $containerBuilder->compile();
+$containerBuilder = new Symfony\Component\DependencyInjection\ContainerBuilder(); $containerBuilder->compile(true);

Rector\Rector\Contrib\Symfony\Process\ProcessBuilderInstanceRector

Turns ProcessBuilder::instance() to new ProcessBuilder in Process in Symfony. Part of multi-step Rector.

-$processBuilder = Symfony\Component\Process\ProcessBuilder::instance($args);
+$processBuilder = new Symfony\Component\Process\ProcessBuilder($args);

Rector\Rector\Contrib\Symfony\Process\ProcessBuilderGetProcessRector

Removes $processBuilder->getProcess() calls to $processBuilder in Process in Symfony, because ProcessBuilder was removed. This is part of multi-step Rector and has very narrow focus.

-                $processBuilder = new Symfony\Component\Process\ProcessBuilder;
-                $process = $processBuilder->getProcess();
-                $commamdLine = $processBuilder->getProcess()->getCommandLine();
+$processBuilder = new Symfony\Component\Process\ProcessBuilder;
+$process = $processBuilder;
+$commamdLine = $processBuilder->getCommandLine();